Resources

java.lang.Object
+
- jcgp.backend.resources.Resources
+

+
+
Direct Known Subclasses:
+
ModifiableResources
+
+
+
+
```
public class Resources
+extends java.lang.Object
```
+
Encapsulates all of the resources based on which the program operates. + Each instance of JCGP contains a single instance of Resources. +

+ The experiment's Resources object is passed to modules as the program operates, and + the actual parameter values can be obtained using getter methods. Note that, for code brevity, + this class's getters do not start with the word "get". For instance, to get the number of rows, + one would use rows() instead of getRows() which doesn't exist. + The fitness orientation of the problem being solved can also be retrieved using fitnessOrientation(). + Evolutionary strategies will typically use this to perform selection. +

+ In addition to parameters, this class also offers utility methods. Any necessary random numbers + should be obtained using getRandomInt() and getRandomDouble() as these methods + use a particular Random object guaranteed to generate random numbers based on the seed + parameter. Functions from the selected function set can be obtained through this class as well. + Finally, printing to the console should be done via the resources using the report and print + methods, so that these prints also get sent to the GUI console (if one is present).
+
+
Author:
+
Eduardo Pedroni
+
See Also:
+
Parameter
+
+

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
Resources()
+

Constructors
Constructor and Description
`Resources()`

+ +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`arity()`
`int`	`columns()`
`int`	`currentGeneration()`
`int`	`currentRun()`
`BestFitness`	`fitnessOrientation()`
`int`	`generations()`
`Function`	`getFunction(int index)` + Gets the indexed function out of the + complete set of functions. +
`int`	`getFunctionIndex(Function function)` + Returns the index of a specified function. +
`FunctionSet`	`getFunctionSet()`
`double`	`getRandomDouble()` + Gets the next random integer using the experiment's random + number generator. +
`double`	`getRandomDouble(int limit)` + Gets the next random double using the experiment's random + number generator. +
`Function`	`getRandomFunction()` + Gets a random allowed function from the problem function set. +
`int`	`getRandomInt(int limit)` + Gets the next random integer using the experiment's random + number generator. +
`int`	`inputs()`
`int`	`levelsBack()`
`int`	`nodes()`
`int`	`outputs()`
`int`	`populationSize()`
`void`	`print(java.lang.String message)` + Prints a message to the consoles ignoring + report interval. +
`void`	`println(java.lang.String message)` + Prints a message to the consoles ignoring + report interval. +
`void`	`report(java.lang.String message)` + Prints a message to the consoles taking into account the + report interval parameter. +
`int`	`reportInterval()`
`void`	`reportln(java.lang.String message)` + Prints a message to the consoles taking into account the + report interval parameter. +
`int`	`rows()`
`int`	`runs()`
`int`	`seed()`

+ + +
Methods inherited from class java.lang.Object
+equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    Resources
    +
```
public Resources()
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    rows
    +
```
public int rows()
```
    +
    +
    Returns:
    +
    the number of rows.
    +
    +
  + + + +
  - +
    columns
    +
```
public int columns()
```
    +
    +
    Returns:
    +
    the number of columns.
    +
    +
  + + + +
  - +
    inputs
    +
```
public int inputs()
```
    +
    +
    Returns:
    +
    the number of inputs.
    +
    +
  + + + +
  - +
    outputs
    +
```
public int outputs()
```
    +
    +
    Returns:
    +
    the number of outputs.
    +
    +
  + + + +
  - +
    populationSize
    +
```
public int populationSize()
```
    +
    +
    Returns:
    +
    the population size.
    +
    +
  + + + +
  - +
    levelsBack
    +
```
public int levelsBack()
```
    +
    +
    Returns:
    +
    the levels back value.
    +
    +
  + + + +
  - +
    nodes
    +
```
public int nodes()
```
    +
    +
    Returns:
    +
    the total number of nodes.
    +
    +
  + + + +
  - +
    currentGeneration
    +
```
public int currentGeneration()
```
    +
    +
    Returns:
    +
    the current generation.
    +
    +
  + + + +
  - +
    generations
    +
```
public int generations()
```
    +
    +
    Returns:
    +
    the total number of generations.
    +
    +
  + + + +
  - +
    currentRun
    +
```
public int currentRun()
```
    +
    +
    Returns:
    +
    the current run.
    +
    +
  + + + +
  - +
    runs
    +
```
public int runs()
```
    +
    +
    Returns:
    +
    the total number of runs.
    +
    +
  + + + +
  - +
    arity
    +
```
public int arity()
```
    +
    +
    Returns:
    +
    the maximum arity out of the function set.
    +
    +
  + + + +
  - +
    seed
    +
```
public int seed()
```
    +
    +
    Returns:
    +
    the random seed being used.
    +
    +
  + + + +
  - +
    reportInterval
    +
```
public int reportInterval()
```
    +
    +
    Returns:
    +
    the report interval.
    +
    +
  + + + +
  - +
    fitnessOrientation
    +
```
public BestFitness fitnessOrientation()
```
    +
    +
    Returns:
    +
    the fitness orientation.
    +
    +
  + + + +
  - +
    getRandomInt
    +
```
public int getRandomInt(int limit)
```
    +
    Gets the next random integer using the experiment's random + number generator. The integer returned will be between 0 (inclusive) + and limit (exclusive).
    +
    +
    Parameters:
    +
    limit - the limit value.
    +
    Returns:
    +
    a random integer between 0 and limit.
    +
    +
  + + + +
  - +
    getRandomDouble
    +
```
public double getRandomDouble(int limit)
```
    +
    Gets the next random double using the experiment's random + number generator. The double returned will be between 0 (inclusive) + and limit (exclusive).
    +
    +
    Parameters:
    +
    limit - the limit value.
    +
    Returns:
    +
    a random double between 0 and limit.
    +
    +
  + + + +
  - +
    getRandomDouble
    +
```
public double getRandomDouble()
```
    +
    Gets the next random integer using the experiment's random + number generator. The integer returned will be between 0 (inclusive) + and 1 (exclusive).
    +
    +
    Returns:
    +
    a random integer between 0 and 1.
    +
    +
  + + + +
  - +
    getRandomFunction
    +
```
public Function getRandomFunction()
```
    +
    Gets a random allowed function from the problem function set. + This function uses getRandomInt() to choose the random + function.
    +
    +
    Returns:
    +
    a random allowed function.
    +
    +
  + + + +
  - +
    getFunction
    +
```
public Function getFunction(int index)
```
    +
    Gets the indexed function out of the + complete set of functions.
    +
    +
    Parameters:
    +
    index - the function to return.
    +
    Returns:
    +
    the indexed function.
    +
    +
  + + + +
  - +
    getFunctionSet
    +
```
public FunctionSet getFunctionSet()
```
    +
    +
    Returns:
    +
    the problem's function set.
    +
    +
  + + + +
  - +
    getFunctionIndex
    +
```
public int getFunctionIndex(Function function)
```
    +
    Returns the index of a specified function. If the function is not found, + -1 is returned.
    +
    +
    Parameters:
    +
    function - the function with unknown index.
    +
    Returns:
    +
    the index of the function, or -1 if it was not found.
    +
    +
  + + + +
  - +
    reportln
    +
```
public void reportln(java.lang.String message)
```
    +
    Prints a message to the consoles taking into account the + report interval parameter. If no reports are allowed in + the current generation, this does nothing. +
    + This method automatically appends a line break to the message + being printed.
    +
    +
    Parameters:
    +
    message - the message to print.
    +
    +
  + + + +
  - +
    report
    +
```
public void report(java.lang.String message)
```
    +
    Prints a message to the consoles taking into account the + report interval parameter. If no reports are allowed in + the current generation, this does nothing. +
    + This method does not append a line break to the message + being printed.
    +
    +
    Parameters:
    +
    message - the message to print.
    +
    +
  + + + +
  - +
    println
    +
```
public void println(java.lang.String message)
```
    +
    Prints a message to the consoles ignoring + report interval. In other words, messages printed + using this method will always appear (though the + GUI console will still need to be flushed). +
    + This method automatically appends a line break to the message + being printed.
    +
    +
    Parameters:
    +
    message - the message to print.
    +
    +
  + + + +
  - +
    print
    +
```
public void print(java.lang.String message)
```
    +
    Prints a message to the consoles ignoring + report interval. In other words, messages printed + using this method will always appear (though the + GUI console will still need to be flushed). +
    + This method does not append a line break to the message + being printed.
    +
    +
    Parameters:
    +
    message - the message to print.
    +
    +
  +
+

Class Resources

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Resources

Method Detail

rows

columns

inputs

outputs

populationSize

levelsBack

nodes

currentGeneration

generations

currentRun

runs

arity

seed

reportInterval

fitnessOrientation

getRandomInt

getRandomDouble

getRandomDouble

getRandomFunction

getFunction

getFunctionSet

getFunctionIndex

reportln

report

println

print