/*
* Encog(tm) Core v3.4 - Java Version
* http://www.heatonresearch.com/encog/
* https://github.com/encog/encog-java-core
* Copyright 2008-2016 Heaton Research, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* For more information on Heaton Research copyrights, licenses
* and trademarks visit:
* http://www.heatonresearch.com/copyright
*/
package org.encog.neural.networks.training;
import org.encog.ml.CalculateScore;
import org.encog.ml.MLMethod;
import org.encog.ml.MLRegression;
import org.encog.ml.data.MLDataSet;
import org.encog.ml.data.buffer.BufferedMLDataSet;
import org.encog.util.error.CalculateRegressionError;
import java.io.Serializable;
/**
* Calculate a score based on a training set. This class allows simulated
* annealing or genetic algorithms just as you would any other training set
* based training method. The method must support regression (MLRegression).
*/
public class TrainingSetScore implements CalculateScore, Serializable {
/**
* The training set.
*/
private final MLDataSet training;
/**
* Construct a training set score calculation.
*
* @param training
* The training data to use.
*/
public TrainingSetScore(final MLDataSet training) {
this.training = training;
}
/**
* Calculate the score for the network.
* @param method The network to calculate for.
* @return The score.
*/
public double calculateScore(final MLMethod method) {
return CalculateRegressionError.calculateError((MLRegression)method, this.training);
}
/**
* A training set based score should always seek to lower the error,
* as a result, this method always returns true.
* @return Returns true.
*/
public boolean shouldMinimize() {
return true;
}
@Override
public boolean requireSingleThreaded() {
if( this.training instanceof BufferedMLDataSet ) {
return true;
}
return false;
}
}