org.djunits.value.vfloat.vector

Class FloatVectorDataSparse

java.lang.Object

org.djunits.value.vfloat.vector.FloatVectorData

org.djunits.value.vfloat.vector.FloatVectorDataSparse

public class FloatVectorDataSparse
extends FloatVectorData

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

Copyright (c) 2013-2017 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.vfloat.vector.FloatVectorData

vectorSI

Constructor Summary

Constructors

Constructor and Description
FloatVectorDataSparse(float[] vectorSI, int[] indices, int size) Create a vector with sparse data.

Method Summary

Modifier and Type	Method and Description
FloatVectorDataSparse	copy()
void	decrementBy(FloatVectorData right) Subtract a vector from this vector on a cell-by-cell basis.
void	divideBy(FloatVectorData right) Divide the values of a vector by the values of another vector on a cell-by-cell basis.
boolean	equals(Object obj)
float[]	getDenseVectorSI()
float	getSI(int index)
int	hashCode()
void	incrementBy(FloatVectorData right) Add a vector to this vector on a cell-by-cell basis.
static FloatVectorDataSparse	instantiate(float[] valuesSI) Instantiate a FloatVectorDataSparse from an array.
void	multiplyBy(FloatVectorData right) Multiply a vector with the values of another vector on a cell-by-cell basis.
void	setSI(int index, float valueSI) Sets a value at the index in the vector.
int	size()
FloatVectorDataDense	toDense()

Methods inherited from class org.djunits.value.vfloat.vector.FloatVectorData

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

Methods inherited from class java.lang.Object

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

Constructor Detail

FloatVectorDataSparse

public FloatVectorDataSparse(float[] vectorSI,
                             int[] indices,
                             int size)

Create a vector with sparse data.

Parameters:

vectorSI - the data to store

indices - the index values of the Vector

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

Method Detail

toDense

public final FloatVectorDataDense toDense()

Overrides:

toDense in class FloatVectorData

Returns:

the dense transformation of this data

size

public final int size()

Specified by:

size in class FloatVectorData

Returns:

the size of the vector

getSI

public final float getSI(int index)

Specified by:

getSI in class FloatVectorData

Parameters:

index - the index to get the value for

Returns:

the value at the index

setSI

public final void setSI(int index,
                        float valueSI)

Sets a value at the index in the vector.

Specified by:

setSI in class FloatVectorData

Parameters:

index - the index to set the value for

valueSI - the value at the index

getDenseVectorSI

public final float[] getDenseVectorSI()

Specified by:

getDenseVectorSI in class FloatVectorData

Returns:

a safe copy of VectorSI

copy

public final FloatVectorDataSparse copy()

Specified by:

copy in class FloatVectorData

Returns:

a deep copy of the data.

instantiate

public static FloatVectorDataSparse instantiate(float[] valuesSI)

Instantiate a FloatVectorDataSparse from an array.

Parameters:

valuesSI - the (SI) values to store

Returns:

the FloatVectorDataSparse

incrementBy

public final void incrementBy(FloatVectorData right)
                       throws ValueException

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

Specified by:

incrementBy in class FloatVectorData

Parameters:

right - the other data object to add

Throws:

ValueException - if vectors have different lengths

decrementBy

public final void decrementBy(FloatVectorData right)
                       throws ValueException

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

Specified by:

decrementBy in class FloatVectorData

Parameters:

right - the other data object to subtract

Throws:

ValueException - if vectors have different lengths

multiplyBy

public final void multiplyBy(FloatVectorData right)
                      throws ValueException

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

Specified by:

multiplyBy in class FloatVectorData

Parameters:

right - the other data object to multiply with

Throws:

ValueException - if vectors have different lengths

divideBy

public final void divideBy(FloatVectorData right)
                    throws ValueException

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

Specified by:

divideBy in class FloatVectorData

Parameters:

right - the other data object to divide by

Throws:

ValueException - if vectors have different lengths

hashCode

public int hashCode()

Overrides:

hashCode in class FloatVectorData

equals

public boolean equals(Object obj)

Overrides:

equals in class FloatVectorData