org.djunits.value.vfloat.vector

Class FloatElectricalPotentialVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vfloat.vector.AbstractFloatVectorRel<ElectricalPotentialUnit,FloatElectricalPotentialVector,MutableFloatElectricalPotentialVector,FloatElectricalPotential>

org.djunits.value.vfloat.vector.FloatElectricalPotentialVector

All Implemented Interfaces:

Serializable, Iterable<FloatElectricalPotential>, Relative, Value<ElectricalPotentialUnit>, FloatVectorInterface<ElectricalPotentialUnit>

public class FloatElectricalPotentialVector
extends AbstractFloatVectorRel<ElectricalPotentialUnit,FloatElectricalPotentialVector,MutableFloatElectricalPotentialVector,FloatElectricalPotential>

Immutable Float FloatElectricalPotentialVector, a vector of values with a ElectricalPotentialUnit.

Copyright (c) 2013-2019 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
FloatElectricalPotentialVector(float[] values, ElectricalPotentialUnit unit, StorageType storageType) Construct a new Relative Immutable Float FloatElectricalPotentialVector.
FloatElectricalPotentialVector(FloatElectricalPotential[] values, StorageType storageType) Construct a new Relative Immutable Float FloatElectricalPotentialVector.
FloatElectricalPotentialVector(FloatVectorData data, ElectricalPotentialUnit unit)
FloatElectricalPotentialVector(List<Float> values, ElectricalPotentialUnit unit, StorageType storageType) Construct a new Relative Immutable Float FloatElectricalPotentialVector.
FloatElectricalPotentialVector(List<FloatElectricalPotential> values, StorageType storageType) Construct a new Relative Immutable Float FloatElectricalPotentialVector.
FloatElectricalPotentialVector(SortedMap<Integer,Float> values, ElectricalPotentialUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Float FloatElectricalPotentialVector.
FloatElectricalPotentialVector(SortedMap<Integer,FloatElectricalPotential> values, int length, StorageType storageType) Construct a new Relative Immutable Float FloatElectricalPotentialVector.

Method Summary

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

FloatElectricalPotentialVector

public FloatElectricalPotentialVector(float[] values,
                                      ElectricalPotentialUnit unit,
                                      StorageType storageType)
                               throws ValueException

Construct a new Relative Immutable Float FloatElectricalPotentialVector.

Parameters:

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

unit - ElectricalPotentialUnit; the unit of the new Relative Immutable Float FloatElectricalPotentialVector

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

Throws:

ValueException - when values is null

FloatElectricalPotentialVector

public FloatElectricalPotentialVector(List<Float> values,
                                      ElectricalPotentialUnit unit,
                                      StorageType storageType)
                               throws ValueException

Construct a new Relative Immutable Float FloatElectricalPotentialVector.

Parameters:

values - List<Float>; the values of the entries in the new Relative Immutable Float FloatElectricalPotentialVector

unit - ElectricalPotentialUnit; the unit of the new Relative Immutable Float FloatElectricalPotentialVector

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

Throws:

ValueException - when values is null

FloatElectricalPotentialVector

public FloatElectricalPotentialVector(FloatElectricalPotential[] values,
                                      StorageType storageType)
                               throws ValueException

Construct a new Relative Immutable Float FloatElectricalPotentialVector.

Parameters:

values - FloatElectricalPotential[]; the values of the entries in the new Relative Immutable Float FloatElectricalPotentialVector

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

Throws:

ValueException - when values has zero entries

FloatElectricalPotentialVector

public FloatElectricalPotentialVector(List<FloatElectricalPotential> values,
                                      StorageType storageType)
                               throws ValueException

Construct a new Relative Immutable Float FloatElectricalPotentialVector.

Parameters:

values - List<FloatElectricalPotential>; the values of the entries in the new Relative Immutable Float FloatElectricalPotentialVector

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

Throws:

ValueException - when values has zero entries

FloatElectricalPotentialVector

public FloatElectricalPotentialVector(SortedMap<Integer,FloatElectricalPotential> values,
                                      int length,
                                      StorageType storageType)
                               throws ValueException

Construct a new Relative Immutable Float FloatElectricalPotentialVector.

Parameters:

values - SortedMap<Integer, FloatElectricalPotential>; the values of the entries in the new Relative Sparse Mutable Float FloatElectricalPotentialVector

length - int; the size of the vector

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

Throws:

ValueException - when values has zero entries

FloatElectricalPotentialVector

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

Construct a new Relative Immutable Float FloatElectricalPotentialVector.

Parameters:

values - SortedMap<Integer, Float>; the map of indexes to values of the Relative Sparse Mutable Float FloatElectricalPotentialVector

unit - ElectricalPotentialUnit; the unit of the new Relative Sparse Mutable Float FloatElectricalPotentialVector

length - int; the size of the vector

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

Throws:

ValueException - when values is null

FloatElectricalPotentialVector

FloatElectricalPotentialVector(FloatVectorData data,
                               ElectricalPotentialUnit unit)

Parameters:

data - FloatVectorData; an internal data object

unit - ElectricalPotentialUnit; the unit

Method Detail

instantiateType

protected final FloatElectricalPotentialVector instantiateType(FloatVectorData dvd,
                                                               ElectricalPotentialUnit unit)

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

Specified by:

instantiateType in class AbstractFloatVectorRel<ElectricalPotentialUnit,FloatElectricalPotentialVector,MutableFloatElectricalPotentialVector,FloatElectricalPotential>

Parameters:

dvd - FloatVectorData; an internal data object

unit - U; the unit

Returns:

R the FloatVector of the right type

instantiateMutableType

protected final MutableFloatElectricalPotentialVector instantiateMutableType(FloatVectorData dvd,
                                                                             ElectricalPotentialUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatVectorRel<ElectricalPotentialUnit,FloatElectricalPotentialVector,MutableFloatElectricalPotentialVector,FloatElectricalPotential>

Parameters:

dvd - FloatVectorData; an internal data object

unit - U; the unit

Returns:

MR the Mutable FloatVector of the right type

instantiateScalar

protected final FloatElectricalPotential instantiateScalar(float value,
                                                           ElectricalPotentialUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatVectorRel<ElectricalPotentialUnit,FloatElectricalPotentialVector,MutableFloatElectricalPotentialVector,FloatElectricalPotential>

Parameters:

value - float; the value

unit - U; the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatElectricalPotentialVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatElectricalPotentialVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FloatElectricalPotential[] toArray()

Return an array of FloatElectricalPotential Scalars from this vector.

Returns:

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

Throws:

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