org.djunits.value.vdouble.vector

Class DoubleVectorDataSparse

java.lang.Object

org.djunits.value.vdouble.vector.DoubleVectorDataSparse

public class DoubleVectorDataSparse
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 double[]	vectorSI the internal storage of the Vector; can be sparse or dense.

Constructor Summary

Constructors

Constructor and Description
DoubleVectorDataSparse(double[] vectorSI, int[] indices, int length) Create a vector with sparse data.

Method Summary

Modifier and Type	Method and Description
int	cardinality()
DoubleVectorDataSparse	copy()
org.djunits.value.vdouble.vector.DoubleVectorData	divide(org.djunits.value.vdouble.vector.DoubleVectorData right) Divide two vectors on a cell-by-cell basis.
boolean	equals(Object obj)
double[]	getDenseVectorSI()
double	getSI(int index)
int	hashCode()
org.djunits.value.vdouble.vector.DoubleVectorData	minus(org.djunits.value.vdouble.vector.DoubleVectorData right) Subtract two vectors on a cell-by-cell basis.
org.djunits.value.vdouble.vector.DoubleVectorData	plus(org.djunits.value.vdouble.vector.DoubleVectorData right) Add two vectors on a cell-by-cell basis.
void	setSI(int index, double valueSI) Sets a value at the index in the vector.
int	size()
org.djunits.value.vdouble.vector.DoubleVectorData	times(org.djunits.value.vdouble.vector.DoubleVectorData right) Multiply two vector on a cell-by-cell basis.
DoubleVectorDataDense	toDense()
double	zSum()

Methods inherited from class java.lang.Object

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

Field Detail

vectorSI

protected double[] vectorSI

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

Constructor Detail

DoubleVectorDataSparse

public DoubleVectorDataSparse(double[] vectorSI,
                              int[] indices,
                              int length)

Create a vector with sparse data.

Parameters:

vectorSI - the data to store

indices - the index values of the Vector

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

Method Detail

toDense

public final DoubleVectorDataDense toDense()

Returns:

a dense variant of the data.

size

public final int size()

Returns:

the size of the vector

getSI

public final double getSI(int index)

Parameters:

index - the index to get the value for

Returns:

the value at the index

setSI

public final void setSI(int index,
                        double valueSI)

Sets a value at the index in the vector.

Parameters:

index - the index to set the value for

valueSI - the value at the index

getDenseVectorSI

public final double[] getDenseVectorSI()

Returns:

a safe copy of VectorSI

copy

public final DoubleVectorDataSparse copy()

Returns:

a deep copy of the data.

hashCode

public int hashCode()

equals

public boolean equals(Object obj)

cardinality

public final int cardinality()

Returns:

the number of non-zero cells.

zSum

public final double zSum()

Returns:

the sum of the values of all cells.

plus

public org.djunits.value.vdouble.vector.DoubleVectorData plus(org.djunits.value.vdouble.vector.DoubleVectorData right)
                                                       throws ValueException

Add two vectors on a cell-by-cell basis. If both vectors are sparse, a sparse vector is returned, otherwise a dense vector is returned.

Parameters:

right - the other data object to add

Returns:

the sum of this data object and the other data object

Throws:

ValueException - if vectors have different lengths

minus

public org.djunits.value.vdouble.vector.DoubleVectorData minus(org.djunits.value.vdouble.vector.DoubleVectorData right)
                                                        throws ValueException

Subtract two vectors on a cell-by-cell basis. If both vectors are sparse, a sparse vector is returned, otherwise a dense vector is returned.

Parameters:

right - the other data object to subtract

Returns:

the sum of this data object and the other data object

Throws:

ValueException - if vectors have different lengths

times

public org.djunits.value.vdouble.vector.DoubleVectorData times(org.djunits.value.vdouble.vector.DoubleVectorData right)
                                                        throws ValueException

Multiply two vector on a cell-by-cell basis. If both vectors are dense, a dense vector is returned, otherwise a sparse vector is returned.

Parameters:

right - the other data object to multiply with

Returns:

the sum of this data object and the other data object

Throws:

ValueException - if vectors have different lengths

divide

public org.djunits.value.vdouble.vector.DoubleVectorData divide(org.djunits.value.vdouble.vector.DoubleVectorData right)
                                                         throws ValueException

Divide two vectors on a cell-by-cell basis. If both vectors are dense, a dense vector is returned, otherwise a sparse vector is returned.

Parameters:

right - the other data object to divide by

Returns:

the sum of this data object and the other data object

Throws:

ValueException - if vectors have different lengths