LowerTriangBandMatrix.java

/*
 * Copyright (C) 2003-2006 Bjørn-Ove Heimsund
 * 
 * This file is part of MTJ.
 * 
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version.
 * 
 * This library 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 Lesser General Public License
 * for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

package no.uib.cipr.matrix;

/**
 * Lower triangular banded matrix. The same storage as
 * {@link no.uib.cipr.matrix.BandMatrix BandMatrix}, but without superdiagonals.
 */
public class LowerTriangBandMatrix extends AbstractTriangBandMatrix {

    /**
     * Constructor for LowerTriangBandMatrix
     * 
     * @param n
     *            Size of the matrix. Since the matrix must be square, this
     *            equals both the number of rows and columns
     * @param kd
     *            Number of bands below the main diagonal (subdiagonals)
     */
    public LowerTriangBandMatrix(int n, int kd) {
        super(n, kd, 0, UpLo.Lower, Diag.NonUnit);
    }

    /**
     * Constructor for LowerTriangBandMatrix
     * 
     * @param A
     *            Matrix to copy contents from. Only the parts of <code>A</code>
     *            that lie within the allocated band are copied over, the rest
     *            is ignored
     * @param kd
     *            Number of bands below the main diagonal (subdiagonals)
     */
    public LowerTriangBandMatrix(Matrix A, int kd) {
        this(A, kd, true);
    }

    /**
     * Constructor for LowerTriangBandMatrix
     * 
     * @param A
     *            Matrix to copy contents from. Only the parts of <code>A</code>
     *            that lie within the allocated band are copied over, the rest
     *            is ignored
     * @param kd
     *            Number of bands below the main diagonal (subdiagonals)
     * @param deep
     *            True for a deep copy. For shallow copies, <code>A</code> must
     *            be a banded matrix
     */
    public LowerTriangBandMatrix(Matrix A, int kd, boolean deep) {
        super(A, kd, 0, deep, UpLo.Lower, Diag.NonUnit);
    }

    /**
     * Constructor for LowerTriangBandMatrix
     * 
     * @param n
     *            Size of the matrix. Since the matrix must be square, this
     *            equals both the number of rows and columns
     * @param kd
     *            Number of bands below the main diagonal (subdiagonals)
     */
    LowerTriangBandMatrix(int n, int kd, Diag diag) {
        super(n, kd, 0, UpLo.Lower, diag);
    }

    /**
     * Constructor for LowerTriangBandMatrix
     * 
     * @param A
     *            Matrix to copy contents from. Only the parts of <code>A</code>
     *            that lie within the allocated band are copied over, the rest
     *            is ignored
     * @param kd
     *            Number of bands below the main diagonal (subdiagonals)
     * @param deep
     *            True for a deep copy. For shallow copies, <code>A</code> must
     *            be a banded matrix
     */
    LowerTriangBandMatrix(Matrix A, int kd, boolean deep, Diag diag) {
        super(A, kd, 0, deep, UpLo.Lower, diag);
    }

    @Override
    public LowerTriangBandMatrix copy() {
        return new LowerTriangBandMatrix(this, kl);
    }

}