schureigenvaluedecomposer.java

一个关于java 的常用工具包

package org.jutil.math.matrix;

/**
 * A class of eigenvalue decomposers using an explict shift algorithm.
 *
 * @path    $Source: /cvsroot/org-jutil/jutil.org/src/org/jutil/math/matrix/SchurEigenvalueDecomposer.java,v $
 * @version $Revision: 1.4 $
 * @date    $Date: 2002/07/02 14:27:32 $
 * @state   $State: Exp $
 * @author  Marko van Dooren
 * @release $Name:  $
 */
public class SchurEigenvalueDecomposer implements EigenvalueDecomposer {
	
	/* The revision of this class */
	public final static String CVS_REVISION ="$Revision: 1.4 $";

	/**
	 * Initialize a new SchurEigenvalueDecomposer with the given
	 * HessenbergReducer
	 *
	 * @param decomposer
	 *        The SchurDecomposer to be used by this SchurEigenvalueDecomposer.
	 * @param linSolver
	 *        The LinSolver to be used by this SchurEigenvalueDecomposer.
	 */
 /*@
	 @ public behavior
	 @
	 @ pre decomposer != null;
	 @ pre linSolver != null;
	 @
	 @ post getSchurDecomposer() == decomposer;
	 @ post getLinSolver() == linSolver;
	 @*/
	public SchurEigenvalueDecomposer(SchurDecomposer decomposer, LinSolver linSolver) {
		_decomposer = decomposer;
		_linSolver = linSolver;
  }

	/**
	 * Return the SchurDecomposer used by this SchurEigenvalueDecomposer
	 * to calculate eigenvalue decompositions.
	 */
 /*@
	 @ public behavior
	 @
	 @ post \result != null;
	 @*/
	public SchurDecomposer getSchurDecomposer() {
		return _decomposer;
  }
	
	/**
	 * Return the LinSolver used by this SchurEigenvalueDecomposer
	 * to calculate eigenvalue decompositions.
	 */
 /*@
	 @ public behavior
	 @
	 @ post \result != null;
	 @*/
	public LinSolver getLinSolver() {
		return _linSolver;
  }
	
	/**
	 * See superclass
	 */
	public EigenvalueDecomposition decompose(Matrix matrix) {
		SchurDecomposition schurDecomposition = getSchurDecomposer().decompose(matrix);
		return new SchurEigenvalueDecomposition(schurDecomposition, getLinSolver());
  }
	
	/**
	 * The SchurDecomposer used by this SchurEigenvalueDecomposer
	 * to calculate eigenvalue decompositions.
	 */
 /*@
	 @ private invariant _decomposer != null;
	 @*/
	private SchurDecomposer _decomposer;	

	/**
	 * The LinSolver used by this SchurEigenvalueDecomposer
	 * to calculate eigenvalue decompositions.
	 */
 /*@
	 @ private invariant _linSolver != null;
	 @*/
	private LinSolver _linSolver;	
}

/*<copyright>Copyright (C) 1997-2002. This software is copyrighted by 
the people and entities mentioned after the "@author" tags above, on 
behalf of the JUTIL.ORG Project. The copyright is dated by the dates 
after the "@date" tags above. All rights reserved.
This software is published under the terms of the JUTIL.ORG Software
License version 1.1 or later, a copy of which has been included with
this distribution in the LICENSE file, which can also be found at
http://org-jutil.sourceforge.net/LICENSE. This software is distributed WITHOUT 
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
or FITNESS FOR A PARTICULAR PURPOSE. See the JUTIL.ORG Software 
License for more details.
For more information, please see http://org-jutil.sourceforge.net/</copyright>*/