org.djunits.value.vfloat.vector

Class MutableFloatDirectionVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

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

org.djunits.value.vfloat.vector.MutableFloatVector.Abs<U>

org.djunits.value.vfloat.vector.MutableTypedFloatVectorAbs<AngleUnit,FloatDirectionVector,FloatAngleVector,MutableFloatDirectionVector,FloatDirection>

org.djunits.value.vfloat.vector.MutableFloatDirectionVector

All Implemented Interfaces:

Serializable, Absolute, FunctionsAbs<AngleUnit,FloatVector.Abs<AngleUnit>,FloatVector.Rel<AngleUnit>>, MathFunctionsAbs<MutableFloatVector.Abs<AngleUnit>>, Value<AngleUnit>, FloatMathFunctions<MutableFloatVector.Abs<AngleUnit>>, FloatVectorInterface<AngleUnit>, MutableFloatVectorInterface<AngleUnit>

public class MutableFloatDirectionVector
extends MutableTypedFloatVectorAbs<AngleUnit,FloatDirectionVector,FloatAngleVector,MutableFloatDirectionVector,FloatDirection>

Mutable Absolute FloatDirection Vector a vector of values with a AngleUnit.

Copyright (c) 2013-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

$LastChangedDate: 2015-09-29 14:14:28 +0200 (Tue, 29 Sep 2015) $, @version $Revision: 73 $, by $Author: pknoppers $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

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

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

Field Summary

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

data

Fields inherited from interface org.djunits.value.vfloat.FloatMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH, TO_DEGREES, TO_RADIANS

Constructor Summary

Constructors

Constructor and Description
MutableFloatDirectionVector(float[] values, AngleUnit unit, StorageType storageType) Construct a new Absolute Mutable FloatDirectionVector.
MutableFloatDirectionVector(FloatDirection[] values, StorageType storageType) Construct a new Absolute Mutable FloatDirectionVector.
MutableFloatDirectionVector(FloatVectorData data, AngleUnit unit) Construct a new Absolute Mutable FloatDirectionVector.
MutableFloatDirectionVector(List<Float> values, AngleUnit unit, StorageType storageType) Construct a new Absolute Mutable FloatDirectionVector.
MutableFloatDirectionVector(List<FloatDirection> values, StorageType storageType) Construct a new Absolute Mutable FloatDirectionVector.
MutableFloatDirectionVector(SortedMap<Integer,Float> values, AngleUnit unit, int length, StorageType storageType) Construct a new Absolute Mutable FloatDirectionVector.
MutableFloatDirectionVector(SortedMap<Integer,FloatDirection> values, int length, StorageType storageType) Construct a new Absolute Mutable FloatDirectionVector.

Method Summary

Modifier and Type	Method and Description
FloatDirection	get(int index) Retrieve the value stored at a specified index as a FloatScalar.
protected MutableFloatDirectionVector	instantiateMutableType(FloatVectorData dvd, AngleUnit unit) Construct a new Absolute Mutable FloatVector of the right type.
protected FloatDirectionVector	instantiateTypeAbs(FloatVectorData dvd, AngleUnit unit) Construct a new Absolute Immutable FloatVector of the right type.
protected FloatAngleVector	instantiateTypeRel(FloatVectorData dvd, AngleUnit unit) Construct a new Relative Immutable FloatVector of the right type.
MutableFloatAngleVector	toRel() Translate the absolute vector into a relative vector (e.g., before or after a multiplication or division).

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

ceil, copy, divideBy, floor, immutable, multiplyBy, mutable, rint, round, toDense, toSparse

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

decrementBy, decrementBy, decrementBy, divideBy, divideBy, incrementBy, incrementBy, incrementBy, minus, minus, multiplyBy, multiplyBy, plus

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

assign, checkCopyOnWrite, instantiateMutableAbs, normalize, set, setCopyOnWrite, setInUnit, setSI

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

cardinality, checkIndex, checkSize, checkSize, checkUnit, checkUnit, checkUnit, equals, getData, getInUnit, getInUnit, getSI, getStorageType, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, instantiateAbs, instantiateRel, 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

Methods inherited from interface org.djunits.value.vfloat.FloatMathFunctions

DIV, MULT, POW

Methods inherited from interface org.djunits.value.vfloat.vector.FloatVectorInterface

cardinality, getInUnit, getInUnit, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, size, toString, toString, toString, toString, zSum

Constructor Detail

MutableFloatDirectionVector

public MutableFloatDirectionVector(float[] values,
                                   AngleUnit unit,
                                   StorageType storageType)
                            throws ValueException

Construct a new Absolute Mutable FloatDirectionVector.

Parameters:

values - float[]; the values of the entries in the new Absolute Mutable FloatDirectionVector

unit - U; the unit of the new Absolute Mutable FloatDirectionVector

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

Throws:

ValueException - when values is null

MutableFloatDirectionVector

public MutableFloatDirectionVector(List<Float> values,
                                   AngleUnit unit,
                                   StorageType storageType)
                            throws ValueException

Construct a new Absolute Mutable FloatDirectionVector.

Parameters:

values - List; the values of the entries in the new Absolute Mutable FloatDirectionVector

unit - U; the unit of the new Absolute Mutable FloatDirectionVector

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

Throws:

ValueException - when values is null

MutableFloatDirectionVector

public MutableFloatDirectionVector(FloatDirection[] values,
                                   StorageType storageType)
                            throws ValueException

Construct a new Absolute Mutable FloatDirectionVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MutableFloatDirectionVector

public MutableFloatDirectionVector(List<FloatDirection> values,
                                   StorageType storageType)
                            throws ValueException

Construct a new Absolute Mutable FloatDirectionVector.

Parameters:

values - List; the values of the entries in the new Absolute Mutable FloatDirectionVector

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

Throws:

ValueException - when values has zero entries

MutableFloatDirectionVector

public MutableFloatDirectionVector(SortedMap<Integer,FloatDirection> values,
                                   int length,
                                   StorageType storageType)
                            throws ValueException

Construct a new Absolute Mutable FloatDirectionVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

MutableFloatDirectionVector

public MutableFloatDirectionVector(SortedMap<Integer,Float> values,
                                   AngleUnit unit,
                                   int length,
                                   StorageType storageType)
                            throws ValueException

Construct a new Absolute Mutable FloatDirectionVector.

Parameters:

values - Map; the map of indexes to values of the Absolute Sparse Mutable FloatDirectionVector

unit - U; the unit of the new Absolute Sparse Mutable FloatDirectionVector

length - the size of the vector

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

Throws:

ValueException - when values is null

MutableFloatDirectionVector

MutableFloatDirectionVector(FloatVectorData data,
                            AngleUnit unit)

Construct a new Absolute Mutable FloatDirectionVector.

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateTypeAbs

protected final FloatDirectionVector instantiateTypeAbs(FloatVectorData dvd,
                                                        AngleUnit unit)

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

Specified by:

instantiateTypeAbs in class MutableTypedFloatVectorAbs<AngleUnit,FloatDirectionVector,FloatAngleVector,MutableFloatDirectionVector,FloatDirection>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable FloatVector of the right type

instantiateTypeRel

protected final FloatAngleVector instantiateTypeRel(FloatVectorData dvd,
                                                    AngleUnit unit)

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

Specified by:

instantiateTypeRel in class MutableTypedFloatVectorAbs<AngleUnit,FloatDirectionVector,FloatAngleVector,MutableFloatDirectionVector,FloatDirection>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable FloatVector of the right type

instantiateMutableType

protected final MutableFloatDirectionVector instantiateMutableType(FloatVectorData dvd,
                                                                   AngleUnit unit)

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

Specified by:

instantiateMutableType in class MutableTypedFloatVectorAbs<AngleUnit,FloatDirectionVector,FloatAngleVector,MutableFloatDirectionVector,FloatDirection>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable FloatVector of the right type

get

public final FloatDirection get(int index)
                         throws ValueException

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

Specified by:

get in interface FloatVectorInterface<AngleUnit>

Specified by:

get in class MutableTypedFloatVectorAbs<AngleUnit,FloatDirectionVector,FloatAngleVector,MutableFloatDirectionVector,FloatDirection>

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())

toRel

public final MutableFloatAngleVector toRel()

Translate the absolute vector into a relative vector (e.g., before or after a multiplication or division).

Returns:

a relative version of this absolute FloatDirection vector.