org.djunits.value.vdouble.vector

Class ElectricalPotentialVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vdouble.vector.AbstractDoubleVectorRel<ElectricalPotentialUnit,ElectricalPotentialVector,MutableElectricalPotentialVector,ElectricalPotential>

org.djunits.value.vdouble.vector.ElectricalPotentialVector

All Implemented Interfaces:

Serializable, Iterable<ElectricalPotential>, Relative, Value<ElectricalPotentialUnit>, DoubleVectorInterface<ElectricalPotentialUnit>

public class ElectricalPotentialVector
extends AbstractDoubleVectorRel<ElectricalPotentialUnit,ElectricalPotentialVector,MutableElectricalPotentialVector,ElectricalPotential>

Immutable Double ElectricalPotentialVector, a vector of values with a ElectricalPotentialUnit.

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

AbstractDoubleVectorRel.Itr

Field Summary

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

data

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected MutableElectricalPotentialVector	instantiateMutableType(DoubleVectorData dvd, ElectricalPotentialUnit unit) Construct a new Relative Mutable DoubleVector of the right type.
protected ElectricalPotential	instantiateScalar(double value, ElectricalPotentialUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected ElectricalPotentialVector	instantiateType(DoubleVectorData dvd, ElectricalPotentialUnit unit) Construct a new Relative Immutable DoubleVector of the right type.
ElectricalPotential[]	toArray() Return an array of ElectricalPotential Scalars from this vector.
ElectricalPotentialVector	toDense() return a dense version of this vector.
ElectricalPotentialVector	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

ElectricalPotentialVector

public ElectricalPotentialVector(double[] values,
                                 ElectricalPotentialUnit unit,
                                 StorageType storageType)
                          throws ValueException

Construct a new Relative Immutable Double ElectricalPotentialVector.

Parameters:

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

unit - U; the unit of the new Relative Immutable Double ElectricalPotentialVector

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

Throws:

ValueException - when values is null

ElectricalPotentialVector

public ElectricalPotentialVector(List<Double> values,
                                 ElectricalPotentialUnit unit,
                                 StorageType storageType)
                          throws ValueException

Construct a new Relative Immutable Double ElectricalPotentialVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable Double ElectricalPotentialVector

unit - U; the unit of the new Relative Immutable Double ElectricalPotentialVector

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

Throws:

ValueException - when values is null

ElectricalPotentialVector

public ElectricalPotentialVector(ElectricalPotential[] values,
                                 StorageType storageType)
                          throws ValueException

Construct a new Relative Immutable Double ElectricalPotentialVector.

Parameters:

values - DoubleScalar.Rel<U>[]; the values of the entries in the new Relative Immutable Double ElectricalPotentialVector

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

Throws:

ValueException - when values has zero entries

ElectricalPotentialVector

public ElectricalPotentialVector(List<ElectricalPotential> values,
                                 StorageType storageType)
                          throws ValueException

Construct a new Relative Immutable Double ElectricalPotentialVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable Double ElectricalPotentialVector

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

Throws:

ValueException - when values has zero entries

ElectricalPotentialVector

public ElectricalPotentialVector(SortedMap<Integer,ElectricalPotential> values,
                                 int length,
                                 StorageType storageType)
                          throws ValueException

Construct a new Relative Immutable Double ElectricalPotentialVector.

Parameters:

values - DoubleScalar.Rel<U>[]; the values of the entries in the new Relative Sparse Mutable Double ElectricalPotentialVector

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

ElectricalPotentialVector

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

Construct a new Relative Immutable Double ElectricalPotentialVector.

Parameters:

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

unit - U; the unit of the new Relative Sparse Mutable Double ElectricalPotentialVector

length - the size of the vector

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

Throws:

ValueException - when values is null

ElectricalPotentialVector

ElectricalPotentialVector(DoubleVectorData data,
                          ElectricalPotentialUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final ElectricalPotentialVector instantiateType(DoubleVectorData dvd,
                                                          ElectricalPotentialUnit unit)

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

Specified by:

instantiateType in class AbstractDoubleVectorRel<ElectricalPotentialUnit,ElectricalPotentialVector,MutableElectricalPotentialVector,ElectricalPotential>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the DoubleVector of the right type

instantiateMutableType

protected final MutableElectricalPotentialVector instantiateMutableType(DoubleVectorData dvd,
                                                                        ElectricalPotentialUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleVectorRel<ElectricalPotentialUnit,ElectricalPotentialVector,MutableElectricalPotentialVector,ElectricalPotential>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final ElectricalPotential instantiateScalar(double value,
                                                      ElectricalPotentialUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<ElectricalPotentialUnit,ElectricalPotentialVector,MutableElectricalPotentialVector,ElectricalPotential>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final ElectricalPotentialVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final ElectricalPotentialVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public ElectricalPotential[] toArray()

Return an array of ElectricalPotential Scalars from this vector.

Returns:

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

Throws:

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