org.djunits.value.vfloat.vector

Class FloatPowerVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

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

org.djunits.value.vfloat.vector.TypedFloatVectorRel<PowerUnit,FloatPowerVector,MutableFloatPowerVector,FloatPower>

org.djunits.value.vfloat.vector.FloatPowerVector

All Implemented Interfaces:

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

public class FloatPowerVector
extends TypedFloatVectorRel<PowerUnit,FloatPowerVector,MutableFloatPowerVector,FloatPower>

Immutable FloatPowerVector, a vector of values with a PowerUnit.

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

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Oct 9, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

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
FloatPowerVector(float[] values, PowerUnit unit, StorageType storageType) Construct a new Relative Immutable FloatPowerVector.
FloatPowerVector(FloatPower[] values, StorageType storageType) Construct a new Relative Immutable FloatPowerVector.
FloatPowerVector(FloatVectorData data, PowerUnit unit)
FloatPowerVector(List<Float> values, PowerUnit unit, StorageType storageType) Construct a new Relative Immutable FloatPowerVector.
FloatPowerVector(List<FloatPower> values, StorageType storageType) Construct a new Relative Immutable FloatPowerVector.
FloatPowerVector(SortedMap<Integer,Float> values, PowerUnit unit, int length, StorageType storageType) Construct a new Relative Immutable FloatPowerVector.
FloatPowerVector(SortedMap<Integer,FloatPower> values, int length, StorageType storageType) Construct a new Relative Immutable FloatPowerVector.

Method Summary

Modifier and Type	Method and Description
FloatPower	get(int index) Retrieve the value stored at a specified index as a FloatScalar.
protected MutableFloatPowerVector	instantiateMutableType(FloatVectorData dvd, PowerUnit unit) Construct a new Relative Mutable FloatVector of the right type.
protected FloatPowerVector	instantiateType(FloatVectorData dvd, PowerUnit unit) Construct a new Relative Immutable FloatVector of the right type.

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

divide, minus, mutable, plus, times, toDense, toSparse

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, 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

Constructor Detail

FloatPowerVector

public FloatPowerVector(float[] values,
                        PowerUnit unit,
                        StorageType storageType)
                 throws ValueException

Construct a new Relative Immutable FloatPowerVector.

Parameters:

values - float[]; the values of the entries in the new Relative Immutable FloatPowerVector

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

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

Throws:

ValueException - when values is null

FloatPowerVector

public FloatPowerVector(List<Float> values,
                        PowerUnit unit,
                        StorageType storageType)
                 throws ValueException

Construct a new Relative Immutable FloatPowerVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable FloatPowerVector

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

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

Throws:

ValueException - when values is null

FloatPowerVector

public FloatPowerVector(FloatPower[] values,
                        StorageType storageType)
                 throws ValueException

Construct a new Relative Immutable FloatPowerVector.

Parameters:

values - FloatScalar.Rel<U>[]; the values of the entries in the new Relative Immutable Float FloatPowerVector

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

Throws:

ValueException - when values has zero entries

FloatPowerVector

public FloatPowerVector(List<FloatPower> values,
                        StorageType storageType)
                 throws ValueException

Construct a new Relative Immutable FloatPowerVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable FloatPowerVector

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

Throws:

ValueException - when values has zero entries

FloatPowerVector

public FloatPowerVector(SortedMap<Integer,FloatPower> values,
                        int length,
                        StorageType storageType)
                 throws ValueException

Construct a new Relative Immutable FloatPowerVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

FloatPowerVector

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

Construct a new Relative Immutable FloatPowerVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

FloatPowerVector

FloatPowerVector(FloatVectorData data,
                 PowerUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FloatPowerVector instantiateType(FloatVectorData dvd,
                                                 PowerUnit unit)

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

Specified by:

instantiateType in class TypedFloatVectorRel<PowerUnit,FloatPowerVector,MutableFloatPowerVector,FloatPower>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable FloatVector of the right type

instantiateMutableType

protected final MutableFloatPowerVector instantiateMutableType(FloatVectorData dvd,
                                                               PowerUnit unit)

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

Specified by:

instantiateMutableType in class TypedFloatVectorRel<PowerUnit,FloatPowerVector,MutableFloatPowerVector,FloatPower>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

M the Mutable FloatVector of the right type

get

public final FloatPower get(int index)
                     throws ValueException

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

Specified by:

get in interface FloatVectorInterface<PowerUnit>

Specified by:

get in class TypedFloatVectorRel<PowerUnit,FloatPowerVector,MutableFloatPowerVector,FloatPower>

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