org.djunits.value.vfloat.vector

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

java.lang.Object

org.djunits.value.AbstractValue<U>

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

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

Type Parameters:

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

All Implemented Interfaces:

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

Direct Known Subclasses:

FloatAccelerationVector, FloatLengthVector.Rel, FloatVector.Rel.Dense, FloatVector.Rel.Sparse

Enclosing class:

FloatVector<U extends Unit<U>>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FloatVector.Rel.Dense<U extends Unit<U>> RELATIVE DENSE implementation of FloatVector.
static class	FloatVector.Rel.Sparse<U extends Unit<U>> RELATIVE 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	Rel(U unit) Construct a new Relative Immutable FloatVector.

Method Summary

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

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

protected Rel(U unit)

Construct a new Relative Immutable FloatVector.

Parameters:

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

Method Detail

mutable

public abstract MutableFloatVector.Rel<U> 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<U extends Unit<U>>

Returns:

MutableFloatVector<U>; mutable version of this FloatVector

toDense

public abstract FloatVector.Rel<U> toDense()

Create a dense version of this FloatVector.

Specified by:

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

Returns:

MutableFloatVector<U>; dense version of this FloatVector

toSparse

public abstract FloatVector.Rel<U> toSparse()

Create a sparse version of this FloatVector.

Specified by:

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

Returns:

MutableFloatVector<U>; sparse version of this FloatVector

get

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

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

Specified by:

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

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 FloatVector.Rel<U> plus(FloatVector.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>,FloatVector.Abs<U extends Unit<U>>,FloatVector.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 FloatVector.Abs<U> plus(FloatVector.Abs<U> rel)
                        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>,FloatVector.Abs<U extends Unit<U>>,FloatVector.Rel<U extends Unit<U>>>

Parameters:

rel - 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 FloatVector.Rel<U> minus(FloatVector.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>,FloatVector.Abs<U extends Unit<U>>,FloatVector.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 FloatVector.Rel<U> times(FloatVector.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>,FloatVector.Abs<U extends Unit<U>>,FloatVector.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 FloatVector.Rel<U> divide(FloatVector.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>,FloatVector.Abs<U extends Unit<U>>,FloatVector.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