org.djunits.value.vfloat.vector

Class FloatVector<U extends Unit<U>>

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vfloat.vector.FloatVector<U>

Type Parameters:

U - Unit the unit for which this Vector will be created

All Implemented Interfaces:

Serializable, Value<U>, FloatVectorInterface<U>

Direct Known Subclasses:

FloatVector.Abs, FloatVector.Rel, MutableFloatVector

public abstract class FloatVector<U extends Unit<U>>
extends AbstractValue<U>
implements FloatVectorInterface<U>, Serializable

Immutable FloatVector.

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

$LastChangedDate: 2016-05-28 14:25:52 +0200 (Sat, 28 May 2016) $, @version $Revision: 202 $, by $Author: averbraeck $, initial version 30 Oct, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FloatVector.Abs<U extends Unit<U>> ABSOLUTE implementation of FloatVector.
static class	FloatVector.Rel<U extends Unit<U>> RELATIVE implementation of FloatVector.

Field Summary

Fields

Modifier and Type	Field and Description
protected FloatVectorData	data The stored data as an object, can be sparse or dense.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FloatVector(U unit) Construct a new Absolute Immutable FloatVector.

Method Summary

Modifier and Type	Method and Description
int	cardinality() Count the number of cells that have a non-zero value (ignores tolerance).
protected void	checkIndex(int index) Check that a provided index is valid.
protected void	checkSize(float[] other) Centralized size equality check.
protected void	checkSize(FloatVector<?> other) Centralized size equality check.
(package private) static <U extends Unit<U>> U	checkUnit(FloatScalar<U>[] dsArray) Check that a provided array can be used to create some descendant of a FloatVector, and return the Unit.
(package private) static <U extends Unit<U>,S extends FloatScalar<U>> U	checkUnit(List<S> dsList) Check that a provided list can be used to create some descendant of a FloatVector, and return the Unit.
(package private) static <U extends Unit<U>,S extends FloatScalar<U>> U	checkUnit(SortedMap<Integer,S> dsMap) Check that a provided Map can be used to create some descendant of a FloatVector.
boolean	equals(Object obj)
protected FloatVectorData	getData()
float	getInUnit(int index) Retrieve the value stored at a specified position in the original unit.
float	getInUnit(int index, U targetUnit) Retrieve the value stored at a specified position converted into a specified unit.
float	getSI(int index) Retrieve the value stored at a specified position in the standard SI unit.
StorageType	getStorageType() Return the StorageType (DENSE, SPARSE, etc.) for the stored Vector.
float[]	getValuesInUnit() Create a float[] array filled with the values in the original unit.
float[]	getValuesInUnit(U targetUnit) Create a float[] array filled with the values converted into a specified unit.
float[]	getValuesSI() Create a float[] array filled with the values in the standard SI unit.
int	hashCode()
(package private) static <U extends Unit<U>> FloatVector.Abs<U>	instantiateAbs(FloatVectorData dvData, U unit) Instantiate a vector based on the type of data.
(package private) static <U extends Unit<U>> FloatVector.Rel<U>	instantiateRel(FloatVectorData dvData, U unit) Instantiate a vector based on the type of data.
int	size() Retrieve the size of the vector.
String	toString()
String	toString(boolean verbose, boolean withUnit) Print this FloatVector with optional type and unit information.
String	toString(U displayUnit) Print this FloatVector with the values expressed in the specified unit.
String	toString(U displayUnit, boolean verbose, boolean withUnit) Print this FloatVector with the values expressed in the specified unit.
float	zSum() Compute the sum of all values of this vector.

Methods inherited from class org.djunits.value.AbstractValue

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.djunits.value.vfloat.vector.FloatVectorInterface

get, mutable, toDense, toSparse

Field Detail

data

protected FloatVectorData data

The stored data as an object, can be sparse or dense.

Constructor Detail

FloatVector

protected FloatVector(U unit)

Construct a new Absolute Immutable FloatVector.

Parameters:

unit - U; the unit of the new Absolute Immutable FloatVector

Method Detail

getData

protected final FloatVectorData getData()

Returns:

the internal data -- can only be used within package and by subclasses.

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

checkUnit

static <U extends Unit<U>> U checkUnit(FloatScalar<U>[] dsArray)
                                throws ValueException

Check that a provided array can be used to create some descendant of a FloatVector, and return the Unit.

Type Parameters:

U - the unit

Parameters:

dsArray - the array to check and get the unit for

Returns:

the unit of the object

Throws:

ValueException - when the array has length equal to 0

checkUnit

static <U extends Unit<U>,S extends FloatScalar<U>> U checkUnit(List<S> dsList)
                                                         throws ValueException

Check that a provided list can be used to create some descendant of a FloatVector, and return the Unit.

Type Parameters:

U - the unit

S - the scalar in the list

Parameters:

dsList - the list to check and get the unit for

Returns:

the unit of the object

Throws:

ValueException - when the array has length equal to 0

checkUnit

static <U extends Unit<U>,S extends FloatScalar<U>> U checkUnit(SortedMap<Integer,S> dsMap)
                                                         throws ValueException

Check that a provided Map can be used to create some descendant of a FloatVector.

Type Parameters:

U - Unit; the unit of the FloatScalar list

S - the scalar in the list

Parameters:

dsMap - the provided map

Returns:

List the provided list

Throws:

ValueException - when the list has size equal to 0

instantiateRel

static <U extends Unit<U>> FloatVector.Rel<U> instantiateRel(FloatVectorData dvData,
                                                             U unit)

Instantiate a vector based on the type of data.

Type Parameters:

U - the unit

Parameters:

dvData - the FloatVectorData

unit - the unit to use

Returns:

an instantiated vector

instantiateAbs

static <U extends Unit<U>> FloatVector.Abs<U> instantiateAbs(FloatVectorData dvData,
                                                             U unit)

Instantiate a vector based on the type of data.

Type Parameters:

U - the unit

Parameters:

dvData - the FloatVectorData

unit - the unit to use

Returns:

an instantiated vector

getValuesSI

public final float[] getValuesSI()

Create a float[] array filled with the values in the standard SI unit.

Specified by:

getValuesSI in interface FloatVectorInterface<U extends Unit<U>>

Returns:

float[]; array of values in the standard SI unit

getValuesInUnit

public final float[] getValuesInUnit()

Create a float[] array filled with the values in the original unit.

Specified by:

getValuesInUnit in interface FloatVectorInterface<U extends Unit<U>>

Returns:

float[]; the values in the original unit

getValuesInUnit

public final float[] getValuesInUnit(U targetUnit)

Create a float[] array filled with the values converted into a specified unit.

Specified by:

getValuesInUnit in interface FloatVectorInterface<U extends Unit<U>>

Parameters:

targetUnit - U; the unit into which the values are converted for use

Returns:

float[]; the values converted into the specified unit

size

public final int size()

Retrieve the size of the vector.

Specified by:

size in interface FloatVectorInterface<U extends Unit<U>>

Returns:

int; the size of the vector

checkIndex

protected final void checkIndex(int index)
                         throws ValueException

Check that a provided index is valid.

Parameters:

index - int; the value to check

Throws:

ValueException - when index is invalid

getSI

public final float getSI(int index)
                  throws ValueException

Retrieve the value stored at a specified position in the standard SI unit.

Specified by:

getSI in interface FloatVectorInterface<U extends Unit<U>>

Parameters:

index - int; index of the value to retrieve

Returns:

float; value at position index in the standard SI unit

Throws:

ValueException - when index out of range (index < 0 or index >= size())

getInUnit

public final float getInUnit(int index)
                      throws ValueException

Retrieve the value stored at a specified position in the original unit.

Specified by:

getInUnit in interface FloatVectorInterface<U extends Unit<U>>

Parameters:

index - int; index of the value to retrieve

Returns:

float; value at position index in the original unit

Throws:

ValueException - when index out of range (index < 0 or index >= size())

getInUnit

public final float getInUnit(int index,
                             U targetUnit)
                      throws ValueException

Retrieve the value stored at a specified position converted into a specified unit.

Specified by:

getInUnit in interface FloatVectorInterface<U extends Unit<U>>

Parameters:

index - int; index of the value to retrieve

targetUnit - U; the unit for the result

Returns:

float; value at position index converted into the specified unit

Throws:

ValueException - when index out of range (index < 0 or index >= size())

zSum

public final float zSum()

Compute the sum of all values of this vector.

Specified by:

zSum in interface FloatVectorInterface<U extends Unit<U>>

Returns:

float; the sum of all values of this vector

cardinality

public final int cardinality()

Count the number of cells that have a non-zero value (ignores tolerance).

Specified by:

cardinality in interface FloatVectorInterface<U extends Unit<U>>

Returns:

int; the number of cells having non-zero value

toString

public final String toString()

Specified by:

toString in interface FloatVectorInterface<U extends Unit<U>>

Overrides:

toString in class Object

Returns:

a String with the Vector, non-verbose, with the unit attached.

toString

public final String toString(U displayUnit)

Print this FloatVector with the values expressed in the specified unit.

Specified by:

toString in interface FloatVectorInterface<U extends Unit<U>>

Parameters:

displayUnit - U; the unit into which the values are converted for display

Returns:

String; printable string with the vector contents expressed in the specified unit

toString

public final String toString(boolean verbose,
                             boolean withUnit)

Print this FloatVector with optional type and unit information.

Specified by:

toString in interface FloatVectorInterface<U extends Unit<U>>

Parameters:

verbose - boolean; if true; include type info; if false; exclude type info

withUnit - boolean; if true; include the unit; of false; exclude the unit

Returns:

String; printable string with the vector contents

toString

public final String toString(U displayUnit,
                             boolean verbose,
                             boolean withUnit)

Print this FloatVector with the values expressed in the specified unit.

Specified by:

toString in interface FloatVectorInterface<U extends Unit<U>>

Parameters:

displayUnit - U; the unit into which the values are converted for display

verbose - boolean; if true; include type info; if false; exclude type info

withUnit - boolean; if true; include the unit; of false; exclude the unit

Returns:

String; printable string with the vector contents

checkSize

protected final void checkSize(FloatVector<?> other)
                        throws ValueException

Centralized size equality check.

Parameters:

other - FloatVector<?>; other FloatVector

Throws:

ValueException - when other is null, or vectors have unequal size

checkSize

protected final void checkSize(float[] other)
                        throws ValueException

Centralized size equality check.

Parameters:

other - float[]; array of float

Throws:

ValueException - when vectors have unequal size

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object