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.AbstractFloatVector<U,R>

org.djunits.value.vfloat.vector.AbstractFloatVectorRel<U,FloatVector.Rel<U>,MutableFloatVector.Rel<U>,FloatScalar.Rel<U>>

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

Type Parameters:

U - Unit

All Implemented Interfaces:

Serializable, Iterable<FloatScalar.Rel<U>>, Relative, Value<U>, FloatVectorInterface<U>

Enclosing class:

FloatVector

public static class FloatVector.Rel<U extends Unit<U>>
extends AbstractFloatVectorRel<U,FloatVector.Rel<U>,MutableFloatVector.Rel<U>,FloatScalar.Rel<U>>

Relative Immutable FloatVector.

See Also:

Serialized Form

Nested Class Summary

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

AbstractFloatVectorRel.Itr

Field Summary

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

data

Constructor Summary

Constructors

Constructor and Description
Rel(float[] values, U unit, StorageType storageType) Construct a new Relative Mutable FloatVector.
Rel(FloatScalar.Rel<U>[] values, StorageType storageType) Construct a new Relative Mutable FloatVector.
Rel(FloatVectorData data, U unit) Construct a new Relative Mutable FloatVector.
Rel(List<Float> values, U unit, StorageType storageType) Construct a new Relative Mutable FloatVector.
Rel(List<FloatScalar.Rel<U>> values, StorageType storageType) Construct a new Relative Mutable FloatVector.
Rel(SortedMap<Integer,Float> values, U unit, int length, StorageType storageType) Construct a new Relative Mutable FloatVector.
Rel(SortedMap<Integer,FloatScalar.Rel<U>> values, int length, StorageType storageType) Construct a new Relative Mutable FloatVector.

Method Summary

Modifier and Type	Method and Description
protected MutableFloatVector.Rel<U>	instantiateMutableType(FloatVectorData dvd, U unit) Construct a new Relative Mutable FloatVector of the right type.
protected FloatScalar.Rel<U>	instantiateScalar(float value, U unit) Construct a new Relative Immutable FloatScalar of the right type.
protected FloatVector.Rel<U>	instantiateType(FloatVectorData dvd, U unit) Construct a new Relative Immutable FloatVector of the right type.
FloatVector.Rel<U>	toDense() return a dense version of this vector.
FloatVector.Rel<U>	toSparse() return a sparse version of this vector.

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

checkUnit, checkUnit, checkUnit, divide, get, iterator, minus, mutable, plus, times

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

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

Methods inherited from class org.djunits.value.AbstractValue

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative, setDisplayUnit

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Rel

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

Construct a new Relative Mutable FloatVector.

Parameters:

values - float[]; the values of the entries in the new Relative Mutable FloatVector

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

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

Throws:

ValueException - when values is null

Rel

public Rel(List<Float> values,
           U unit,
           StorageType storageType)
    throws ValueException

Construct a new Relative Mutable FloatVector.

Parameters:

values - List; the values of the entries in the new Relative Mutable FloatVector

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

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

Throws:

ValueException - when values is null

Rel

public Rel(FloatScalar.Rel<U>[] values,
           StorageType storageType)
    throws ValueException

Construct a new Relative Mutable FloatVector.

Parameters:

values - FloatScalar.Rel<U>[]; the values of the entries in the new Relative Mutable FloatVector

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

Throws:

ValueException - when values has zero entries

Rel

public Rel(List<FloatScalar.Rel<U>> values,
           StorageType storageType)
    throws ValueException

Construct a new Relative Mutable FloatVector.

Parameters:

values - List; the values of the entries in the new Relative Mutable FloatVector

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

Throws:

ValueException - when values has zero entries

Rel

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

Construct a new Relative Mutable FloatVector.

Parameters:

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

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,Float> values,
           U unit,
           int length,
           StorageType storageType)
    throws ValueException

Construct a new Relative Mutable FloatVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

Rel

public Rel(FloatVectorData data,
           U unit)

Construct a new Relative Mutable FloatVector.

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FloatVector.Rel<U> instantiateType(FloatVectorData dvd,
                                                   U unit)

Construct a new Relative Immutable FloatVector of the right type. Each extending class must implement this method.

Specified by:

instantiateType in class AbstractFloatVectorRel<U extends Unit<U>,FloatVector.Rel<U extends Unit<U>>,MutableFloatVector.Rel<U extends Unit<U>>,FloatScalar.Rel<U extends Unit<U>>>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the FloatVector of the right type

instantiateMutableType

protected final MutableFloatVector.Rel<U> instantiateMutableType(FloatVectorData dvd,
                                                                 U unit)

Construct a new Relative Mutable FloatVector of the right type. Each extending class must implement this method.

Specified by:

instantiateMutableType in class AbstractFloatVectorRel<U extends Unit<U>,FloatVector.Rel<U extends Unit<U>>,MutableFloatVector.Rel<U extends Unit<U>>,FloatScalar.Rel<U extends Unit<U>>>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable FloatVector of the right type

instantiateScalar

protected final FloatScalar.Rel<U> instantiateScalar(float value,
                                                     U unit)

Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateScalar in class AbstractFloatVectorRel<U extends Unit<U>,FloatVector.Rel<U extends Unit<U>>,MutableFloatVector.Rel<U extends Unit<U>>,FloatScalar.Rel<U extends Unit<U>>>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatVector.Rel<U> toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatVector.Rel<U> toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector