org.djunits.value.vfloat.vector

Class FloatVectorData

java.lang.Object

org.djunits.value.vfloat.vector.FloatVectorData

Direct Known Subclasses:

FloatVectorDataDense, FloatVectorDataSparse

abstract class FloatVectorData
extends Object

Stores the data for a FloatVector 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

Modifier and Type	Field and Description
protected float[]	vectorSI the internal storage of the Vector; can be sparse or dense.

Constructor Summary

Constructors

Constructor and Description
FloatVectorData(StorageType storageType)

Method Summary

Modifier and Type	Method and Description
int	cardinality()
abstract FloatVectorData	copy()
void	decrementBy(float valueSI) Subtract a number from this vector on a cell-by-cell basis.
abstract void	decrementBy(FloatVectorData right) Subtract a vector from this vector on a cell-by-cell basis.
FloatVectorData	divide(FloatVectorData right) Divide two vectors on a cell-by-cell basis.
void	divideBy(float valueSI) Divide the values of this vector by a number on a cell-by-cell basis.
abstract 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)
abstract float[]	getDenseVectorSI()
abstract float	getSI(int index)
StorageType	getStorageType() Return the StorageType (DENSE, SPARSE, etc.) for the stored Vector.
int	hashCode()
void	incrementBy(float valueSI) Add a number to this vector on a cell-by-cell basis.
abstract void	incrementBy(FloatVectorData right) Add a vector to this vector on a cell-by-cell basis.
static FloatVectorData	instantiate(float[] values, Scale scale, StorageType storageType) Instantiate a FloatVectorData with the right data type.
static FloatVectorData	instantiate(FloatScalarInterface[] values, StorageType storageType) Instantiate a FloatVectorData with the right data type.
static FloatVectorData	instantiate(List<Float> values, Scale scale, StorageType storageType) Instantiate a FloatVectorData with the right data type.
static FloatVectorData	instantiate(SortedMap<Integer,Float> values, int length, Scale scale, StorageType storageType) Instantiate a FloatVectorData with the right data type.
static FloatVectorData	instantiateLD(List<? extends FloatScalarInterface> values, StorageType storageType) Instantiate a FloatVectorData with the right data type.
static <S extends FloatScalarInterface> FloatVectorData	instantiateMD(SortedMap<Integer,S> values, int length, StorageType storageType) Instantiate a FloatVectorData with the right data type.
boolean	isDense()
boolean	isSparse()
FloatVectorData	minus(FloatVectorData right) Subtract two vectors on a cell-by-cell basis.
void	multiplyBy(float valueSI) Multiply the values of this vector with a number on a cell-by-cell basis.
abstract void	multiplyBy(FloatVectorData right) Multiply a vector with the values of another vector on a cell-by-cell basis.
FloatVectorData	plus(FloatVectorData right) Add two vectors on a cell-by-cell basis.
abstract void	setSI(int index, float valueSI) Sets a value at the index in the vector.
abstract int	size()
FloatVectorData	times(FloatVectorData right) Multiply two vector on a cell-by-cell basis.
FloatVectorDataDense	toDense()
FloatVectorDataSparse	toSparse()
String	toString()
float	zSum()

Methods inherited from class java.lang.Object

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

Field Detail

vectorSI

protected float[] vectorSI

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

Constructor Detail

FloatVectorData

FloatVectorData(StorageType storageType)

Parameters:

storageType - the data type.

Method Detail

instantiate

public static FloatVectorData instantiate(float[] values,
                                          Scale scale,
                                          StorageType storageType)
                                   throws ValueException

Instantiate a FloatVectorData with the right data type.

Parameters:

values - the (SI) values to store

scale - the scale of the unit to use for conversion to SI

storageType - the data type to use

Returns:

the FloatVectorData with the right data type

Throws:

ValueException - when values are null, or storageType is null

instantiate

public static FloatVectorData instantiate(List<Float> values,
                                          Scale scale,
                                          StorageType storageType)
                                   throws ValueException

Instantiate a FloatVectorData with the right data type.

Parameters:

values - the values to store

scale - the scale of the unit to use for conversion to SI

storageType - the data type to use

Returns:

the FloatVectorData with the right data type

Throws:

ValueException - when list is null, or storageType is null

instantiate

public static FloatVectorData instantiate(FloatScalarInterface[] values,
                                          StorageType storageType)
                                   throws ValueException

Instantiate a FloatVectorData with the right data type.

Parameters:

values - the values to store

storageType - the data type to use

Returns:

the FloatVectorData with the right data type

Throws:

ValueException - when values is null, or storageType is null

instantiateLD

public static FloatVectorData instantiateLD(List<? extends FloatScalarInterface> values,
                                            StorageType storageType)
                                     throws ValueException

Instantiate a FloatVectorData with the right data type.

Parameters:

values - the FloatScalar values to store

storageType - the data type to use

Returns:

the FloatVectorData with the right data type

Throws:

ValueException - when values is null, or storageType is null

instantiateMD

public static <S extends FloatScalarInterface> FloatVectorData instantiateMD(SortedMap<Integer,S> values,
                                                                             int length,
                                                                             StorageType storageType)
                                                                      throws ValueException

Instantiate a FloatVectorData with the right data type.

Type Parameters:

S - the scalar type to use

Parameters:

values - the FloatScalar values to store

length - the length of the vector to pad with 0 after last entry in map

storageType - the data type to use

Returns:

the FloatVectorData with the right data type

Throws:

ValueException - when values is null, or storageType is null

instantiate

public static FloatVectorData instantiate(SortedMap<Integer,Float> values,
                                          int length,
                                          Scale scale,
                                          StorageType storageType)
                                   throws ValueException

Instantiate a FloatVectorData with the right data type.

Parameters:

values - the FloatScalar values to store

length - the length of the vector to pad with 0 after last entry in map

scale - the scale of the unit to use for conversion to SI

storageType - the data type to use

Returns:

the FloatVectorData with the right data type

Throws:

ValueException - when values is null, or storageType is null

getStorageType

public final StorageType getStorageType()

Return the StorageType (DENSE, SPARSE, etc.) for the stored Vector.

Returns:

the StorageType (DENSE, SPARSE, etc.) for the stored Vector

size

public abstract int size()

Returns:

the size of the vector

isSparse

public boolean isSparse()

Returns:

whether data type is sparse.

toSparse

public FloatVectorDataSparse toSparse()

Returns:

the sparse transformation of this data

isDense

public boolean isDense()

Returns:

whether data type is dense.

toDense

public FloatVectorDataDense toDense()

Returns:

the dense transformation of this data

getSI

public abstract float getSI(int index)

Parameters:

index - the index to get the value for

Returns:

the value at the index

setSI

public abstract void setSI(int index,
                           float 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

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.

copy

public abstract FloatVectorData copy()

Returns:

a deep copy of the data.

getDenseVectorSI

public abstract float[] getDenseVectorSI()

Returns:

a safe copy of VectorSI

plus

public FloatVectorData plus(FloatVectorData 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

incrementBy

public abstract 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.

Parameters:

right - the other data object to add

Throws:

ValueException - if vectors have different lengths

incrementBy

public void incrementBy(float valueSI)

Add a number to this vector on a cell-by-cell basis.

Parameters:

valueSI - the value to add

minus

public FloatVectorData minus(FloatVectorData 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

decrementBy

public abstract 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.

Parameters:

right - the other data object to subtract

Throws:

ValueException - if vectors have different lengths

decrementBy

public void decrementBy(float valueSI)

Subtract a number from this vector on a cell-by-cell basis.

Parameters:

valueSI - the value to subtract

times

public FloatVectorData times(FloatVectorData 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

multiplyBy

public abstract 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.

Parameters:

right - the other data object to multiply with

Throws:

ValueException - if vectors have different lengths

multiplyBy

public void multiplyBy(float valueSI)

Multiply the values of this vector with a number on a cell-by-cell basis.

Parameters:

valueSI - the value to multiply with

divide

public FloatVectorData divide(FloatVectorData 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

divideBy

public abstract 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.

Parameters:

right - the other data object to divide by

Throws:

ValueException - if vectors have different lengths

divideBy

public void divideBy(float valueSI)

Divide the values of this vector by a number on a cell-by-cell basis.

Parameters:

valueSI - the value to multiply with

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object