EndMaxErrorStrategy.java

/*
 * Encog(tm) Core v2.5 - Java Version
 * http://www.heatonresearch.com/encog/
 * http://code.google.com/p/encog-java/
 
 * Copyright 2008-2010 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.strategy.end;

import org.encog.neural.networks.training.Train;

public class EndMaxErrorStrategy implements EndTrainingStrategy {

	private double maxError;
	private Train train;
	private boolean started;
	
	public EndMaxErrorStrategy(double maxError) {
		this.maxError = maxError;
		this.started = false;
	}	
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public boolean shouldStop() {
		return this.started && this.train.getError()<this.maxError;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void init(Train train) {
		this.train = train;
		this.started = false;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void postIteration() {
		this.started = true;		
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void preIteration() {
	
	}

}