org.djunits.value.vfloat.vector

Class FloatLengthVector.Rel

java.lang.Object

org.djunits.value.AbstractValue<U>

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

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

org.djunits.value.vfloat.vector.FloatLengthVector.Rel

All Implemented Interfaces:

Serializable, FunctionsRel<LengthUnit,FloatVector.Abs<LengthUnit>,FloatVector.Rel<LengthUnit>>, Relative, Value<LengthUnit>, FloatVectorInterface<LengthUnit>

Direct Known Subclasses:

FloatLengthVector.Rel.Dense, FloatLengthVector.Rel.Sparse

Enclosing interface:

FloatLengthVector

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

RELATIVE implementation of FloatLengthVector.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FloatLengthVector.Rel.Dense Float Dense Relative Immutable FloatLength class.
static class	FloatLengthVector.Rel.Sparse Float Sparse Relative Immutable FloatLength class.

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

Constructor and Description
Rel(LengthUnit unit)

Method Summary

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

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

divide, minus, plus, plus, times

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

Rel

public Rel(LengthUnit unit)

Parameters:

unit - the unit to use

Method Detail

mutable

public abstract MutableFloatLengthVector.Rel 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.Rel<LengthUnit>

Returns:

MutableFloatVector<U>; mutable version of this FloatVector

toDense

public abstract FloatLengthVector.Rel toDense()

Create a dense version of this FloatVector.

Specified by:

toDense in interface FloatVectorInterface<LengthUnit>

Specified by:

toDense in class FloatVector.Rel<LengthUnit>

Returns:

MutableFloatVector<U>; dense version of this FloatVector

toSparse

public abstract FloatLengthVector.Rel toSparse()

Create a sparse version of this FloatVector.

Specified by:

toSparse in interface FloatVectorInterface<LengthUnit>

Specified by:

toSparse in class FloatVector.Rel<LengthUnit>

Returns:

MutableFloatVector<U>; sparse version of this FloatVector

get

public final FloatLength.Rel 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.Rel<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.Rel plus(FloatLengthVector.Rel rel)
                                 throws ValueException

Add a Relative value to this Relative value for a vector or matrix. The addition is done value by value and store the result 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.

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.Rel minus(FloatLengthVector.Rel rel)
                                  throws ValueException

Subtract a Relative value from this Relative value for a vector or matrix. The subtraction is done value by value and store the result 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.

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

times

public final FloatLengthVector.Rel times(FloatLengthVector.Rel rel)
                                  throws ValueException

Multiply a Relative value with this Relative value for a vector or matrix. The multiplication is done value by value and store the result 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:

rel - the right operand

Returns:

the multiplication of this vector and the operand

Throws:

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

divide

public final FloatLengthVector.Rel divide(FloatLengthVector.Rel rel)
                                   throws ValueException

Divide this Relative value by a Relative value for a vector or matrix. The division is done value by value and store the result 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:

rel - the right operand

Returns:

the division of this vector and the operand

Throws:

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