Package org.djunits.value.vdouble.vector.base

Class AbstractDoubleVector<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

java.lang.Object

org.djunits.value.AbstractValue<U,T>

org.djunits.value.AbstractIndexedValue<U,S,V,DoubleVectorData>

org.djunits.value.vdouble.vector.base.AbstractDoubleVector<U,S,V>

Type Parameters:

U - the unit

S - the scalar with unit U

V - the generic vector type

All Implemented Interfaces:

Serializable, Cloneable, Iterable<S>, Vector<U,S,V>, ValueFunctions<U,V>, IndexedValue<U,S,V>, Value<U,V>, DoubleVectorInterface<U,S,V>

Direct Known Subclasses:

AbstractDoubleVectorAbs, AbstractDoubleVectorRel

public abstract class AbstractDoubleVector<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>
extends AbstractIndexedValue<U,S,V,DoubleVectorData>
implements DoubleVectorInterface<U,S,V>

The most basic abstract class for the DoubleVector.

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

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractDoubleVector.Itr	The iterator class is loosely based in AbstractList.Itr.

Nested classes/interfaces inherited from interface org.djunits.value.base.Vector

Vector.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar<AU,A>,AV extends Vector.Abs<AU,A,AV,RU,R,RV>,RU extends Unit<RU>,R extends Scalar<RU,R>,RV extends Vector.RelWithAbs<AU,A,AV,RU,R,RV>>, Vector.Rel<U extends Unit<U>,S extends Scalar<U,S>,RV extends Vector.Rel<U,S,RV>>, Vector.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar<AU,A>,AV extends Vector.Abs<AU,A,AV,RU,R,RV>,RU extends Unit<RU>,R extends Scalar<RU,R>,RV extends Vector.RelWithAbs<AU,A,AV,RU,R,RV>>

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
AbstractDoubleVector(DoubleVectorData data, U unit)	Construct a new AbstractDoubleVector.

Method Summary

Modifier and Type	Method	Description
V	abs()	Return a new Scalar/Vector/Matrix with absolute value(s).
V	assign(DoubleFunction doubleFunction)	Execute a function on a cell by cell basis.
V	ceil()	Return a new Scalar/Vector/Matrix with the nearest integer value(s) above the current value(s).
protected void	checkIndex(int index)	Check that a provided index is valid.
protected void	checkSize(DoubleVectorInterface<?,?,?> other)	Centralized size equality check.
boolean	equals(Object obj)
V	floor()	Return a new Scalar/Vector/Matrix with the nearest integer value(s) below the current value(s).
S	get(int index)	Retrieve a value from the vector.
protected DoubleVectorData	getData()	Retrieve the data object.
double	getInUnit(int index)	Retrieve the value stored at a specified position in the original unit.
double	getInUnit(int index, U targetUnit)	Retrieve the value stored at a specified position converted into a specified unit.
S[]	getScalars()	Return the vector as an array of scalars.
double	getSI(int index)	Retrieve the value stored at a specified position in the standard SI unit.
double[]	getValuesInUnit()	Create a double[] array filled with the values in the original unit.
double[]	getValuesInUnit(U targetUnit)	Create a double[] array filled with the values converted into a specified unit.
double[]	getValuesSI()	Create a double[] array filled with the values in the standard SI unit.
int	hashCode()
Iterator<S>	iterator()	Create and return an iterator over the scalars in this vector in proper sequence.
V	neg()	Return a new Scalar/Vector/Matrix with negated value(s).
V	rint()	Return a new Scalar/Vector/Matrix with the nearest integer value(s).
void	set(int index, S value)	Set the scalar value at the specified position.
protected void	setData(DoubleVectorData data)	Set the data object.
void	setInUnit(int index, double valueInUnit)	Set the value, specified in the (current) display unit, at the specified position.
void	setInUnit(int index, double valueInUnit, U valueUnit)	Set the value, specified in the valueUnit, at the specified position.
void	setSI(int index, double valueSI)	Set the value, specified in the standard SI unit, at the specified position.
int	size()	Retrieve the size of the vector.
V	toDense()	Create and return a dense version of this internal storage.
V	toSparse()	Create and return a sparse version of this internal storage.
String	toString()	Concise description of this value.
String	toString(boolean verbose, boolean withUnit)	Somewhat verbose description of this value with optional type and unit information.
String	toString(U displayUnit)	Somewhat verbose description of this value with the values expressed in the specified unit.
String	toString(U displayUnit, boolean verbose, boolean withUnit)	Somewhat verbose description of this value with the values expressed in the specified unit.

Methods inherited from class org.djunits.value.AbstractIndexedValue

cardinality, checkCopyOnWrite, clone, getStorageType, immutable, isCopyOnWrite, isDense, isMutable, isSparse, mutable, setCopyOnWrite, setMutable

Methods inherited from class org.djunits.value.AbstractValue

getDisplayUnit, isAbsolute, isRelative, setDisplayUnit

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.djunits.value.vdouble.vector.base.DoubleVectorInterface

instantiateScalarSI, instantiateVector

Methods inherited from interface org.djunits.value.IndexedValue

cardinality, getScalarClass, getStorageType, immutable, isDense, isMutable, isSparse, mutable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.djunits.value.Value

getDisplayUnit, isAbsolute, isRelative, setDisplayUnit

Field Detail

data

protected DoubleVectorData data

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

Constructor Detail

AbstractDoubleVector

AbstractDoubleVector(DoubleVectorData data,
                     U unit)

Construct a new AbstractDoubleVector.

Parameters:

data - DoubleVectorData; an internal data object

unit - U; the unit

Method Detail

getData

protected final DoubleVectorData getData()

Retrieve the data object. Method can only be used within package and by subclasses.

Specified by:

getData in class AbstractIndexedValue<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,DoubleVectorData>

Returns:

D; the internal data

setData

protected void setData(DoubleVectorData data)

Set the data object. Method can only be used within package and by subclasses.

Specified by:

setData in class AbstractIndexedValue<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>,DoubleVectorData>

Parameters:

data - D; the internal data

getValuesSI

public final double[] getValuesSI()

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

Specified by:

getValuesSI in interface DoubleVectorInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

Returns:

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

getValuesInUnit

public final double[] getValuesInUnit()

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

Specified by:

getValuesInUnit in interface DoubleVectorInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

Returns:

double[]; the values in the original unit

getValuesInUnit

public final double[] getValuesInUnit(U targetUnit)

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

Specified by:

getValuesInUnit in interface DoubleVectorInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

Parameters:

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

Returns:

double[]; the values converted into the specified unit

size

public final int size()

Retrieve the size of the vector.

Specified by:

size in interface Vector<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

Returns:

int; the size of the vector

checkIndex

protected final void checkIndex(int index)
                         throws ValueRuntimeException

Check that a provided index is valid.

Parameters:

index - int; the value to check

Throws:

ValueRuntimeException - when index is invalid

getSI

public final double getSI(int index)
                   throws ValueRuntimeException

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

Specified by:

getSI in interface DoubleVectorInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

Parameters:

index - int; index of the value to retrieve

Returns:

double; value at position index in the standard SI unit

Throws:

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

get

public S get(int index)
      throws ValueRuntimeException

Retrieve a value from the vector.

Specified by:

get in interface Vector<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

Parameters:

index - int; the index to retrieve the value at

Returns:

S; the value as a Scalar

Throws:

ValueRuntimeException - in case index is out of bounds

getInUnit

public final double getInUnit(int index)
                       throws ValueRuntimeException

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

Specified by:

getInUnit in interface DoubleVectorInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

Parameters:

index - int; index of the value to retrieve

Returns:

double; value at position index in the original unit

Throws:

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

getInUnit

public final double getInUnit(int index,
                              U targetUnit)
                       throws ValueRuntimeException

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

Specified by:

getInUnit in interface DoubleVectorInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

Parameters:

index - int; index of the value to retrieve

targetUnit - U; the unit for the result

Returns:

double; value at position index converted into the specified unit

Throws:

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

setSI

public final void setSI(int index,
                        double valueSI)
                 throws ValueRuntimeException

Set the value, specified in the standard SI unit, at the specified position.

Specified by:

setSI in interface DoubleVectorInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

Parameters:

index - int; the index of the value to set

valueSI - double; the value, specified in the standard SI unit

Throws:

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

setInUnit

public void setInUnit(int index,
                      double valueInUnit)
               throws ValueRuntimeException

Set the value, specified in the (current) display unit, at the specified position.

Specified by:

setInUnit in interface DoubleVectorInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

Parameters:

index - int; the index of the value to set

valueInUnit - double; the value, specified in the (current) display unit

Throws:

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

setInUnit

public void setInUnit(int index,
                      double valueInUnit,
                      U valueUnit)
               throws ValueRuntimeException

Set the value, specified in the valueUnit, at the specified position.

Specified by:

setInUnit in interface DoubleVectorInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

Parameters:

index - int; the index of the value to set

valueInUnit - double; the value, specified in the (current) display unit

valueUnit - U; the unit in which the valueInUnit is expressed

Throws:

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

set

public void set(int index,
                S value)
         throws ValueRuntimeException

Set the scalar value at the specified position.

Specified by:

set in interface DoubleVectorInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

Parameters:

index - int; the index of the value to set

value - S; the value to set

Throws:

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

getScalars

public S[] getScalars()

Return the vector as an array of scalars.

Specified by:

getScalars in interface Vector<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

Returns:

S[]; the vector as an array of scalars

toSparse

public V toSparse()

Create and return a sparse version of this internal storage. When the data was already sparse, the current version is returned and no copy will be made of the data.

Specified by:

toSparse in interface IndexedValue<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

Returns:

T; a sparse version of this internal storage

toDense

public V toDense()

Create and return a dense version of this internal storage. When the data was already dense, the current version is returned and no copy will be made of the data.

Specified by:

toDense in interface IndexedValue<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

Returns:

T; a dense version of this internal storage

assign

public final V assign(DoubleFunction doubleFunction)

Execute a function on a cell by cell basis. Note: May be expensive when used on sparse data.

Specified by:

assign in interface DoubleVectorInterface<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

Parameters:

doubleFunction - DoubleFunction; the function to apply

Returns:

V; this updated vector

abs

public final V abs()

Return a new Scalar/Vector/Matrix with absolute value(s).

Specified by:

abs in interface ValueFunctions<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>>

Returns:

R; a new R with absolute value(s)

ceil

public final V ceil()

Return a new Scalar/Vector/Matrix with the nearest integer value(s) above the current value(s).

Specified by:

ceil in interface ValueFunctions<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>>

Returns:

R; a new R with absolute value(s)

floor

public final V floor()

Return a new Scalar/Vector/Matrix with the nearest integer value(s) below the current value(s).

Specified by:

floor in interface ValueFunctions<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>>

Returns:

R; a new R with absolute value(s)

neg

public final V neg()

Return a new Scalar/Vector/Matrix with negated value(s).

Specified by:

neg in interface ValueFunctions<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>>

Returns:

R; a new R with negated value(s)

rint

public final V rint()

Return a new Scalar/Vector/Matrix with the nearest integer value(s). When the value is exactly in the middle between two integer values, the even one is returned.

Specified by:

rint in interface ValueFunctions<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>>

Returns:

R; a new R with absolute value(s)

toString

public String toString()

Concise description of this value.

Specified by:

toString in interface Value<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>>

Overrides:

toString in class Object

Returns:

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

toString

public String toString(U displayUnit)

Somewhat verbose description of this value with the values expressed in the specified unit.

Specified by:

toString in interface Value<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>>

Parameters:

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

Returns:

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

toString

public String toString(boolean verbose,
                       boolean withUnit)

Somewhat verbose description of this value with optional type and unit information.

Specified by:

toString in interface Value<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>>

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 value contents

toString

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

Somewhat verbose description of this value with the values expressed in the specified unit.

Specified by:

toString in interface Value<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>>

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 value contents

checkSize

protected final void checkSize(DoubleVectorInterface<?,?,?> other)
                        throws ValueRuntimeException

Centralized size equality check.

Parameters:

other - DoubleVectorInterface<?, ?, ?>; other DoubleVector

Throws:

NullPointerException - when other vector is null

ValueRuntimeException - 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

iterator

public Iterator<S> iterator()

Create and return an iterator over the scalars in this vector in proper sequence.

Specified by:

iterator in interface Iterable<U extends Unit<U>>

Specified by:

iterator in interface Vector<U extends Unit<U>,S extends AbstractDoubleScalar<U,S>,V extends AbstractDoubleVector<U,S,V>>

Returns:

Iterator<S>; an iterator over the scalars in this vector in proper sequence