jacobiantxjacobianandjacobiantxerroranderror.java

利用Java实现的神经网络工具箱

/*
 * JacobianTxJacobianAndJacobianTxErrorAndError.java	1.0 19 Jun 2004
 *
 * NeuralNetworkToolkit
 * Copyright (C) 2004 Universidade de Bras�lia
 *
 * This file is part of NeuralNetworkToolkit.
 *
 * NeuralNetworkToolkit is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * NeuralNetworkToolkit is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with NeuralNetworkToolkit; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA - 02111-1307 - USA.
 */

package neuralnetworktoolkit.methods.gradientbased.quasinewton;

/**
 * Defines an object to store the product of transposed jacobian 
 * matrix by jacobian matrix and the product of transposed 
 * jacobian matrix by error vector.
 * 
 * @version 1.0 19 Jun 2004
 * 
 * @author <a href="mailto:[e-mail]">Hugo Iver V. Gon�alves</a>
 * @author <a href="mailto:[e-mail]">Rodrigo C. M. Coimbra</a>
 */
public class JacobianTxJacobianAndJacobianTxErrorAndError {
	
	/** 
	 * Stores the product of transposed jacobian matrix by
	 * jacobian matrix.
	 */
	private double[][] jtXj;
	
	/** 
	 * Stores the product of transposed jacobian matrix by
	 * error vector.
	 */
	private double[][] jtXerror;
	
	/**
	 * Stores the error calculated in ...
	 * This takes advantage of the method making training faster.
	 */
	private double error;

	/**
	 * Creates a new matrices storage.
	 * 
	 * @param jtXj     Product of transposed jacobian matrix by
	 *                 jacobian matrix.
	 * @param jtXerror Product of transposed jacobian matrix by
	 *                 error vector.
	 */
	public JacobianTxJacobianAndJacobianTxErrorAndError(
		double[][] jtXj,
		double[][] jtXerror,
		double error) {
		
		this.jtXj = jtXj;
		this.jtXerror = jtXerror;
		this.error = error;
		
	} //JacobianTxJacobianAndJacobianTxErrorAndError()

	/**
	 * Returns the product of transposed jacobian matrix by
	 * error vector.
	 * 
	 * @return Product of transposed jacobian matrix by error vector.
	 */
	public double[][] getJtXerror() {
		return jtXerror;
		
	} //getJtXerror()

	/**
	 * Returns the product of transposed jacobian  matrix by
	 * jacobian matrix.
	 * 
	 * @return Product of transposed jacobian  matrix by jacobian matrix.
	 */
	public double[][] getJtXj() {
		return jtXj;
		
	} //getJtXj()

	/**
	 * Stores the product of transposed jacobian matrix by
	 * error vector.
	 * 
	 * @param jtXerror The product of transposed jacobian matrix by
	 *                 error vector.
	 */
	public void setJtXerror(double[][] jtXerror) {
		this.jtXerror = jtXerror;
		
	} //setJtXerror()

	/**
	 * Stores the product of transposed jacobian  matrix by
	 * jacobian matrix.
	 *  
	 * @param jtXj The product of transposed jacobian  matrix by
	 *             jacobian matrix.
	 */
	public void setJtXj(double[][] jtXj) {
		this.jtXj = jtXj;
		
	} //setJtXj()

	/**
	 * @return Returns the error.
	 */
	public double getError() {
		return error;
	}
	/**
	 * @param error The error to set.
	 */
	public void setError(double error) {
		this.error = error;
	}
} //JacobianTxJacobianAndJacobianTxErrorAndError