org.djunits.value.vdouble.vector

Class ElectricalCurrentVector

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.vector.AbstractDoubleVector<U,R>

org.djunits.value.vdouble.vector.AbstractDoubleVectorRel<ElectricalCurrentUnit,ElectricalCurrentVector,MutableElectricalCurrentVector,ElectricalCurrent>

org.djunits.value.vdouble.vector.ElectricalCurrentVector

All Implemented Interfaces:

Serializable, Iterable<ElectricalCurrent>, Relative, Value<ElectricalCurrentUnit>, DoubleVectorInterface<ElectricalCurrentUnit>

public class ElectricalCurrentVector
extends AbstractDoubleVectorRel<ElectricalCurrentUnit,ElectricalCurrentVector,MutableElectricalCurrentVector,ElectricalCurrent>

Immutable Double ElectricalCurrentVector, a vector of values with a ElectricalCurrentUnit.

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.vdouble.vector.AbstractDoubleVectorRel

AbstractDoubleVectorRel.Itr

Field Summary

Fields inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVector

data

Constructor Summary

Constructors

Constructor and Description
ElectricalCurrentVector(double[] values, ElectricalCurrentUnit unit, StorageType storageType) Construct a new Relative Immutable Double ElectricalCurrentVector.
ElectricalCurrentVector(DoubleVectorData data, ElectricalCurrentUnit unit)
ElectricalCurrentVector(ElectricalCurrent[] values, StorageType storageType) Construct a new Relative Immutable Double ElectricalCurrentVector.
ElectricalCurrentVector(List<Double> values, ElectricalCurrentUnit unit, StorageType storageType) Construct a new Relative Immutable Double ElectricalCurrentVector.
ElectricalCurrentVector(List<ElectricalCurrent> values, StorageType storageType) Construct a new Relative Immutable Double ElectricalCurrentVector.
ElectricalCurrentVector(SortedMap<Integer,Double> values, ElectricalCurrentUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Double ElectricalCurrentVector.
ElectricalCurrentVector(SortedMap<Integer,ElectricalCurrent> values, int length, StorageType storageType) Construct a new Relative Immutable Double ElectricalCurrentVector.

Method Summary

Modifier and Type	Method and Description
protected MutableElectricalCurrentVector	instantiateMutableType(DoubleVectorData dvd, ElectricalCurrentUnit unit) Construct a new Relative Mutable DoubleVector of the right type.
protected ElectricalCurrent	instantiateScalar(double value, ElectricalCurrentUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected ElectricalCurrentVector	instantiateType(DoubleVectorData dvd, ElectricalCurrentUnit unit) Construct a new Relative Immutable DoubleVector of the right type.
ElectricalCurrent[]	toArray() Return an array of ElectricalCurrent Scalars from this vector.
ElectricalCurrentVector	toDense() return a dense version of this vector.
ElectricalCurrentVector	toSparse() return a sparse version of this vector.

Methods inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVectorRel

checkUnit, checkUnit, checkUnit, divide, get, iterator, minus, mutable, plus, times

Methods inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVector

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

ElectricalCurrentVector

public ElectricalCurrentVector(double[] values,
                               ElectricalCurrentUnit unit,
                               StorageType storageType)
                        throws ValueException

Construct a new Relative Immutable Double ElectricalCurrentVector.

Parameters:

values - double[]; the values of the entries in the new Relative Immutable Double ElectricalCurrentVector

unit - ElectricalCurrentUnit; the unit of the new Relative Immutable Double ElectricalCurrentVector

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

Throws:

ValueException - when values is null

ElectricalCurrentVector

public ElectricalCurrentVector(List<Double> values,
                               ElectricalCurrentUnit unit,
                               StorageType storageType)
                        throws ValueException

Construct a new Relative Immutable Double ElectricalCurrentVector.

Parameters:

values - List<Double>; the values of the entries in the new Relative Immutable Double ElectricalCurrentVector

unit - ElectricalCurrentUnit; the unit of the new Relative Immutable Double ElectricalCurrentVector

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

Throws:

ValueException - when values is null

ElectricalCurrentVector

public ElectricalCurrentVector(ElectricalCurrent[] values,
                               StorageType storageType)
                        throws ValueException

Construct a new Relative Immutable Double ElectricalCurrentVector.

Parameters:

values - ElectricalCurrent[]; the values of the entries in the new Relative Immutable Double ElectricalCurrentVector

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

Throws:

ValueException - when values has zero entries

ElectricalCurrentVector

public ElectricalCurrentVector(List<ElectricalCurrent> values,
                               StorageType storageType)
                        throws ValueException

Construct a new Relative Immutable Double ElectricalCurrentVector.

Parameters:

values - List<ElectricalCurrent>; the values of the entries in the new Relative Immutable Double ElectricalCurrentVector

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

Throws:

ValueException - when values has zero entries

ElectricalCurrentVector

public ElectricalCurrentVector(SortedMap<Integer,ElectricalCurrent> values,
                               int length,
                               StorageType storageType)
                        throws ValueException

Construct a new Relative Immutable Double ElectricalCurrentVector.

Parameters:

values - SortedMap<Integer, ElectricalCurrent>; the values of the entries in the new Relative Sparse Mutable Double ElectricalCurrentVector

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

ElectricalCurrentVector

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

Construct a new Relative Immutable Double ElectricalCurrentVector.

Parameters:

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

unit - ElectricalCurrentUnit; the unit of the new Relative Sparse Mutable Double ElectricalCurrentVector

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

ElectricalCurrentVector

ElectricalCurrentVector(DoubleVectorData data,
                        ElectricalCurrentUnit unit)

Parameters:

data - DoubleVectorData; an internal data object

unit - ElectricalCurrentUnit; the unit

Method Detail

instantiateType

protected final ElectricalCurrentVector instantiateType(DoubleVectorData dvd,
                                                        ElectricalCurrentUnit unit)

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

Specified by:

instantiateType in class AbstractDoubleVectorRel<ElectricalCurrentUnit,ElectricalCurrentVector,MutableElectricalCurrentVector,ElectricalCurrent>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - U; the unit

Returns:

R the DoubleVector of the right type

instantiateMutableType

protected final MutableElectricalCurrentVector instantiateMutableType(DoubleVectorData dvd,
                                                                      ElectricalCurrentUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleVectorRel<ElectricalCurrentUnit,ElectricalCurrentVector,MutableElectricalCurrentVector,ElectricalCurrent>

Parameters:

dvd - DoubleVectorData; an internal data object

unit - U; the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final ElectricalCurrent instantiateScalar(double value,
                                                    ElectricalCurrentUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<ElectricalCurrentUnit,ElectricalCurrentVector,MutableElectricalCurrentVector,ElectricalCurrent>

Parameters:

value - double; the value

unit - U; the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final ElectricalCurrentVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final ElectricalCurrentVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public ElectricalCurrent[] toArray()

Return an array of ElectricalCurrent Scalars from this vector.

Returns:

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

Throws:

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