Parameters controlling execution of TestOperator. More...

Inheritance diagram for denoptim.programs.genetweeker.GeneOpsRunnerParameters:

Collaboration diagram for denoptim.programs.genetweeker.GeneOpsRunnerParameters:

Classes
enum	Operator
	Testable Operators. More...

Public Member Functions
	GeneOpsRunnerParameters ()
	Constructor. More...

void	interpretKeyword (String key, String value) throws DENOPTIMException
	Processes a keyword/value pair and assign the related parameters. More...

void	checkParameters () throws DENOPTIMException
	Evaluate consistency of input parameters. More...

void	processParameters () throws DENOPTIMException
	Processes all parameters and initialize related objects. More...

String	getPrintedList ()
	Returns the list of parameters in a string with newline characters as delimiters. More...

Public Member Functions inherited from denoptim.programs.RunTimeParameters
	RunTimeParameters (ParametersType paramType)
	Constructor. More...

String	paramTypeName ()
	Returns a string defining the type the parameters collected here. More...

String	getWorkDirectory ()
	Gets the pathname to the working directory. More...

void	setWorkDirectory (String pathname)
	Gets the pathname to the working directory. More...

String	getLogFilePathname ()
	Gets the pathname to the log file. More...

void	setLogFilePathname (String pathname)
	Sets the pathname to the log file. More...

Logger	getLogger ()
	Get the name of the program specific logger. More...

Logger	startProgramSpecificLogger (String loggerIdentifier) throws SecurityException, IOException
	Starts a logger with the given name. More...

Logger	startProgramSpecificLogger (String loggerIdentifier, boolean toLogFile) throws SecurityException, IOException
	Starts a logger with the given name. More...

Logger	startConsoleLogger (String loggerIdentifier)
	Starts a program-specific logger that prints to System.err stream. More...

int	getVerbosity ()
	Returns the level of verbosity, i.e., the amount of log that we want to print. More...

void	setVerbosity (int l)
	Set the level of verbosity. More...

Randomizer	getRandomizer ()
	Returns the current program-specific randomizer. More...

long	getRandomSeed ()
	Returns the seed. More...

void	setRandomizer (Randomizer rng)
	Sets the randomizer. More...

Randomizer	startRandomizer ()
	Starts a program specific randomizer, i.e., a tool for generating random numbers and taking random decisions. More...

Randomizer	startRandomizer (long seed)
	Starts a program specific randomizer, i.e., a tool for generating random numbers and taking random decisions. More...

void	readParameterFile (String infile) throws DENOPTIMException
	Read the parameter TXT file line by line and interpret its content. More...

void	readParameterLine (String line) throws DENOPTIMException

boolean	containsParameters (ParametersType type)

RunTimeParameters	getParameters (ParametersType type)

void	setParameters (RunTimeParameters otherParams)

void	interpretKeyword (String line) throws DENOPTIMException
	Processes a string looking for keyword and a possibly associated value. More...

abstract void	interpretKeyword (String key, String value) throws DENOPTIMException
	Processes a keyword/value pair and assign the related parameters. More...

abstract void	checkParameters () throws DENOPTIMException
	Evaluate consistency of input parameters. More...

abstract void	processParameters () throws DENOPTIMException
	Processes all parameters and initialize related objects. More...

abstract String	getPrintedList ()
	Returns the list of parameters in a string with newline characters as delimiters. More...

void	printParameters ()
	Print all parameters. More...

Protected Attributes
Operator	operatorToTest = Operator.XOVER
	Chosen operator. More...

int[]	mutationTarget
	Target vertex ID for mutation. More...

int	idTargetAP = -1
	Target attachment point ID for mutation (AP belonging already to the graph). More...

MutationType	mutationType
	Type of mutation to perform. More...

int	idNewVrt = -1
	The given vertex index. More...

int	idNewAP = -1
	The given attachment point index. More...

String	inpFileM
	Input File male. More...

String	inpFileF
	Input File female. More...

CrossoverType	xoverType = CrossoverType.BRANCH
	Type of crossover to perform. More...

int	maxSwappableChainLength = Integer.MAX_VALUE
	Maximum length of the subgraph that is swapped in a crossover operation. More...

int[]	xoverSrcMale
	Male VertedID (not index) on which perform xover. More...

List< int[]>	xoverSubGraphEndMale = new ArrayList<int[]>()
	Male VertedID (not index) that represent the end of the subgraph that is swapped by crossover. More...

int	mapid
	Male AP index on which perform xover. More...

int[]	xoverSrcFemale
	Female VertexID (not index) on which perform xover. More...

List< int[]>	xoverSubGraphEndFemale = new ArrayList<int[]>()
	Female VertedID (not index) that represent the end of the subgraph that is swapped by crossover. More...

int	fapid
	Female AP index on which perform xover. More...

String	outFileM
	Output file male. More...

String	outFileF
	Output file female. More...

Protected Attributes inherited from denoptim.programs.RunTimeParameters
boolean	isMaster = true
	Flag signaling this is the master collection of parameters. More...

String	workDir = System.getProperty("user.dir")
	Working directory. More...

String	logFile = "unset"
	Log file. More...

int	verbosity = 0
	Verbosity level for logger. More...

Map< ParametersType, RunTimeParameters >	otherParameters
	Collection of other parameters by type. More...

Additional Inherited Members
Static Public Member Functions inherited from denoptim.programs.RunTimeParameters
static boolean	readYesNoTrueFalse (String s)
	Reads a string searching for any common way to say either yes/true (including shorthand t/y) or no/false (including shorthand f/n either). More...

Public Attributes inherited from denoptim.programs.RunTimeParameters
final String	NL = System.getProperty("line.separator")
	New line character. More...

Protected Member Functions inherited from denoptim.programs.RunTimeParameters
void	checkOtherParameters () throws DENOPTIMException
	Checks any of the parameter collections contained in this instance. More...

void	processOtherParameters () throws DENOPTIMException
	Processes any of the parameter collections contained in this instance. More...

void	ensureFileExistsIfSet (String pathname)
	Ensures a pathname is not empty nor null and that it does lead to an existing file or triggers an error. More...

void	ensureFileExists (String pathname)
	Ensures a pathname does lead to an existing file or triggers an error. More...

void	ensureNotNull (String paramName, String param, String paramKey)
	Ensures that a parameter is not null or triggers an error. More...

void	ensureIsPositive (String paramName, int value, String paramKey)
	Ensures that a parameter is a positive number (x>=0) or triggers an error. More...

void	ensureIsPositiveOrZero (String paramName, int value, String paramKey)
	Ensures that a parameter is a positive number (x>=0) or triggers an error. More...

void	ensureInRange (String paramName, int value, int min, int max, String paramKey)
	Ensures that a parameter is within a range or triggers an error. More...

Detailed Description

Parameters controlling execution of TestOperator.

Author: Marco Foscato

Definition at line 39 of file GeneOpsRunnerParameters.java.

Constructor & Destructor Documentation

◆ GeneOpsRunnerParameters()

denoptim.programs.genetweeker.GeneOpsRunnerParameters.GeneOpsRunnerParameters ( )

Constructor.

Definition at line 153 of file GeneOpsRunnerParameters.java.

References denoptim.programs.RunTimeParameters.ParametersType.GO_PARAMS.

Member Function Documentation

◆ checkParameters()

void denoptim.programs.genetweeker.GeneOpsRunnerParameters.checkParameters ( ) throws DENOPTIMException

Evaluate consistency of input parameters.

Exceptions

DENOPTIMException

Reimplemented from denoptim.programs.RunTimeParameters.

Definition at line 287 of file GeneOpsRunnerParameters.java.

References denoptim.files.FileUtils.checkExists(), denoptim.programs.RunTimeParameters.checkOtherParameters(), denoptim.programs.genetweeker.GeneOpsRunnerParameters.inpFileF, denoptim.programs.genetweeker.GeneOpsRunnerParameters.inpFileM, denoptim.programs.genetweeker.GeneOpsRunnerParameters.operatorToTest, denoptim.programs.RunTimeParameters.workDir, and denoptim.programs.genetweeker.GeneOpsRunnerParameters.Operator.XOVER.

Referenced by denoptim.programs.genetweeker.GeneOpsRunner.runProgram().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPrintedList()

String denoptim.programs.genetweeker.GeneOpsRunnerParameters.getPrintedList ( )

Returns the list of parameters in a string with newline characters as delimiters.

Returns: the list of parameters in a string with newline characters as delimiters.

Reimplemented from denoptim.programs.RunTimeParameters.

Definition at line 338 of file GeneOpsRunnerParameters.java.

References denoptim.programs.RunTimeParameters.NL, denoptim.programs.RunTimeParameters.otherParameters, and denoptim.programs.RunTimeParameters.paramTypeName().

Here is the call graph for this function:

◆ interpretKeyword()

void denoptim.programs.genetweeker.GeneOpsRunnerParameters.interpretKeyword	(	String	key,
		String	value
	)		throws DENOPTIMException

Processes a keyword/value pair and assign the related parameters.

Parameters

key	the keyword as string
value	the value as a string

Exceptions

DENOPTIMException

Reimplemented from denoptim.programs.RunTimeParameters.

Definition at line 167 of file GeneOpsRunnerParameters.java.

◆ processParameters()

void denoptim.programs.genetweeker.GeneOpsRunnerParameters.processParameters ( ) throws DENOPTIMException

Processes all parameters and initialize related objects.

Exceptions

DENOPTIMException

Reimplemented from denoptim.programs.RunTimeParameters.

Definition at line 320 of file GeneOpsRunnerParameters.java.

References denoptim.programs.RunTimeParameters.containsParameters(), denoptim.programs.RunTimeParameters.ParametersType.GA_PARAMS, denoptim.programs.RunTimeParameters.processOtherParameters(), and denoptim.programs.RunTimeParameters.setParameters().

Referenced by denoptim.programs.genetweeker.GeneOpsRunner.runProgram().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ fapid

int denoptim.programs.genetweeker.GeneOpsRunnerParameters.fapid

protected

Female AP index on which perform xover.

Definition at line 136 of file GeneOpsRunnerParameters.java.

Referenced by denoptim.programs.genetweeker.GeneOpsRunnerParameters.interpretKeyword().

◆ idNewAP

int denoptim.programs.genetweeker.GeneOpsRunnerParameters.idNewAP = -1

protected

The given attachment point index.

Used whenever an AP id has to be given. For example, when specifying how to mutate a graph. Zero-based index.

Definition at line 80 of file GeneOpsRunnerParameters.java.

Referenced by denoptim.programs.genetweeker.GeneOpsRunnerParameters.interpretKeyword(), and denoptim.programs.genetweeker.GeneOpsRunner.runMutation().

◆ idNewVrt

int denoptim.programs.genetweeker.GeneOpsRunnerParameters.idNewVrt = -1

protected

The given vertex index.

Zero-based index. Used whenever a vertex id has to be given. For example, when specifying how to mutate a graph.

Definition at line 73 of file GeneOpsRunnerParameters.java.

Referenced by denoptim.programs.genetweeker.GeneOpsRunnerParameters.interpretKeyword(), and denoptim.programs.genetweeker.GeneOpsRunner.runMutation().

◆ idTargetAP

int denoptim.programs.genetweeker.GeneOpsRunnerParameters.idTargetAP = -1

protected

Target attachment point ID for mutation (AP belonging already to the graph).

Zero-based index.

Definition at line 61 of file GeneOpsRunnerParameters.java.

Referenced by denoptim.programs.genetweeker.GeneOpsRunnerParameters.interpretKeyword(), and denoptim.programs.genetweeker.GeneOpsRunner.runMutation().

◆ inpFileF

String denoptim.programs.genetweeker.GeneOpsRunnerParameters.inpFileF

protected

Input File female.

Definition at line 90 of file GeneOpsRunnerParameters.java.

Referenced by denoptim.programs.genetweeker.GeneOpsRunnerParameters.checkParameters(), denoptim.programs.genetweeker.GeneOpsRunnerParameters.interpretKeyword(), and denoptim.programs.genetweeker.GeneOpsRunner.runXOver().

◆ inpFileM

String denoptim.programs.genetweeker.GeneOpsRunnerParameters.inpFileM

protected

Input File male.

Definition at line 85 of file GeneOpsRunnerParameters.java.

Referenced by denoptim.programs.genetweeker.GeneOpsRunnerParameters.checkParameters(), denoptim.programs.genetweeker.GeneOpsRunnerParameters.interpretKeyword(), denoptim.programs.genetweeker.GeneOpsRunner.runMutation(), and denoptim.programs.genetweeker.GeneOpsRunner.runXOver().

◆ mapid

int denoptim.programs.genetweeker.GeneOpsRunnerParameters.mapid

protected

Male AP index on which perform xover.

Definition at line 118 of file GeneOpsRunnerParameters.java.

Referenced by denoptim.programs.genetweeker.GeneOpsRunnerParameters.interpretKeyword().

◆ maxSwappableChainLength

int denoptim.programs.genetweeker.GeneOpsRunnerParameters.maxSwappableChainLength = Integer.MAX_VALUE

protected

Maximum length of the subgraph that is swapped in a crossover operation.

Definition at line 100 of file GeneOpsRunnerParameters.java.

◆ mutationTarget

int [] denoptim.programs.genetweeker.GeneOpsRunnerParameters.mutationTarget

protected

Target vertex ID for mutation.

Multiple values indicate embedding into nested graphs.

Definition at line 55 of file GeneOpsRunnerParameters.java.

Referenced by denoptim.programs.genetweeker.GeneOpsRunnerParameters.interpretKeyword(), and denoptim.programs.genetweeker.GeneOpsRunner.runMutation().

◆ mutationType

MutationType denoptim.programs.genetweeker.GeneOpsRunnerParameters.mutationType

protected

Type of mutation to perform.

Definition at line 66 of file GeneOpsRunnerParameters.java.

Referenced by denoptim.programs.genetweeker.GeneOpsRunnerParameters.interpretKeyword(), and denoptim.programs.genetweeker.GeneOpsRunner.runMutation().

◆ operatorToTest

Operator denoptim.programs.genetweeker.GeneOpsRunnerParameters.operatorToTest = Operator.XOVER

protected

Chosen operator.

Definition at line 49 of file GeneOpsRunnerParameters.java.

Referenced by denoptim.programs.genetweeker.GeneOpsRunnerParameters.checkParameters(), denoptim.programs.genetweeker.GeneOpsRunnerParameters.interpretKeyword(), and denoptim.programs.genetweeker.GeneOpsRunner.runProgram().

◆ outFileF

String denoptim.programs.genetweeker.GeneOpsRunnerParameters.outFileF

protected

Output file female.

Definition at line 146 of file GeneOpsRunnerParameters.java.

Referenced by denoptim.programs.genetweeker.GeneOpsRunnerParameters.interpretKeyword(), and denoptim.programs.genetweeker.GeneOpsRunner.runXOver().

◆ outFileM

String denoptim.programs.genetweeker.GeneOpsRunnerParameters.outFileM

protected

Output file male.

Definition at line 141 of file GeneOpsRunnerParameters.java.

Referenced by denoptim.programs.genetweeker.GeneOpsRunnerParameters.interpretKeyword(), denoptim.programs.genetweeker.GeneOpsRunner.runMutation(), and denoptim.programs.genetweeker.GeneOpsRunner.runXOver().

◆ xoverSrcFemale

int [] denoptim.programs.genetweeker.GeneOpsRunnerParameters.xoverSrcFemale

protected

Female VertexID (not index) on which perform xover.

Multiple values indicate embedding into nested graphs.

Definition at line 124 of file GeneOpsRunnerParameters.java.

Referenced by denoptim.programs.genetweeker.GeneOpsRunnerParameters.interpretKeyword(), and denoptim.programs.genetweeker.GeneOpsRunner.runXOver().

◆ xoverSrcMale

int [] denoptim.programs.genetweeker.GeneOpsRunnerParameters.xoverSrcMale

protected

Male VertedID (not index) on which perform xover.

Multiple values indicate embedding into nested graphs.

Definition at line 106 of file GeneOpsRunnerParameters.java.

Referenced by denoptim.programs.genetweeker.GeneOpsRunnerParameters.interpretKeyword(), and denoptim.programs.genetweeker.GeneOpsRunner.runXOver().

◆ xoverSubGraphEndFemale

List<int[]> denoptim.programs.genetweeker.GeneOpsRunnerParameters.xoverSubGraphEndFemale = new ArrayList<int[]>()

protected

Female VertedID (not index) that represent the end of the subgraph that is swapped by crossover.

Multiple values indicate embedding into nested graphs.

Definition at line 131 of file GeneOpsRunnerParameters.java.

Referenced by denoptim.programs.genetweeker.GeneOpsRunnerParameters.interpretKeyword(), and denoptim.programs.genetweeker.GeneOpsRunner.runXOver().

◆ xoverSubGraphEndMale

List<int[]> denoptim.programs.genetweeker.GeneOpsRunnerParameters.xoverSubGraphEndMale = new ArrayList<int[]>()

protected

Male VertedID (not index) that represent the end of the subgraph that is swapped by crossover.

Multiple values indicate embedding into nested graphs.

Definition at line 113 of file GeneOpsRunnerParameters.java.

Referenced by denoptim.programs.genetweeker.GeneOpsRunnerParameters.interpretKeyword(), and denoptim.programs.genetweeker.GeneOpsRunner.runXOver().

◆ xoverType

CrossoverType denoptim.programs.genetweeker.GeneOpsRunnerParameters.xoverType = CrossoverType.BRANCH

protected

Type of crossover to perform.

Definition at line 95 of file GeneOpsRunnerParameters.java.

Referenced by denoptim.programs.genetweeker.GeneOpsRunnerParameters.interpretKeyword().

The documentation for this class was generated from the following file:

/github/workspace/src/main/java/denoptim/programs/genetweeker/GeneOpsRunnerParameters.java

Classes

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GeneOpsRunnerParameters()

Member Function Documentation

◆ checkParameters()

◆ getPrintedList()

◆ interpretKeyword()

◆ processParameters()

Member Data Documentation

◆ fapid

◆ idNewAP

◆ idNewVrt

◆ idTargetAP

◆ inpFileF

◆ inpFileM

◆ mapid

◆ maxSwappableChainLength

◆ mutationTarget

◆ mutationType

◆ operatorToTest

◆ outFileF

◆ outFileM

◆ xoverSrcFemale

◆ xoverSrcMale

◆ xoverSubGraphEndFemale

◆ xoverSubGraphEndMale

◆ xoverType