org.djunits.value.vdouble.vector

Class LengthVector.Abs

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vdouble.vector.DoubleVector.Abs<LengthUnit>

org.djunits.value.vdouble.vector.LengthVector.Abs

All Implemented Interfaces:

Serializable, Absolute, FunctionsAbs<LengthUnit,DoubleVector.Abs<LengthUnit>,DoubleVector.Rel<LengthUnit>>, Value<LengthUnit>, DoubleVectorInterface<LengthUnit>

Direct Known Subclasses:

LengthVector.Abs.Dense, LengthVector.Abs.Sparse

Enclosing interface:

LengthVector

public abstract static class LengthVector.Abs
extends DoubleVector.Abs<LengthUnit>

ABSOLUTE implementation of LengthVector.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LengthVector.Abs.Dense ABSOLUTE DENSE implementation of DoubleVector.
static class	LengthVector.Abs.Sparse ABSOLUTE SPARSE implementation of DoubleVector.

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

Modifier	Constructor and Description
protected	Abs(LengthUnit unit) Construct a new Absolute Immutable DoubleVector.

Method Summary

Modifier and Type	Method and Description
Length.Abs	get(int index) Retrieve the value stored at a specified index as a DoubleScalar.
LengthVector.Rel	minus(LengthVector.Abs abs) Subtract a Absolute value from this Absolute value for a vector or matrix.
LengthVector.Abs	minus(LengthVector.Rel rel) Subtract a Relative value from this Absolute value for a vector or matrix.
abstract MutableLengthVector.Abs	mutable() Create a mutable version of this DoubleVector.
LengthVector.Abs	plus(LengthVector.Rel rel) Add a Relative value to this Absolute value for a vector or matrix.
abstract LengthVector.Abs	toDense() Create a dense version of this DoubleVector.
abstract LengthVector.Abs	toSparse() Create a sparse version of this DoubleVector.

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

minus, minus, plus

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

cardinality, checkIndex, checkSize, checkSize, equals, getData, getInUnit, getInUnit, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, initializeSparse, initializeSparseMA, initializeSparseMR, safeGet, safeSet, 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

Abs

protected Abs(LengthUnit unit)

Construct a new Absolute Immutable DoubleVector.

Parameters:

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

Method Detail

mutable

public abstract MutableLengthVector.Abs 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<LengthUnit>

Specified by:

mutable in class DoubleVector.Abs<LengthUnit>

Returns:

MutableDoubleVector<U>; mutable version of this DoubleVector

toDense

public abstract LengthVector.Abs toDense()

Create a dense version of this DoubleVector.

Specified by:

toDense in interface DoubleVectorInterface<LengthUnit>

Specified by:

toDense in class DoubleVector.Abs<LengthUnit>

Returns:

MutableDoubleVector<U>; dense version of this DoubleVector

toSparse

public abstract LengthVector.Abs toSparse()

Create a sparse version of this DoubleVector.

Specified by:

toSparse in interface DoubleVectorInterface<LengthUnit>

Specified by:

toSparse in class DoubleVector.Abs<LengthUnit>

Returns:

MutableDoubleVector<U>; sparse version of this DoubleVector

get

public Length.Abs get(int index)
               throws ValueException

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

Specified by:

get in interface DoubleVectorInterface<LengthUnit>

Overrides:

get in class DoubleVector.Abs<LengthUnit>

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 final LengthVector.Abs plus(LengthVector.Rel rel)
                            throws ValueException

Add a Relative value to this Absolute 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.

Parameters:

rel - the right operand

Returns:

the addition of this vector and the operand

Throws:

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

minus

public final LengthVector.Abs minus(LengthVector.Rel rel)
                             throws ValueException

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

Parameters:

rel - the right operand

Returns:

the subtraction of this vector and the operand

Throws:

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

minus

public final LengthVector.Rel minus(LengthVector.Abs abs)
                             throws ValueException

Subtract a Absolute value from this Absolute 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 dense, the result is a dense vector or matrix, otherwise the result is a sparse vector or matrix.

Parameters:

abs - the right operand

Returns:

the subtraction of this vector and the operand

Throws:

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