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.DoubleVector<U>

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

Type Parameters:

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

All Implemented Interfaces:

Serializable, FunctionsRel<U,DoubleVector.Abs<U>,DoubleVector.Rel<U>>, Relative, Value<U>, DoubleVectorInterface<U>

Direct Known Subclasses:

TypedDoubleVectorRel

Enclosing class:

DoubleVector<U extends Unit<U>>

public static class DoubleVector.Rel<U extends Unit<U>>
extends DoubleVector<U>
implements Relative, FunctionsRel<U,DoubleVector.Abs<U>,DoubleVector.Rel<U>>

RELATIVE implementation of DoubleVector.

See Also:

Serialized Form

Nested Class Summary

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

DoubleVector.Abs<U extends Unit<U>>, DoubleVector.Rel<U extends Unit<U>>

Field Summary

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

data

Constructor Summary

Constructors

Constructor and Description
Rel(double[] values, U unit, StorageType storageType) Construct a new Relative Immutable DoubleVector.
Rel(DoubleScalar.Rel<U>[] values, StorageType storageType) Construct a new Relative Immutable DoubleVector.
Rel(DoubleVectorData data, U unit) Construct a new Relative Immutable DoubleVector.
Rel(List<Double> values, U unit, StorageType storageType) Construct a new Relative Immutable DoubleVector.
Rel(List<S> values, StorageType storageType) Construct a new Relative Immutable DoubleVector.
Rel(SortedMap<Integer,Double> values, U unit, int length, StorageType storageType) Construct a new Relative Immutable DoubleVector.
Rel(SortedMap<Integer,S> values, int length, StorageType storageType) Construct a new Relative Immutable DoubleVector.

Method Summary

Modifier and Type	Method and Description
DoubleVector.Rel<U>	divide(DoubleVector.Rel<U> rel) Divide this Relative value by a Relative value for a vector or matrix.
DoubleScalar.Rel<U>	get(int index) Retrieve the value stored at a specified index as a DoubleScalar.
DoubleVector.Rel<U>	minus(DoubleVector.Rel<U> rel) Subtract a Relative value from this Relative value for a vector or matrix.
MutableDoubleVector.Rel<U>	mutable() Create a mutable version of this DoubleVector.
DoubleVector.Abs<U>	plus(DoubleVector.Abs<U> abs) Add an Absolute value to this Relative value for a vector or matrix.
DoubleVector.Rel<U>	plus(DoubleVector.Rel<U> rel) Add a Relative value to this Relative value for a vector or matrix.
DoubleVector.Rel<U>	times(DoubleVector.Rel<U> rel) Multiply a Relative value by this Relative value for a vector or matrix.
DoubleVector.Rel<U>	toDense() Create a dense version of this DoubleVector.
DoubleVector.Rel<U>	toSparse() Create a sparse version of this DoubleVector.

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

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

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

Constructor Detail

Rel

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

Construct a new Relative Immutable DoubleVector.

Parameters:

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

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

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 Immutable DoubleVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable DoubleVector

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

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 Immutable DoubleVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

Rel

public Rel(List<S> values,
           StorageType storageType)
    throws ValueException

Construct a new Relative Immutable DoubleVector.

Type Parameters:

S - the Scalar type used

Parameters:

values - List; the values of the entries in the new Relative Immutable DoubleVector

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

Throws:

ValueException - when values has zero entries

Rel

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

Construct a new Relative Immutable DoubleVector.

Type Parameters:

S - the Scalar type used

Parameters:

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

length - the size of the vector

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 Immutable DoubleVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

Rel

Rel(DoubleVectorData data,
    U unit)

Construct a new Relative Immutable DoubleVector.

Parameters:

data - an internal data object

unit - the unit

Method Detail

mutable

public MutableDoubleVector.Rel<U> mutable()

Create a mutable version of this DoubleVector.
The mutable version is created with a shallow copy of the data and the internal copyOnWrite flag set. The first operation in the mutable version that modifies the data shall trigger a deep copy of the data.

Specified by:

mutable in interface DoubleVectorInterface<U extends Unit<U>>

Returns:

MutableDoubleVector<U>; mutable version of this DoubleVector

toDense

public DoubleVector.Rel<U> toDense()

Create a dense version of this DoubleVector.

Specified by:

toDense in interface DoubleVectorInterface<U extends Unit<U>>

Returns:

DoubleVector<U>; dense version of this DoubleVector

toSparse

public DoubleVector.Rel<U> toSparse()

Create a sparse version of this DoubleVector.

Specified by:

toSparse in interface DoubleVectorInterface<U extends Unit<U>>

Returns:

DoubleVector<U>; sparse version of this DoubleVector

get

public DoubleScalar.Rel<U> get(int index)
                        throws ValueException

Retrieve the value stored at a specified index as a DoubleScalar.

Specified by:

get in interface DoubleVectorInterface<U extends Unit<U>>

Parameters:

index - int; index of the value to retrieve

Returns:

DoubleScalar<U>; the strongly typed value of the selected cell

Throws:

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

plus

public DoubleVector.Rel<U> plus(DoubleVector.Rel<U> rel)
                         throws ValueException

Add a Relative value to this Relative value for a vector or matrix. The addition is done value by value and the result is stored in a new Relative value. If both operands are sparse, the result is a sparse vector or matrix, otherwise the result is a dense vector or matrix.

Specified by:

plus in interface FunctionsRel<U extends Unit<U>,DoubleVector.Abs<U extends Unit<U>>,DoubleVector.Rel<U extends Unit<U>>>

Parameters:

rel - R the right operand

Returns:

A the sum of this vector and the operand

Throws:

ValueException - in case this vector or matrix and the operand have a different size

plus

public DoubleVector.Abs<U> plus(DoubleVector.Abs<U> abs)
                         throws ValueException

Add an Absolute value to this Relative value for a vector or matrix. The addition is done value by value and the result is stored in a new Absolute value. If both operands are sparse, the result is a sparse vector or matrix, otherwise the result is a dense vector or matrix.

Specified by:

plus in interface FunctionsRel<U extends Unit<U>,DoubleVector.Abs<U extends Unit<U>>,DoubleVector.Rel<U extends Unit<U>>>

Parameters:

abs - A the right operand

Returns:

A the sum of this vector and the operand

Throws:

ValueException - in case this vector or matrix and the operand have a different size

minus

public final DoubleVector.Rel<U> minus(DoubleVector.Rel<U> rel)
                                throws ValueException

Subtract a Relative value from this Relative value for a vector or matrix. The subtraction is done value by value and the result is stored in a new Relative value. If both operands are sparse, the result is a sparse vector or matrix, otherwise the result is a dense vector or matrix.

Specified by:

minus in interface FunctionsRel<U extends Unit<U>,DoubleVector.Abs<U extends Unit<U>>,DoubleVector.Rel<U extends Unit<U>>>

Parameters:

rel - R the right operand

Returns:

A the sum of this vector and the operand

Throws:

ValueException - in case this vector or matrix and the operand have a different size

times

public final DoubleVector.Rel<U> times(DoubleVector.Rel<U> rel)
                                throws ValueException

Multiply a Relative value by this Relative value for a vector or matrix. The multiplication is done value by value and the result is stored in a new Relative value. If both operands are dense, the result is a dense vector or matrix, otherwise the result is a sparse vector or matrix.

Specified by:

times in interface FunctionsRel<U extends Unit<U>,DoubleVector.Abs<U extends Unit<U>>,DoubleVector.Rel<U extends Unit<U>>>

Parameters:

rel - R the right operand

Returns:

A the sum of this vector and the operand

Throws:

ValueException - in case this vector or matrix and the operand have a different size

divide

public final DoubleVector.Rel<U> divide(DoubleVector.Rel<U> rel)
                                 throws ValueException

Divide this Relative value by a Relative value for a vector or matrix. The division is done value by value and the result is stored in a new Relative value. If both operands are dense, the result is a dense vector or matrix, otherwise the result is a sparse vector or matrix.

Specified by:

divide in interface FunctionsRel<U extends Unit<U>,DoubleVector.Abs<U extends Unit<U>>,DoubleVector.Rel<U extends Unit<U>>>

Parameters:

rel - R the right operand

Returns:

A the sum of this vector and the operand

Throws:

ValueException - in case this vector or matrix and the operand have a different size