From 8189116ea4b5db4675e31dfd04a5687d55e29262 Mon Sep 17 00:00:00 2001 From: Eduardo Pedroni Date: Tue, 6 May 2014 14:29:37 +0100 Subject: Added javadocs, made minor changes to the comments --- .../backend/resources/ModifiableResources.html | 819 +++++++++++++++++++++ 1 file changed, 819 insertions(+) create mode 100644 doc/jcgp/backend/resources/ModifiableResources.html (limited to 'doc/jcgp/backend/resources/ModifiableResources.html') diff --git a/doc/jcgp/backend/resources/ModifiableResources.html b/doc/jcgp/backend/resources/ModifiableResources.html new file mode 100644 index 0000000..c0295f3 --- /dev/null +++ b/doc/jcgp/backend/resources/ModifiableResources.html @@ -0,0 +1,819 @@ + + + + + +ModifiableResources + + + + + + + + +
+ + + + + + + +
+ + + +
+
jcgp.backend.resources
+

Class ModifiableResources

+
+
+ +
+
    +
  • +
    +
    +
    public class ModifiableResources
    +extends Resources
    +
    This subclass of Resources allows modifications to be made. + A read-only cast of this class is passed to modules for safety, + and only classes with access to a JCGP instance may modify + the resources.
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ModifiableResources

        +
        public ModifiableResources()
        +
        Creates an instance of this class and initialises + all base parameters to default values. See + createBaseParameters for the exact parameter + initialisation.
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setRows

        +
        public void setRows(int rows)
        +
        +
        Parameters:
        +
        rows - the number of rows to set.
        +
        +
      • +
      + + + +
        +
      • +

        setColumns

        +
        public void setColumns(int columns)
        +
        +
        Parameters:
        +
        columns - the number of columns to set.
        +
        +
      • +
      + + + +
        +
      • +

        setInputs

        +
        public void setInputs(int inputs)
        +
        +
        Parameters:
        +
        inputs - the number of inputs to set.
        +
        +
      • +
      + + + +
        +
      • +

        setOutputs

        +
        public void setOutputs(int outputs)
        +
        +
        Parameters:
        +
        outputs - the number of outputs to set.
        +
        +
      • +
      + + + +
        +
      • +

        setPopulationSize

        +
        public void setPopulationSize(int populationSize)
        +
        +
        Parameters:
        +
        populationSize - the population size to set.
        +
        +
      • +
      + + + +
        +
      • +

        setLevelsBack

        +
        public void setLevelsBack(int levelsBack)
        +
        +
        Parameters:
        +
        levelsBack - the levels back to set.
        +
        +
      • +
      + + + +
        +
      • +

        setCurrentGeneration

        +
        public void setCurrentGeneration(int currentGeneration)
        +
        +
        Parameters:
        +
        currentGeneration - the current generation to set.
        +
        +
      • +
      + + + +
        +
      • +

        incrementGeneration

        +
        public void incrementGeneration()
        +
        Adds 1 to the current generation.
        +
      • +
      + + + +
        +
      • +

        setGenerations

        +
        public void setGenerations(int generations)
        +
        +
        Parameters:
        +
        generations - the total generations to set.
        +
        +
      • +
      + + + +
        +
      • +

        setCurrentRun

        +
        public void setCurrentRun(int currentRun)
        +
        +
        Parameters:
        +
        currentRun - the current run to set.
        +
        +
      • +
      + + + +
        +
      • +

        incrementRun

        +
        public void incrementRun()
        +
        Adds 1 to the current generation.
        +
      • +
      + + + +
        +
      • +

        setRuns

        +
        public void setRuns(int runs)
        +
        +
        Parameters:
        +
        runs - the total runs to set.
        +
        +
      • +
      + + + +
        +
      • +

        setArity

        +
        public void setArity(int arity)
        +
        This is called automatically by the experiment when the arity changes.
        +
        +
        Parameters:
        +
        arity - the arity to set.
        +
        +
      • +
      + + + +
        +
      • +

        setSeed

        +
        public void setSeed(int seed)
        +
        +
        Parameters:
        +
        seed - the seed to set.
        +
        +
      • +
      + + + +
        +
      • +

        setReportInterval

        +
        public void setReportInterval(int report)
        +
        +
        Parameters:
        +
        report - the report interval to set.
        +
        +
      • +
      + + + +
        +
      • +

        setFitnessOrientation

        +
        public void setFitnessOrientation(BestFitness newOrientation)
        +
        +
        Parameters:
        +
        newOrientation - the new orientation to set.
        +
        +
      • +
      + + + +
        +
      • +

        getRowsParameter

        +
        public IntegerParameter getRowsParameter()
        +
        +
        Returns:
        +
        the rows parameter.
        +
        +
      • +
      + + + +
        +
      • +

        getColumnsParameter

        +
        public IntegerParameter getColumnsParameter()
        +
        +
        Returns:
        +
        the columns parameter.
        +
        +
      • +
      + + + +
        +
      • +

        getInputsParameter

        +
        public IntegerParameter getInputsParameter()
        +
        +
        Returns:
        +
        the inputs parameter.
        +
        +
      • +
      + + + +
        +
      • +

        getOutputsParameter

        +
        public IntegerParameter getOutputsParameter()
        +
        +
        Returns:
        +
        the outputs parameter.
        +
        +
      • +
      + + + +
        +
      • +

        getPopulationSizeParameter

        +
        public IntegerParameter getPopulationSizeParameter()
        +
        +
        Returns:
        +
        the population size parameter.
        +
        +
      • +
      + + + +
        +
      • +

        getLevelsBackParameter

        +
        public IntegerParameter getLevelsBackParameter()
        +
        +
        Returns:
        +
        the levels back parameter.
        +
        +
      • +
      + + + +
        +
      • +

        getCurrentGenerationParameter

        +
        public IntegerParameter getCurrentGenerationParameter()
        +
        +
        Returns:
        +
        the current generation parameter.
        +
        +
      • +
      + + + +
        +
      • +

        getGenerationsParameter

        +
        public IntegerParameter getGenerationsParameter()
        +
        +
        Returns:
        +
        the total generations parameter.
        +
        +
      • +
      + + + +
        +
      • +

        getCurrentRunParameter

        +
        public IntegerParameter getCurrentRunParameter()
        +
        +
        Returns:
        +
        the current run parameter.
        +
        +
      • +
      + + + +
        +
      • +

        getRunsParameter

        +
        public IntegerParameter getRunsParameter()
        +
        +
        Returns:
        +
        the total runs parameter.
        +
        +
      • +
      + + + +
        +
      • +

        getArityParameter

        +
        public IntegerParameter getArityParameter()
        +
        +
        Returns:
        +
        the arity parameter.
        +
        +
      • +
      + + + +
        +
      • +

        getSeedParameter

        +
        public IntegerParameter getSeedParameter()
        +
        +
        Returns:
        +
        the seed parameter.
        +
        +
      • +
      + + + +
        +
      • +

        getReportIntervalParameter

        +
        public IntegerParameter getReportIntervalParameter()
        +
        +
        Returns:
        +
        the report interval parameter.
        +
        +
      • +
      + + + +
        +
      • +

        setFunctionSet

        +
        public void setFunctionSet(FunctionSet functionSet)
        +
        Update the current function set.
        +
        +
        Parameters:
        +
        functionSet - the new function set.
        +
        +
      • +
      + + + +
        +
      • +

        setConsole

        +
        public void setConsole(Console console)
        +
        This can be set to null if no extra console is desired.
        +
        +
        Parameters:
        +
        console - the extra console for the experiment to use.
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + -- cgit v1.2.3