BayesEstimator.java

/*
 * 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.ml.bayesian.training.estimator;

import org.encog.ml.bayesian.BayesianNetwork;
import org.encog.ml.bayesian.training.TrainBayesian;
import org.encog.ml.data.MLDataSet;

/**
 * An estimator is used during Bayesian training to determine optimal probability values.
 */
public interface BayesEstimator {
	
	/**
	 * Init the estimator.
	 * @param theTrainer The trainer.
	 * @param theNetwork The network.
	 * @param theData The data.
	 */
	void init(TrainBayesian theTrainer ,BayesianNetwork theNetwork, MLDataSet theData);	
	
	/**
	 * Perform an iteration.
	 * @return True, if we should contune.
	 */
	boolean iteration();
}