no.uib.cipr.matrix.UpperTriangPackMatrix Maven / Gradle / Ivy
/*
* 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;
/**
* Upper triangular packed matrix. In contrast with
* {@link no.uib.cipr.matrix.LowerTriangDenseMatrix LowerTriangDenseMatrix},
* this matrix exploits the sparsity by only storing about half the matrix. As
* such, the triangular matrix
*
*
*
* a11
* a12
* a13
* a14
*
*
*
* a22
* a23
* a24
*
*
*
*
* a33
* a34
*
*
*
*
*
* a44
*
*
*
*
* is packed as follows:
*
*
*
*
* a11
* a12
* a22
* a13
* a23
* a33
* a14
* a24
* a34
* a44
*
*
*
*/
public class UpperTriangPackMatrix extends AbstractTriangPackMatrix {
/**
* Constructor for UpperTriangPackMatrix
*
* @param n
* Size of the matrix. Since the matrix must be square, this
* equals both the number of rows and columns
*/
public UpperTriangPackMatrix(int n) {
super(n, UpLo.Upper, Diag.NonUnit);
}
/**
* Constructor for UpperTriangPackMatrix
*
* @param n
* Size of the matrix. Since the matrix must be square, this
* equals both the number of rows and columns
*/
UpperTriangPackMatrix(int n, Diag diag) {
super(n, UpLo.Upper, diag);
}
/**
* Constructor for UpperTriangPackMatrix
*
* @param A
* Matrix to copy contents from. Only the entries of the relevant
* part are copied
*/
public UpperTriangPackMatrix(Matrix A) {
this(A, true);
}
/**
* Constructor for UpperTriangPackMatrix
*
* @param A
* Matrix to copy contents from. Only the entries of the relevant
* part are copied
* @param deep
* True if the copy is deep, else false (giving a shallow copy).
* For shallow copies, A must be a packed matrix
*/
public UpperTriangPackMatrix(Matrix A, boolean deep) {
super(A, deep, UpLo.Upper, Diag.NonUnit);
}
/**
* Constructor for UpperTriangPackMatrix
*
* @param A
* Matrix to copy contents from. Only the entries of the relevant
* part are copied
* @param deep
* True if the copy is deep, else false (giving a shallow copy).
* For shallow copies, A must be a packed matrix
*/
UpperTriangPackMatrix(Matrix A, boolean deep, Diag diag) {
super(A, deep, UpLo.Upper, diag);
}
@Override
public void add(int row, int column, double value) {
if (row > column)
throw new IllegalArgumentException("row > column");
data[getIndex(row, column)] += value;
}
@Override
public void set(int row, int column, double value) {
if (row > column)
throw new IllegalArgumentException("row > column");
data[getIndex(row, column)] = value;
}
@Override
public double get(int row, int column) {
if (row > column)
return 0;
return data[getIndex(row, column)];
}
/**
* Checks the row and column indices, and returns the linear data index
*/
int getIndex(int row, int column) {
check(row, column);
return row + (column + 1) * column / 2;
}
@Override
void copy(Matrix A) {
for (MatrixEntry e : A)
if (e.row() <= e.column())
set(e.row(), e.column(), e.get());
}
@Override
public UpperTriangPackMatrix copy() {
return new UpperTriangPackMatrix(this);
}
}