mikera.matrixx.decompose.ISVDResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vectorz Show documentation

Fast double-precision vector and matrix maths library for Java, supporting N-dimensional numeric arrays.

There is a newer version: 0.67.0

package mikera.matrixx.decompose;

import mikera.matrixx.AMatrix;
import mikera.vectorz.AVector;

/**
 * Interface representing the result of an SVD decomposition
 * 
 * @author Mike
 */
public interface ISVDResult {
	/**
     * 
     * Returns the orthogonal 'U' matrix.
     * 
     * @return An orthogonal matrix.
     */
    public AMatrix getU();
    
    /**
     * Returns a diagonal matrix with the singular values.  Order of the singular values
     * is not guaranteed.
     *
     * @return matrix with singular values along the diagonal.
     */
    public AMatrix getS();
    
    /**
     * 
     * Returns the orthogonal 'V' matrix.
     * 
     * @return An orthogonal matrix.
     */
    public AMatrix getV();
    
    /**
     * Returns an array containing singular values. The non zero singular values are
     * the square roots of the non-zero eigenvalues of M^TM and MM^T, 
     * where M is the input matrix.
     * 
     * @return
     */
    public AVector getSingularValues();
}