keel.Algorithms.Semi_Supervised_Learning.utilities

Class Parameters

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<java.lang.String>

keel.Algorithms.Semi_Supervised_Learning.utilities.Parameters

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.String>, java.util.Collection<java.lang.String>, java.util.List<java.lang.String>, java.util.RandomAccess

public class Parameters
extends java.util.ArrayList<java.lang.String>

Implements operations of getting and setting the algorithm parameters.

Author:

diegoj

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	indexExtendedArg Index of the extended argument.
protected static java.lang.String	name Contains the name of the parameters file.
protected java.util.ArrayList<java.lang.String>	names Names of the parameteres.
static java.lang.String	PERC_SIZE_TXT Configuration text (reduction size).
static java.lang.String	SEED_TXT Configuration text (seed).
protected static java.lang.String	use Contains the message of correct use to the user of the program.

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
Parameters(java.util.ArrayList<java.lang.String> args) Constructs the Parameters class (the String's array) with the array given.
Parameters(int _size) Constructs the Parameters class (the String's array) with the size given.
Parameters(java.lang.String[] args) Constructs the Parameters class (the String's array) with the array given.
Parameters(java.lang.String[] names, java.lang.String[] args) Constructs the Parameters class (the String's array) with the parameters array given and their names.

Method Summary

Modifier and Type	Method and Description
static void	assertBasicArgs(java.lang.String[] args) Assert the program arguments
static java.lang.String	assertExtendedArg(java.lang.String[] args, int pos, java.lang.String name, double llim, double rlim) Assert the program arguments which depends on the specific algorithm.
static java.lang.String	assertExtendedArg(java.lang.String[] args, java.lang.String name, double llim, double rlim) Assert the program arguments which depends on the specific algorithm.
static double	assertExtendedArgAsDouble(java.lang.String[] args, int pos, java.lang.String name, double llim, double rlim) Assert a double arguments which depends on the specific algorithm.
static double	assertExtendedArgAsDouble(java.lang.String[] args, java.lang.String name, double llim, double rlim) Assert a double arguments which depends on the specific algorithm.
static int	assertExtendedArgAsInt(java.lang.String[] args, int pos, java.lang.String name, double llim, double rlim) Assert an integer argument which depends on the specific algorithm.
static int	assertExtendedArgAsInt(java.lang.String[] args, java.lang.String name, double llim, double rlim) Assert an integer argument which depends on the specific algorithm.
static java.lang.String	assertExtendedArgAsString(java.lang.String[] args, int pos, java.lang.String name, java.util.ArrayList<java.lang.String> values) Assert the program arguments which depends on the specific algorithm.
static java.lang.String	assertExtendedArgAsString(java.lang.String[] args, int pos, java.lang.String name, java.lang.String[] values) Assert the program arguments which depends on the specific algorithm.
boolean	existMore() Informs if there are more arguments.
double	getDouble(int index) Parses as Double the parameter with the given index
static java.lang.String	getFileName() Return the name of parameters file.
int	getInt(int index) Parses as Integer the parameter with the given index
java.lang.String	getName(int index) Returns and specified name of a parameter.
double	getNextAsDouble() Return next parameter as double.
int	getNextAsInt() Return next parameter as int.
java.lang.String	getNextAsString() Return next parameter as string.
java.lang.String[]	getNextAsStringArray() Return next parameter as string.
java.lang.String[]	getRemainingParameters() Returns the parameters that have not been parsed yet.
static void	setUse(java.lang.String algorithmName, java.lang.String advParams) Sets the use of the algorithm

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Field Detail

SEED_TXT

public static final java.lang.String SEED_TXT

Configuration text (seed).

See Also:

Constant Field Values

PERC_SIZE_TXT

public static final java.lang.String PERC_SIZE_TXT

Configuration text (reduction size).

See Also:

Constant Field Values

names

protected java.util.ArrayList<java.lang.String> names

Names of the parameteres.

use

protected static java.lang.String use

Contains the message of correct use to the user of the program.

name

protected static java.lang.String name

Contains the name of the parameters file.

indexExtendedArg

protected static int indexExtendedArg

Index of the extended argument.

Constructor Detail

Parameters

public Parameters(int _size)

Constructs the Parameters class (the String's array) with the size given.

Parameters:

_size - size given.

Parameters

public Parameters(java.lang.String[] args)

Constructs the Parameters class (the String's array) with the array given.

Parameters:

args - array given.

Parameters

public Parameters(java.util.ArrayList<java.lang.String> args)

Constructs the Parameters class (the String's array) with the array given.

Parameters:

args - array given.

Parameters

public Parameters(java.lang.String[] names,
                  java.lang.String[] args)

Constructs the Parameters class (the String's array) with the parameters array given and their names.

Parameters:

names - given parameters names.

args - given parameters array.

Method Detail

getFileName

public static java.lang.String getFileName()

Return the name of parameters file.

Returns:

the name of parameters file.

getName

public java.lang.String getName(int index)

Returns and specified name of a parameter.

Parameters:

index - Parameter in indexth position.

Returns:

Name of indexth-parameter.

getInt

public int getInt(int index)

Parses as Integer the parameter with the given index

Parameters:

index - given index of the parameter to be parsed

Returns:

integer parsed.

getDouble

public double getDouble(int index)

Parses as Double the parameter with the given index

Parameters:

index - given index of the parameter to be parsed

Returns:

Double parsed.

getNextAsInt

public int getNextAsInt()

Return next parameter as int.

Returns:

Next parameter as an integer.

getNextAsDouble

public double getNextAsDouble()

Return next parameter as double.

Returns:

Next parameter as a double.

getNextAsString

public java.lang.String getNextAsString()

Return next parameter as string.

Returns:

Next parameter as a string.

getNextAsStringArray

public java.lang.String[] getNextAsStringArray()

Return next parameter as string.

Returns:

Next parameter as a string.

getRemainingParameters

public java.lang.String[] getRemainingParameters()

Returns the parameters that have not been parsed yet.

Returns:

the parameters that have not been parsed yet.

existMore

public boolean existMore()

Informs if there are more arguments.

Returns:

TRUE if there are more argumentos, FALSE in other chase.

setUse

public static void setUse(java.lang.String algorithmName,
                          java.lang.String advParams)

Sets the use of the algorithm

Parameters:

algorithmName - Human readable name of the implmented algorithm

advParams - List of parameters of the program

assertBasicArgs

public static void assertBasicArgs(java.lang.String[] args)

Assert the program arguments

Parameters:

args - Arguments of the program

assertExtendedArg

public static java.lang.String assertExtendedArg(java.lang.String[] args,
                                                 int pos,
                                                 java.lang.String name,
                                                 double llim,
                                                 double rlim)

Assert the program arguments which depends on the specific algorithm.

Parameters:

args - Arguments of the program.

pos - Position in the array of strings.

name - Name of the argument.

llim - Left value of the interval in which the argument is (only used if the argument is numeric)

rlim - Right value of the interval in which the argument is (only used if the argument is numeric)

Returns:

String with the argument.

assertExtendedArgAsString

public static java.lang.String assertExtendedArgAsString(java.lang.String[] args,
                                                         int pos,
                                                         java.lang.String name,
                                                         java.util.ArrayList<java.lang.String> values)

Assert the program arguments which depends on the specific algorithm.

Parameters:

args - Arguments of the program.

pos - Position in the array of strings.

name - Name of the argument.

values - Posibly values of the parameter.

Returns:

String with the argument.

assertExtendedArgAsString

public static java.lang.String assertExtendedArgAsString(java.lang.String[] args,
                                                         int pos,
                                                         java.lang.String name,
                                                         java.lang.String[] values)

Assert the program arguments which depends on the specific algorithm.

Parameters:

args - Arguments of the program.

pos - Position in the array of strings.

name - Name of the argument.

values - Posibly values of the parameter.

Returns:

String with the argument.

assertExtendedArgAsDouble

public static double assertExtendedArgAsDouble(java.lang.String[] args,
                                               int pos,
                                               java.lang.String name,
                                               double llim,
                                               double rlim)

Assert a double arguments which depends on the specific algorithm.

Parameters:

args - Arguments of the program.

pos - Position in the array of strings.

name - Name of the argument.

llim - Left value of the interval in which the argument is.

rlim - Right value of the interval in which the argument is.

Returns:

Argument as double.

assertExtendedArgAsInt

public static int assertExtendedArgAsInt(java.lang.String[] args,
                                         int pos,
                                         java.lang.String name,
                                         double llim,
                                         double rlim)

Assert an integer argument which depends on the specific algorithm.

Parameters:

args - Arguments of the program.

pos - Position in the array of strings.

name - Name of the argument.

llim - Left value of the interval in which the argument is.

rlim - Right value of the interval in which the argument is.

Returns:

Argument as int.

assertExtendedArg

public static java.lang.String assertExtendedArg(java.lang.String[] args,
                                                 java.lang.String name,
                                                 double llim,
                                                 double rlim)

Assert the program arguments which depends on the specific algorithm.

Parameters:

args - Arguments of the program.

name - Name of the argument.

llim - Left value of the interval in which the argument is (only used if the argument is numeric)

rlim - Right value of the interval in which the argument is (only used if the argument is numeric)

Returns:

String with the argument.

assertExtendedArgAsDouble

public static double assertExtendedArgAsDouble(java.lang.String[] args,
                                               java.lang.String name,
                                               double llim,
                                               double rlim)

Assert a double arguments which depends on the specific algorithm.

Parameters:

args - Arguments of the program.

name - Name of the argument.

llim - Left value of the interval in which the argument is.

rlim - Right value of the interval in which the argument is.

Returns:

Argument as double.

assertExtendedArgAsInt

public static int assertExtendedArgAsInt(java.lang.String[] args,
                                         java.lang.String name,
                                         double llim,
                                         double rlim)

Assert an integer argument which depends on the specific algorithm.

Parameters:

args - Arguments of the program.

name - Name of the argument.

llim - Left value of the interval in which the argument is.

rlim - Right value of the interval in which the argument is.

Returns:

Argument as int.