mikera.matrixx.decompose.impl.svd.SVDResult 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.impl.svd;

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

public class SVDResult implements ISVDResult {
	
	private final AMatrix U;
	private final AMatrix S;
	private final AMatrix V;
	private final AVector singularValues;
	
	public SVDResult(AMatrix U, AMatrix S, AMatrix V, AVector singularValues) {
		this.U = U;
		this.S = S;
		this.V = V;
		this.singularValues = singularValues;
	}

	/**
     * 
     * Returns the orthogonal 'U' matrix.
     * 
     * @return An orthogonal matrix.
     */
	@Override
	public AMatrix getU() {
		return U;
	}

	/**
     * Returns a diagonal matrix with the singular values.  Order of the singular values
     * is not guaranteed.
     *
     * @return matrix with singular values along the diagonal.
     */
	@Override
	public AMatrix getS() {
		return S;
	}

	/**
     * 
     * Returns the orthogonal 'V' matrix.
     * 
     * @return An orthogonal matrix.
     */
	@Override
	public AMatrix getV() {
		return V;
	}

	@Override
	public AVector getSingularValues() {
		return singularValues;
	}

}