org.djunits.value.vdouble.matrix

Class DoubleMatrixDataSparse

java.lang.Object

org.djunits.value.vdouble.matrix.DoubleMatrixData

org.djunits.value.vdouble.matrix.DoubleMatrixDataSparse

public class DoubleMatrixDataSparse
extends DoubleMatrixData

Stores sparse data for a DoubleMatrix and carries out basic operations.

Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Oct 3, 2015

Author:

Alexander Verbraeck, Peter Knoppers

Field Summary

Fields inherited from class org.djunits.value.vdouble.matrix.DoubleMatrixData

cols, matrixSI, rows

Constructor Summary

Constructors

Constructor and Description
DoubleMatrixDataSparse(double[][] dataSI) Create a vector with sparse data.
DoubleMatrixDataSparse(double[] denseSI, int rows, int cols) Create a vector with sparse data from an internal vector with dense data.
DoubleMatrixDataSparse(double[] matrixSI, long[] indices, int length, int rows, int cols) Create a vector with sparse data.

Method Summary

Modifier and Type	Method and Description
DoubleMatrixDataSparse	copy()
void	decrementBy(DoubleMatrixData right) Subtract a matrix from this matrix on a cell-by-cell basis.
void	divideBy(DoubleMatrixData right) Divide the values of a matrix by the values of another matrix on a cell-by-cell basis.
boolean	equals(Object obj)
double[][]	getDenseMatrixSI()
double	getSI(int row, int col)
int	hashCode()
void	incrementBy(DoubleMatrixData right) Add a matrix to this matrix on a cell-by-cell basis.
static DoubleMatrixDataSparse	instantiate(double[][] valuesSI) Instantiate a DoubleMatrixDataSparse from an array.
void	multiplyBy(DoubleMatrixData right) Multiply a matrix with the values of another matrix on a cell-by-cell basis.
void	setSI(int row, int col, double valueSI) Sets a value at the [row, col] point in the matrix.
DoubleMatrixDataDense	toDense()

Methods inherited from class org.djunits.value.vdouble.matrix.DoubleMatrixData

cardinality, cols, decrementBy, divide, divideBy, getStorageType, incrementBy, instantiate, instantiate, isDense, isSparse, minus, multiplyBy, plus, rows, times, toSparse, toString, zSum

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DoubleMatrixDataSparse

public DoubleMatrixDataSparse(double[] matrixSI,
                              long[] indices,
                              int length,
                              int rows,
                              int cols)

Create a vector with sparse data.

Parameters:

matrixSI - the data to store

indices - the index values of the Matrix, with index = row * cols + col

length - the length of the vector (padded with 0 after highest index in indices)

rows - the number of rows

cols - the number of columns

DoubleMatrixDataSparse

public DoubleMatrixDataSparse(double[] denseSI,
                              int rows,
                              int cols)
                       throws ValueException

Create a vector with sparse data from an internal vector with dense data.

Parameters:

denseSI - the dense data to store

rows - the number of rows

cols - the number of columns

Throws:

ValueException - in case size is incorrect

DoubleMatrixDataSparse

public DoubleMatrixDataSparse(double[][] dataSI)
                       throws ValueException

Create a vector with sparse data.

Parameters:

dataSI - the data to store

Throws:

ValueException - in case matrix is ragged

Method Detail

toDense

public final DoubleMatrixDataDense toDense()

Overrides:

toDense in class DoubleMatrixData

Returns:

the dense transformation of this data

getSI

public final double getSI(int row,
                          int col)

Specified by:

getSI in class DoubleMatrixData

Parameters:

row - the row number to get the value for

col - the column number to get the value for

Returns:

the value at the [row, col] point

setSI

public final void setSI(int row,
                        int col,
                        double valueSI)

Sets a value at the [row, col] point in the matrix.

Specified by:

setSI in class DoubleMatrixData

Parameters:

row - the row number to set the value for

col - the column number to set the value for

valueSI - the value at the index

getDenseMatrixSI

public final double[][] getDenseMatrixSI()

Specified by:

getDenseMatrixSI in class DoubleMatrixData

Returns:

a safe dense copy of matrixSI as a matrix

copy

public final DoubleMatrixDataSparse copy()

Specified by:

copy in class DoubleMatrixData

Returns:

a deep copy of the data.

instantiate

public static DoubleMatrixDataSparse instantiate(double[][] valuesSI)
                                          throws ValueException

Instantiate a DoubleMatrixDataSparse from an array.

Parameters:

valuesSI - the (SI) values to store

Returns:

the DoubleMatrixDataSparse

Throws:

ValueException - in case matrix is ragged

incrementBy

public final void incrementBy(DoubleMatrixData right)
                       throws ValueException

Add a matrix to this matrix on a cell-by-cell basis. The type of matrix (sparse, dense) stays the same.

Specified by:

incrementBy in class DoubleMatrixData

Parameters:

right - the other data object to add

Throws:

ValueException - if matrices have different lengths

decrementBy

public final void decrementBy(DoubleMatrixData right)
                       throws ValueException

Subtract a matrix from this matrix on a cell-by-cell basis. The type of matrix (sparse, dense) stays the same.

Specified by:

decrementBy in class DoubleMatrixData

Parameters:

right - the other data object to subtract

Throws:

ValueException - if matrices have different lengths

multiplyBy

public final void multiplyBy(DoubleMatrixData right)
                      throws ValueException

Multiply a matrix with the values of another matrix on a cell-by-cell basis. The type of matrix (sparse, dense) stays the same.

Specified by:

multiplyBy in class DoubleMatrixData

Parameters:

right - the other data object to multiply with

Throws:

ValueException - if matrices have different lengths

divideBy

public final void divideBy(DoubleMatrixData right)
                    throws ValueException

Divide the values of a matrix by the values of another matrix on a cell-by-cell basis. The type of matrix (sparse, dense) stays the same.

Specified by:

divideBy in class DoubleMatrixData

Parameters:

right - the other data object to divide by

Throws:

ValueException - if matrices have different lengths

hashCode

public int hashCode()

Overrides:

hashCode in class DoubleMatrixData

equals

public boolean equals(Object obj)

Overrides:

equals in class DoubleMatrixData