org.djunits.value.vfloat.vector

Class FloatLengthVector.Abs

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vfloat.vector.FloatVector<U>

org.djunits.value.vfloat.vector.FloatVector.Abs<LengthUnit>

org.djunits.value.vfloat.vector.FloatLengthVector.Abs

All Implemented Interfaces:

Serializable, Absolute, FunctionsAbs<LengthUnit,FloatVector.Abs<LengthUnit>,FloatVector.Rel<LengthUnit>>, Value<LengthUnit>, FloatVectorInterface<LengthUnit>

Direct Known Subclasses:

FloatLengthVector.Abs.Dense, FloatLengthVector.Abs.Sparse

Enclosing interface:

FloatLengthVector

public abstract static class FloatLengthVector.Abs
extends FloatVector.Abs<LengthUnit>

ABSOLUTE implementation of FloatLengthVector.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.djunits.value.vfloat.vector.FloatVector

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

Field Summary

Fields inherited from class org.djunits.value.vfloat.vector.FloatVector

data

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class org.djunits.value.vfloat.vector.FloatVector.Abs

minus, minus, plus

Methods inherited from class org.djunits.value.vfloat.vector.FloatVector

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 FloatVector.

Parameters:

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

Method Detail

mutable

public abstract MutableFloatLengthVector.Abs mutable()

Create a mutable version of this FloatVector.
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 FloatVectorInterface<LengthUnit>

Specified by:

mutable in class FloatVector.Abs<LengthUnit>

Returns:

MutableFloatVector<U>; mutable version of this FloatVector

toDense

public abstract FloatLengthVector.Abs toDense()

Create a dense version of this FloatVector.

Specified by:

toDense in interface FloatVectorInterface<LengthUnit>

Specified by:

toDense in class FloatVector.Abs<LengthUnit>

Returns:

MutableFloatVector<U>; dense version of this FloatVector

toSparse

public abstract FloatLengthVector.Abs toSparse()

Create a sparse version of this FloatVector.

Specified by:

toSparse in interface FloatVectorInterface<LengthUnit>

Specified by:

toSparse in class FloatVector.Abs<LengthUnit>

Returns:

MutableFloatVector<U>; sparse version of this FloatVector

get

public FloatLength.Abs get(int index)
                    throws ValueException

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

Specified by:

get in interface FloatVectorInterface<LengthUnit>

Overrides:

get in class FloatVector.Abs<LengthUnit>

Parameters:

index - int; index of the value to retrieve

Returns:

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

Throws:

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

plus

public final FloatLengthVector.Abs plus(FloatLengthVector.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 FloatLengthVector.Abs minus(FloatLengthVector.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 FloatLengthVector.Rel minus(FloatLengthVector.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