$darkmode
DENOPTIM
denoptim.programs.isomorphism.IsomorphismParameters Class Reference

Parameters controlling execution of Isomorphism main class. More...

Inheritance diagram for denoptim.programs.isomorphism.IsomorphismParameters:
[legend]
Collaboration diagram for denoptim.programs.isomorphism.IsomorphismParameters:
[legend]

Public Member Functions

 IsomorphismParameters ()
 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

String inpFileGraphA
 Input file containing graph A. More...
 
String inpFileGraphB
 Input file containing graph B. 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, RunTimeParametersotherParameters
 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 Isomorphism main class.

Author
Marco Foscato

Definition at line 34 of file IsomorphismParameters.java.

Constructor & Destructor Documentation

◆ IsomorphismParameters()

denoptim.programs.isomorphism.IsomorphismParameters.IsomorphismParameters ( )

Member Function Documentation

◆ checkParameters()

void denoptim.programs.isomorphism.IsomorphismParameters.checkParameters ( ) throws DENOPTIMException

Evaluate consistency of input parameters.

Exceptions
DENOPTIMException

Reimplemented from denoptim.programs.RunTimeParameters.

Definition at line 92 of file IsomorphismParameters.java.

References denoptim.files.FileUtils.checkExists(), denoptim.programs.RunTimeParameters.checkOtherParameters(), denoptim.programs.isomorphism.IsomorphismParameters.inpFileGraphA, and denoptim.programs.isomorphism.IsomorphismParameters.inpFileGraphB.

Referenced by denoptim.programs.isomorphism.Isomorphism.runProgram().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getPrintedList()

String denoptim.programs.isomorphism.IsomorphismParameters.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 131 of file IsomorphismParameters.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.isomorphism.IsomorphismParameters.interpretKeyword ( String  key,
String  value 
) throws DENOPTIMException

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

Parameters
keythe keyword as string
valuethe value as a string
Exceptions
DENOPTIMException

Reimplemented from denoptim.programs.RunTimeParameters.

Definition at line 65 of file IsomorphismParameters.java.

References denoptim.programs.isomorphism.IsomorphismParameters.inpFileGraphA, and denoptim.programs.isomorphism.IsomorphismParameters.inpFileGraphB.

◆ processParameters()

void denoptim.programs.isomorphism.IsomorphismParameters.processParameters ( ) throws DENOPTIMException

Processes all parameters and initialize related objects.

Exceptions
DENOPTIMException

Reimplemented from denoptim.programs.RunTimeParameters.

Definition at line 118 of file IsomorphismParameters.java.

References denoptim.programs.RunTimeParameters.processOtherParameters().

Referenced by denoptim.programs.isomorphism.Isomorphism.runProgram().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ inpFileGraphA

String denoptim.programs.isomorphism.IsomorphismParameters.inpFileGraphA
protected

◆ inpFileGraphB

String denoptim.programs.isomorphism.IsomorphismParameters.inpFileGraphB
protected

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