org.djunits.value.vfloat.vector

Class FloatElectricalChargeVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vfloat.vector.AbstractFloatVectorRel<ElectricalChargeUnit,FloatElectricalChargeVector,MutableFloatElectricalChargeVector,FloatElectricalCharge>

org.djunits.value.vfloat.vector.FloatElectricalChargeVector

All Implemented Interfaces:

Serializable, Iterable<FloatElectricalCharge>, Relative, Value<ElectricalChargeUnit>, FloatVectorInterface<ElectricalChargeUnit>

public class FloatElectricalChargeVector
extends AbstractFloatVectorRel<ElectricalChargeUnit,FloatElectricalChargeVector,MutableFloatElectricalChargeVector,FloatElectricalCharge>

Immutable Float FloatElectricalChargeVector, a vector of values with a ElectricalChargeUnit.

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

Method Summary

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

FloatElectricalChargeVector

public FloatElectricalChargeVector(float[] values,
                                   ElectricalChargeUnit unit,
                                   StorageType storageType)
                            throws ValueException

Construct a new Relative Immutable Float FloatElectricalChargeVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatElectricalChargeVector

public FloatElectricalChargeVector(List<Float> values,
                                   ElectricalChargeUnit unit,
                                   StorageType storageType)
                            throws ValueException

Construct a new Relative Immutable Float FloatElectricalChargeVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatElectricalChargeVector

public FloatElectricalChargeVector(FloatElectricalCharge[] values,
                                   StorageType storageType)
                            throws ValueException

Construct a new Relative Immutable Float FloatElectricalChargeVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatElectricalChargeVector

public FloatElectricalChargeVector(List<FloatElectricalCharge> values,
                                   StorageType storageType)
                            throws ValueException

Construct a new Relative Immutable Float FloatElectricalChargeVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatElectricalChargeVector

public FloatElectricalChargeVector(SortedMap<Integer,FloatElectricalCharge> values,
                                   int length,
                                   StorageType storageType)
                            throws ValueException

Construct a new Relative Immutable Float FloatElectricalChargeVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

FloatElectricalChargeVector

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

Construct a new Relative Immutable Float FloatElectricalChargeVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

FloatElectricalChargeVector

FloatElectricalChargeVector(FloatVectorData data,
                            ElectricalChargeUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final FloatElectricalChargeVector instantiateType(FloatVectorData dvd,
                                                            ElectricalChargeUnit unit)

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

Specified by:

instantiateType in class AbstractFloatVectorRel<ElectricalChargeUnit,FloatElectricalChargeVector,MutableFloatElectricalChargeVector,FloatElectricalCharge>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the FloatVector of the right type

instantiateMutableType

protected final MutableFloatElectricalChargeVector instantiateMutableType(FloatVectorData dvd,
                                                                          ElectricalChargeUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatVectorRel<ElectricalChargeUnit,FloatElectricalChargeVector,MutableFloatElectricalChargeVector,FloatElectricalCharge>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable FloatVector of the right type

instantiateScalar

protected final FloatElectricalCharge instantiateScalar(float value,
                                                        ElectricalChargeUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatVectorRel<ElectricalChargeUnit,FloatElectricalChargeVector,MutableFloatElectricalChargeVector,FloatElectricalCharge>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable FloatScalar of the right type

toDense

public final FloatElectricalChargeVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final FloatElectricalChargeVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public FloatElectricalCharge[] toArray()

Return an array of FloatElectricalCharge Scalars from this vector.

Returns:

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

Throws:

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