org.djunits.value.vfloat.vector

Class FloatElectricalCurrentVector

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vfloat.vector.AbstractFloatVector<U,R>

org.djunits.value.vfloat.vector.AbstractFloatVectorRel<ElectricalCurrentUnit,FloatElectricalCurrentVector,MutableFloatElectricalCurrentVector,FloatElectricalCurrent>

org.djunits.value.vfloat.vector.FloatElectricalCurrentVector

All Implemented Interfaces:

Serializable, Iterable<FloatElectricalCurrent>, Relative, Value<ElectricalCurrentUnit>, FloatVectorInterface<ElectricalCurrentUnit>

public class FloatElectricalCurrentVector
extends AbstractFloatVectorRel<ElectricalCurrentUnit,FloatElectricalCurrentVector,MutableFloatElectricalCurrentVector,FloatElectricalCurrent>

Immutable Float FloatElectricalCurrentVector, a vector of values with a ElectricalCurrentUnit.

Copyright (c) 2013-2018 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.AbstractFloatVectorRel

AbstractFloatVectorRel.Itr

Field Summary

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

data

Constructor Summary

Constructors

Constructor and Description
FloatElectricalCurrentVector(float[] values, ElectricalCurrentUnit unit, StorageType storageType) Construct a new Relative Immutable Float FloatElectricalCurrentVector.
FloatElectricalCurrentVector(FloatElectricalCurrent[] values, StorageType storageType) Construct a new Relative Immutable Float FloatElectricalCurrentVector.
FloatElectricalCurrentVector(FloatVectorData data, ElectricalCurrentUnit unit)
FloatElectricalCurrentVector(List<Float> values, ElectricalCurrentUnit unit, StorageType storageType) Construct a new Relative Immutable Float FloatElectricalCurrentVector.
FloatElectricalCurrentVector(List<FloatElectricalCurrent> values, StorageType storageType) Construct a new Relative Immutable Float FloatElectricalCurrentVector.
FloatElectricalCurrentVector(SortedMap<Integer,Float> values, ElectricalCurrentUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Float FloatElectricalCurrentVector.
FloatElectricalCurrentVector(SortedMap<Integer,FloatElectricalCurrent> values, int length, StorageType storageType) Construct a new Relative Immutable Float FloatElectricalCurrentVector.

Method Summary

Modifier and Type	Method and Description
protected MutableFloatElectricalCurrentVector	instantiateMutableType(FloatVectorData dvd, ElectricalCurrentUnit unit) Construct a new Relative Mutable FloatVector of the right type.
protected FloatElectricalCurrent	instantiateScalar(float value, ElectricalCurrentUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
protected FloatElectricalCurrentVector	instantiateType(FloatVectorData dvd, ElectricalCurrentUnit unit) Construct a new Relative Immutable FloatVector of the right type.
FloatElectricalCurrent[]	toArray() Return an array of FloatElectricalCurrent Scalars from this vector.
FloatElectricalCurrentVector	toDense() return a dense version of this vector.
FloatElectricalCurrentVector	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

FloatElectricalCurrentVector

public FloatElectricalCurrentVector(float[] values,
                                    ElectricalCurrentUnit unit,
                                    StorageType storageType)
                             throws ValueException

Construct a new Relative Immutable Float FloatElectricalCurrentVector.

Parameters:

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

unit - U; the unit of the new Relative Immutable Float FloatElectricalCurrentVector

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

Throws:

ValueException - when values is null

FloatElectricalCurrentVector

public FloatElectricalCurrentVector(List<Float> values,
                                    ElectricalCurrentUnit unit,
                                    StorageType storageType)
                             throws ValueException

Construct a new Relative Immutable Float FloatElectricalCurrentVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable Float FloatElectricalCurrentVector

unit - U; the unit of the new Relative Immutable Float FloatElectricalCurrentVector

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

Throws:

ValueException - when values is null

FloatElectricalCurrentVector

public FloatElectricalCurrentVector(FloatElectricalCurrent[] values,
                                    StorageType storageType)
                             throws ValueException

Construct a new Relative Immutable Float FloatElectricalCurrentVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatElectricalCurrentVector

public FloatElectricalCurrentVector(List<FloatElectricalCurrent> values,
                                    StorageType storageType)
                             throws ValueException

Construct a new Relative Immutable Float FloatElectricalCurrentVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable Float FloatElectricalCurrentVector

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

Throws:

ValueException - when values has zero entries

FloatElectricalCurrentVector

public FloatElectricalCurrentVector(SortedMap<Integer,FloatElectricalCurrent> values,
                                    int length,
                                    StorageType storageType)
                             throws ValueException

Construct a new Relative Immutable Float FloatElectricalCurrentVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

FloatElectricalCurrentVector

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

Construct a new Relative Immutable Float FloatElectricalCurrentVector.

Parameters:

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

unit - U; the unit of the new Relative Sparse Mutable Float FloatElectricalCurrentVector

length - the size of the vector

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

Throws:

ValueException - when values is null

FloatElectricalCurrentVector

FloatElectricalCurrentVector(FloatVectorData data,
                             ElectricalCurrentUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FloatElectricalCurrentVector instantiateType(FloatVectorData dvd,
                                                             ElectricalCurrentUnit unit)

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

Specified by:

instantiateType in class AbstractFloatVectorRel<ElectricalCurrentUnit,FloatElectricalCurrentVector,MutableFloatElectricalCurrentVector,FloatElectricalCurrent>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the FloatVector of the right type

instantiateMutableType

protected final MutableFloatElectricalCurrentVector instantiateMutableType(FloatVectorData dvd,
                                                                           ElectricalCurrentUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatVectorRel<ElectricalCurrentUnit,FloatElectricalCurrentVector,MutableFloatElectricalCurrentVector,FloatElectricalCurrent>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable FloatVector of the right type

instantiateScalar

protected final FloatElectricalCurrent instantiateScalar(float value,
                                                         ElectricalCurrentUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatVectorRel<ElectricalCurrentUnit,FloatElectricalCurrentVector,MutableFloatElectricalCurrentVector,FloatElectricalCurrent>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatElectricalCurrentVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatElectricalCurrentVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FloatElectricalCurrent[] toArray()

Return an array of FloatElectricalCurrent Scalars from this vector.

Returns:

FloatElectricalCurrent[]; an array of FloatElectricalCurrent Scalars from this vector

Throws:

RuntimeException - wrapping a ValueException on error getting one of the values