org.djunits.value.vfloat.matrix

Class FloatMatrixDataSparse

java.lang.Object

org.djunits.value.vfloat.matrix.FloatMatrixDataSparse

public class FloatMatrixDataSparse
extends Object

Copyright (c) 2013-2015 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

Modifier and Type	Field and Description
protected int	cols the number of columns of the vector.
protected float[]	matrixSI the internal storage of the Matrix; can be sparse or dense.
protected int	rows the number of rows of the vector.

Constructor Summary

Constructors

Constructor and Description
FloatMatrixDataSparse(float[][] matrixSI) Create a vector with sparse data.
FloatMatrixDataSparse(float[] matrixSI, long[] indices, int length, int rows, int cols) Create a vector with sparse data.

Method Summary

Modifier and Type	Method and Description
int	cardinality()
int	cols()
FloatMatrixDataSparse	copy()
boolean	equals(Object obj)
double[][]	getDenseDoubleMatrixSI()
float[][]	getDenseMatrixSI()
float[]	getDenseVectorSI()
float	getSI(int row, int col)
int	hashCode()
int	rows()
void	setSI(int row, int col, float valueSI) Sets a value at the [row, col] point in the vector.
FloatMatrixDataDense	toDense()
float	zSum()

Methods inherited from class java.lang.Object

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

Field Detail

matrixSI

protected float[] matrixSI

the internal storage of the Matrix; can be sparse or dense.

rows

protected int rows

the number of rows of the vector.

cols

protected int cols

the number of columns of the vector.

Constructor Detail

FloatMatrixDataSparse

public FloatMatrixDataSparse(float[] 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 Vector, 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

FloatMatrixDataSparse

public FloatMatrixDataSparse(float[][] matrixSI)
                      throws ValueException

Create a vector with sparse data.

Parameters:

matrixSI - the data to store

Throws:

ValueException - in case matrix is ragged

Method Detail

toDense

public final FloatMatrixDataDense toDense()

Returns:

a dense variant of the data.

getSI

public final float getSI(int row,
                         int col)

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,
                        float valueSI)

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

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

getDenseVectorSI

public final float[] getDenseVectorSI()

Returns:

a safe dense copy of matrixSI as a vector

getDenseMatrixSI

public final float[][] getDenseMatrixSI()

Returns:

a safe dense copy of matrixSI as a matrix

getDenseDoubleMatrixSI

public final double[][] getDenseDoubleMatrixSI()

Returns:

a safe dense copy of matrixSI as a double matrix for ojAlgo

copy

public final FloatMatrixDataSparse copy()

Returns:

a deep copy of the data.

hashCode

public int hashCode()

equals

public boolean equals(Object obj)

rows

public int rows()

Returns:

the number of rows of the vector

cols

public int cols()

Returns:

the number of columns of the vector

cardinality

public final int cardinality()

Returns:

the number of non-zero cells.

zSum

public final float zSum()

Returns:

the sum of the values of all cells.