gov.nist.math.jampack.Eye Maven / Gradle / Ivy

Go to download
package gov.nist.math.jampack;

/**
 * Eye generates a matrix whose diagonal elements are one and whose off diagonal
 * elements are zero.
 */
public final class Eye {

    /**
     * Generates an identity matrix of order n.
     * 
     * @param n the order of the matrix
     */
    public static Zmat o(int n) {
        return o(n, n);
    }

    /**
     * Generates an mxn matrix whose diagonal elements are one and
     * whose off diagonal elements are zero.
     * 
     * @param m the number of rows in the matrix
     * @param n the number of columns in the matrix
     */
    public static Zmat o(int m, int n) {

        Zmat I = new Zmat(m, n);

        for (int i = 0; i < Math.min(m, n); i++) {
            I.re[i][i] = 1;
            I.im[i][i] = 0;
        }

        return I;
    }
}