org.djunits.value.vdouble.vector

Class DimensionlessVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vdouble.vector.AbstractDoubleVectorRel<DimensionlessUnit,DimensionlessVector,MutableDimensionlessVector,Dimensionless>

org.djunits.value.vdouble.vector.DimensionlessVector

All Implemented Interfaces:

Serializable, Iterable<Dimensionless>, Relative, Value<DimensionlessUnit>, DoubleVectorInterface<DimensionlessUnit>

public class DimensionlessVector
extends AbstractDoubleVectorRel<DimensionlessUnit,DimensionlessVector,MutableDimensionlessVector,Dimensionless>

Immutable Double DimensionlessVector, a vector of values with a DimensionlessUnit.

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 9, 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
DimensionlessVector(Dimensionless[] values, StorageType storageType) Construct a new Relative Immutable Double DimensionlessVector.
DimensionlessVector(double[] values, DimensionlessUnit unit, StorageType storageType) Construct a new Relative Immutable Double DimensionlessVector.
DimensionlessVector(DoubleVectorData data, DimensionlessUnit unit)
DimensionlessVector(List<Dimensionless> values, StorageType storageType) Construct a new Relative Immutable Double DimensionlessVector.
DimensionlessVector(List<Double> values, DimensionlessUnit unit, StorageType storageType) Construct a new Relative Immutable Double DimensionlessVector.
DimensionlessVector(SortedMap<Integer,Dimensionless> values, int length, StorageType storageType) Construct a new Relative Immutable Double DimensionlessVector.
DimensionlessVector(SortedMap<Integer,Double> values, DimensionlessUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Double DimensionlessVector.

Method Summary

Modifier and Type	Method and Description
protected MutableDimensionlessVector	instantiateMutableType(DoubleVectorData dvd, DimensionlessUnit unit) Construct a new Relative Mutable DoubleVector of the right type.
protected Dimensionless	instantiateScalar(double value, DimensionlessUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected DimensionlessVector	instantiateType(DoubleVectorData dvd, DimensionlessUnit unit) Construct a new Relative Immutable DoubleVector of the right type.
Dimensionless[]	toArray() Return an array of Dimensionless Scalars from this vector.
DimensionlessVector	toDense() return a dense version of this vector.
DimensionlessVector	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

DimensionlessVector

public DimensionlessVector(double[] values,
                           DimensionlessUnit unit,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable Double DimensionlessVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

DimensionlessVector

public DimensionlessVector(List<Double> values,
                           DimensionlessUnit unit,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable Double DimensionlessVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

DimensionlessVector

public DimensionlessVector(Dimensionless[] values,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable Double DimensionlessVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

DimensionlessVector

public DimensionlessVector(List<Dimensionless> values,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable Double DimensionlessVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

DimensionlessVector

public DimensionlessVector(SortedMap<Integer,Dimensionless> values,
                           int length,
                           StorageType storageType)
                    throws ValueException

Construct a new Relative Immutable Double DimensionlessVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

DimensionlessVector

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

Construct a new Relative Immutable Double DimensionlessVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

DimensionlessVector

DimensionlessVector(DoubleVectorData data,
                    DimensionlessUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final DimensionlessVector instantiateType(DoubleVectorData dvd,
                                                    DimensionlessUnit unit)

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

Specified by:

instantiateType in class AbstractDoubleVectorRel<DimensionlessUnit,DimensionlessVector,MutableDimensionlessVector,Dimensionless>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the DoubleVector of the right type

instantiateMutableType

protected final MutableDimensionlessVector instantiateMutableType(DoubleVectorData dvd,
                                                                  DimensionlessUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleVectorRel<DimensionlessUnit,DimensionlessVector,MutableDimensionlessVector,Dimensionless>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final Dimensionless instantiateScalar(double value,
                                                DimensionlessUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<DimensionlessUnit,DimensionlessVector,MutableDimensionlessVector,Dimensionless>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final DimensionlessVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final DimensionlessVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public Dimensionless[] toArray()

Return an array of Dimensionless Scalars from this vector.

Returns:

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

Throws:

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