org.djunits.value.vdouble.vector

Class LengthVector

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.vector.AbstractDoubleVector<U,R>

org.djunits.value.vdouble.vector.AbstractDoubleVectorRel<LengthUnit,LengthVector,MutableLengthVector,Length>

org.djunits.value.vdouble.vector.LengthVector

All Implemented Interfaces:

Serializable, Iterable<Length>, Relative, Value<LengthUnit>, DoubleVectorInterface<LengthUnit>

public class LengthVector
extends AbstractDoubleVectorRel<LengthUnit,LengthVector,MutableLengthVector,Length>

Immutable Relative Length Vector.

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

$LastChangedDate: 2015-09-29 14:14:28 +0200 (Tue, 29 Sep 2015) $, @version $Revision: 73 $, by $Author: pknoppers $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVectorRel

AbstractDoubleVectorRel.Itr

Field Summary

Fields inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVector

data

Constructor Summary

Constructors

Constructor and Description
LengthVector(double[] values, LengthUnit unit, StorageType storageType) Construct a new Relative Immutable Double LengthVector.
LengthVector(DoubleVectorData data, LengthUnit unit) Construct a new Relative Immutable Double LengthVector.
LengthVector(Length[] values, StorageType storageType) Construct a new Relative Immutable Double LengthVector.
LengthVector(List<Double> values, LengthUnit unit, StorageType storageType) Construct a new Relative Immutable Double LengthVector.
LengthVector(List<Length> values, StorageType storageType) Construct a new Relative Immutable Double LengthVector.
LengthVector(SortedMap<Integer,Double> values, LengthUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Double LengthVector.
LengthVector(SortedMap<Integer,Length> values, int length, StorageType storageType) Construct a new Relative Immutable Double LengthVector.

Method Summary

Modifier and Type	Method and Description
protected MutableLengthVector	instantiateMutableType(DoubleVectorData dvd, LengthUnit unit) Construct a new Relative Mutable DoubleVector of the right type.
protected Length	instantiateScalar(double value, LengthUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected LengthVector	instantiateType(DoubleVectorData dvd, LengthUnit unit) Construct a new Relative Immutable DoubleVector of the right type.
Length[]	toArray() Return an array of Length Scalars from this vector.
LengthVector	toDense() return a dense version of this vector.
LengthVector	toSparse() return a sparse version of this vector.

Methods inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVectorRel

checkUnit, checkUnit, checkUnit, divide, get, iterator, minus, mutable, plus, times

Methods inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVector

cardinality, checkIndex, checkSize, checkSize, equals, getData, getInUnit, getInUnit, getSI, getStorageType, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, size, toString, toString, toString, toString, zSum

Methods inherited from class org.djunits.value.AbstractValue

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative, setDisplayUnit

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

LengthVector

public LengthVector(double[] values,
                    LengthUnit unit,
                    StorageType storageType)
             throws ValueException

Construct a new Relative Immutable Double LengthVector.

Parameters:

values - double[]; the values of the entries in the new Relative Immutable Double LengthVector

unit - U; the unit of the new Relative Immutable Double LengthVector

storageType - the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values is null

LengthVector

public LengthVector(List<Double> values,
                    LengthUnit unit,
                    StorageType storageType)
             throws ValueException

Construct a new Relative Immutable Double LengthVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable Double LengthVector

unit - U; the unit of the new Relative Immutable Double LengthVector

storageType - the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values is null

LengthVector

public LengthVector(Length[] values,
                    StorageType storageType)
             throws ValueException

Construct a new Relative Immutable Double LengthVector.

Parameters:

values - DoubleScalar.Rel<U>[]; the values of the entries in the new Relative Immutable Double LengthVector

storageType - the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values has zero entries

LengthVector

public LengthVector(List<Length> values,
                    StorageType storageType)
             throws ValueException

Construct a new Relative Immutable Double LengthVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable Double LengthVector

storageType - the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values has zero entries

LengthVector

public LengthVector(SortedMap<Integer,Length> values,
                    int length,
                    StorageType storageType)
             throws ValueException

Construct a new Relative Immutable Double LengthVector.

Parameters:

values - DoubleScalar.Rel<U>[]; the values of the entries in the new Relative Sparse Mutable Double LengthVector

length - the size of the vector

storageType - the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values has zero entries

LengthVector

public LengthVector(SortedMap<Integer,Double> values,
                    LengthUnit unit,
                    int length,
                    StorageType storageType)
             throws ValueException

Construct a new Relative Immutable Double LengthVector.

Parameters:

values - Map; the map of indexes to values of the Relative Sparse Mutable Double LengthVector

unit - U; the unit of the new Relative Sparse Mutable Double LengthVector

length - the size of the vector

storageType - the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values is null

LengthVector

LengthVector(DoubleVectorData data,
             LengthUnit unit)

Construct a new Relative Immutable Double LengthVector.

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final LengthVector instantiateType(DoubleVectorData dvd,
                                             LengthUnit unit)

Construct a new Relative Immutable DoubleVector of the right type. Each extending class must implement this method.

Specified by:

instantiateType in class AbstractDoubleVectorRel<LengthUnit,LengthVector,MutableLengthVector,Length>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the DoubleVector of the right type

instantiateMutableType

protected final MutableLengthVector instantiateMutableType(DoubleVectorData dvd,
                                                           LengthUnit unit)

Construct a new Relative Mutable DoubleVector of the right type. Each extending class must implement this method.

Specified by:

instantiateMutableType in class AbstractDoubleVectorRel<LengthUnit,LengthVector,MutableLengthVector,Length>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final Length instantiateScalar(double value,
                                         LengthUnit unit)

Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<LengthUnit,LengthVector,MutableLengthVector,Length>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final LengthVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final LengthVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public Length[] toArray()

Return an array of Length Scalars from this vector.

Returns:

Length[]; an array of Length Scalars from this vector

Throws:

RuntimeException - wrapping a ValueException on error getting one of the values