geneticWedge.gp.io
Class ResultWriter

java.lang.Object
  extended by geneticWedge.gp.io.ResultWriter

public class ResultWriter
extends java.lang.Object

Class for writing standard results files. An evolved Population should be provided as the second argument to writeResults. The other methods provide useful utilities for recording results in alternative formats. They are particularly useful when a number of 'runs' have been performed and it is required that the results from different runs are stored in a single file.


Constructor Summary
ResultWriter()
           
 
Method Summary
 void setFunctionFormat(boolean useFunction)
          Sets the format in which functions will be displayed.
 boolean writeOutputs(java.lang.String filename, java.lang.String heading, java.lang.Object[][] trainOutputs, java.lang.Object[][] validationOutputs, java.lang.Object[][] testOutputs)
          This method writes the outputs resulting from training, validation and test data to file.
 boolean writeResults(java.lang.String filename, Population pop, StoppingCriterion stopCrit, boolean isSteadyState, int numberOfProgramsToReport, double[][] trainInputs, double[] trainTargets, double[][] valInputs, double[] valTargets)
          Writes results of evolution for the Population provided.
 boolean writeResults(java.lang.String filename, Population pop, StoppingCriterion stopCrit, boolean isSteadyState, int numberOfProgramsToReport, double[][] trainInputs, double[] trainTargets, double[][] valInputs, double[] valTargets, double[][] testInputs, double[] testTargets)
          Writes results of evolution for the Population provided.
 boolean writeSummaryInfo(java.lang.String filename, java.lang.String heading, double[] summaryData)
          This method writes an array of data to a file.
 boolean writeSummaryInfo(java.lang.String filename, java.lang.String heading, double[][] summaryData)
          This method writes a 2-D array of data to a file.
 boolean writeSummaryInfo(java.lang.String filename, java.lang.String heading, double[][][] summaryData)
          This method writes a 3-D array of data to a file.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ResultWriter

public ResultWriter()
Method Detail

writeResults

public boolean writeResults(java.lang.String filename,
                            Population pop,
                            StoppingCriterion stopCrit,
                            boolean isSteadyState,
                            int numberOfProgramsToReport,
                            double[][] trainInputs,
                            double[] trainTargets,
                            double[][] valInputs,
                            double[] valTargets)
Writes results of evolution for the Population provided. Performances on the training and validation data are recorded, as are the training parameters.


setFunctionFormat

public void setFunctionFormat(boolean useFunction)
Sets the format in which functions will be displayed.

Parameters:
useFunction - if true, this ResultWriter will write GP trees (Individuals) as mathematical functions, if false they will be written as comma-sparated lists

writeResults

public boolean writeResults(java.lang.String filename,
                            Population pop,
                            StoppingCriterion stopCrit,
                            boolean isSteadyState,
                            int numberOfProgramsToReport,
                            double[][] trainInputs,
                            double[] trainTargets,
                            double[][] valInputs,
                            double[] valTargets,
                            double[][] testInputs,
                            double[] testTargets)
Writes results of evolution for the Population provided. Performances on the training, validation and test dataare recorded, as are the training parameters.


writeOutputs

public boolean writeOutputs(java.lang.String filename,
                            java.lang.String heading,
                            java.lang.Object[][] trainOutputs,
                            java.lang.Object[][] validationOutputs,
                            java.lang.Object[][] testOutputs)
This method writes the outputs resulting from training, validation and test data to file. The outputs may be any Object since all Objects have a toString method.


writeSummaryInfo

public boolean writeSummaryInfo(java.lang.String filename,
                                java.lang.String heading,
                                double[] summaryData)
This method writes an array of data to a file. It is useful for saving result summaries.


writeSummaryInfo

public boolean writeSummaryInfo(java.lang.String filename,
                                java.lang.String heading,
                                double[][] summaryData)
This method writes a 2-D array of data to a file. It is useful for saving result summaries.


writeSummaryInfo

public boolean writeSummaryInfo(java.lang.String filename,
                                java.lang.String heading,
                                double[][][] summaryData)
This method writes a 3-D array of data to a file. It is useful for saving result summaries. It is assumed that the data is made up of 2-D data for each of a number of different 'runs'.