org.djunits.value.vdouble.vector

Class DoubleVector.Rel<U extends Unit<U>>

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vdouble.vector.AbstractDoubleVectorRel<U,DoubleVector.Rel<U>,MutableDoubleVector.Rel<U>,DoubleScalar.Rel<U>>

org.djunits.value.vdouble.vector.DoubleVector.Rel<U>

Type Parameters:

U - Unit

All Implemented Interfaces:

Serializable, Iterable<DoubleScalar.Rel<U>>, Relative, Value<U>, DoubleVectorInterface<U>

Enclosing class:

DoubleVector

public static class DoubleVector.Rel<U extends Unit<U>>
extends AbstractDoubleVectorRel<U,DoubleVector.Rel<U>,MutableDoubleVector.Rel<U>,DoubleScalar.Rel<U>>

Relative Immutable DoubleVector.

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
Rel(double[] values, U unit, StorageType storageType) Construct a new Relative Mutable DoubleVector.
Rel(DoubleScalar.Rel<U>[] values, StorageType storageType) Construct a new Relative Mutable DoubleVector.
Rel(DoubleVectorData data, U unit) Construct a new Relative Mutable DoubleVector.
Rel(List<Double> values, U unit, StorageType storageType) Construct a new Relative Mutable DoubleVector.
Rel(List<DoubleScalar.Rel<U>> values, StorageType storageType) Construct a new Relative Mutable DoubleVector.
Rel(SortedMap<Integer,Double> values, U unit, int length, StorageType storageType) Construct a new Relative Mutable DoubleVector.
Rel(SortedMap<Integer,DoubleScalar.Rel<U>> values, int length, StorageType storageType) Construct a new Relative Mutable DoubleVector.

Method Summary

Modifier and Type	Method and Description
protected MutableDoubleVector.Rel<U>	instantiateMutableType(DoubleVectorData dvd, U unit) Construct a new Relative Mutable DoubleVector of the right type.
protected DoubleScalar.Rel<U>	instantiateScalar(double value, U unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected DoubleVector.Rel<U>	instantiateType(DoubleVectorData dvd, U unit) Construct a new Relative Immutable DoubleVector of the right type.
DoubleVector.Rel<U>	toDense() return a dense version of this vector.
DoubleVector.Rel<U>	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

Rel

public Rel(double[] values,
           U unit,
           StorageType storageType)
    throws ValueException

Construct a new Relative Mutable DoubleVector.

Parameters:

values - double[]; the values of the entries in the new Relative Mutable DoubleVector

unit - U; the unit of the new Relative Mutable DoubleVector

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

Throws:

ValueException - when values is null

Rel

public Rel(List<Double> values,
           U unit,
           StorageType storageType)
    throws ValueException

Construct a new Relative Mutable DoubleVector.

Parameters:

values - List<Double>; the values of the entries in the new Relative Mutable DoubleVector

unit - U; the unit of the new Relative Mutable DoubleVector

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

Throws:

ValueException - when values is null

Rel

public Rel(DoubleScalar.Rel<U>[] values,
           StorageType storageType)
    throws ValueException

Construct a new Relative Mutable DoubleVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

Rel

public Rel(List<DoubleScalar.Rel<U>> values,
           StorageType storageType)
    throws ValueException

Construct a new Relative Mutable DoubleVector.

Parameters:

values - List<DoubleScalar.Rel<U>>; the values of the entries in the new Relative Mutable DoubleVector

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

Throws:

ValueException - when values has zero entries

Rel

public Rel(SortedMap<Integer,DoubleScalar.Rel<U>> values,
           int length,
           StorageType storageType)
    throws ValueException

Construct a new Relative Mutable DoubleVector.

Parameters:

values - SortedMap<Integer, DoubleScalar.Rel<U>>; the values of the entries in the new Relative Sparse Mutable DoubleVector

length - int; the size of the vector

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

Throws:

ValueException - when values has zero entries

Rel

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

Construct a new Relative Mutable DoubleVector.

Parameters:

values - SortedMap<Integer, Double>; the map of indexes to values of the Relative Sparse Mutable DoubleVector

unit - U; the unit of the new Relative Sparse Mutable DoubleVector

length - int; the size of the vector

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

Throws:

ValueException - when values is null

Rel

public Rel(DoubleVectorData data,
           U unit)

Construct a new Relative Mutable DoubleVector.

Parameters:

data - DoubleVectorData; an internal data object

unit - U; the unit

Method Detail

instantiateType

protected final DoubleVector.Rel<U> instantiateType(DoubleVectorData dvd,
                                                    U unit)

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

Specified by:

instantiateType in class AbstractDoubleVectorRel<U extends Unit<U>,DoubleVector.Rel<U extends Unit<U>>,MutableDoubleVector.Rel<U extends Unit<U>>,DoubleScalar.Rel<U extends Unit<U>>>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - U; the unit

Returns:

R the DoubleVector of the right type

instantiateMutableType

protected final MutableDoubleVector.Rel<U> instantiateMutableType(DoubleVectorData dvd,
                                                                  U unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleVectorRel<U extends Unit<U>,DoubleVector.Rel<U extends Unit<U>>,MutableDoubleVector.Rel<U extends Unit<U>>,DoubleScalar.Rel<U extends Unit<U>>>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - U; the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final DoubleScalar.Rel<U> instantiateScalar(double value,
                                                      U unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<U extends Unit<U>,DoubleVector.Rel<U extends Unit<U>>,MutableDoubleVector.Rel<U extends Unit<U>>,DoubleScalar.Rel<U extends Unit<U>>>

Parameters:

value - double; the value

unit - U; the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final DoubleVector.Rel<U> toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final DoubleVector.Rel<U> toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector