org.djunits.value.vdouble.vector

Class PowerVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vdouble.vector.AbstractDoubleVectorRel<PowerUnit,PowerVector,MutablePowerVector,Power>

org.djunits.value.vdouble.vector.PowerVector

All Implemented Interfaces:

Serializable, Iterable<Power>, Relative, Value<PowerUnit>, DoubleVectorInterface<PowerUnit>

public class PowerVector
extends AbstractDoubleVectorRel<PowerUnit,PowerVector,MutablePowerVector,Power>

Immutable Double PowerVector, a vector of values with a PowerUnit.

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
PowerVector(double[] values, PowerUnit unit, StorageType storageType) Construct a new Relative Immutable Double PowerVector.
PowerVector(DoubleVectorData data, PowerUnit unit)
PowerVector(List<Double> values, PowerUnit unit, StorageType storageType) Construct a new Relative Immutable Double PowerVector.
PowerVector(List<Power> values, StorageType storageType) Construct a new Relative Immutable Double PowerVector.
PowerVector(Power[] values, StorageType storageType) Construct a new Relative Immutable Double PowerVector.
PowerVector(SortedMap<Integer,Double> values, PowerUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Double PowerVector.
PowerVector(SortedMap<Integer,Power> values, int length, StorageType storageType) Construct a new Relative Immutable Double PowerVector.

Method Summary

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

PowerVector

public PowerVector(double[] values,
                   PowerUnit unit,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double PowerVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

PowerVector

public PowerVector(List<Double> values,
                   PowerUnit unit,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double PowerVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

PowerVector

public PowerVector(Power[] values,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double PowerVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

PowerVector

public PowerVector(List<Power> values,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double PowerVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

PowerVector

public PowerVector(SortedMap<Integer,Power> values,
                   int length,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double PowerVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

PowerVector

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

Construct a new Relative Immutable Double PowerVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

PowerVector

PowerVector(DoubleVectorData data,
            PowerUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final PowerVector instantiateType(DoubleVectorData dvd,
                                            PowerUnit unit)

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

Specified by:

instantiateType in class AbstractDoubleVectorRel<PowerUnit,PowerVector,MutablePowerVector,Power>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the DoubleVector of the right type

instantiateMutableType

protected final MutablePowerVector instantiateMutableType(DoubleVectorData dvd,
                                                          PowerUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleVectorRel<PowerUnit,PowerVector,MutablePowerVector,Power>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final Power instantiateScalar(double value,
                                        PowerUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<PowerUnit,PowerVector,MutablePowerVector,Power>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final PowerVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final PowerVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public Power[] toArray()

Return an array of Power Scalars from this vector.

Returns:

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

Throws:

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