org.djunits.value.vdouble.vector

Class MutableElectricalChargeVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vdouble.vector.AbstractDoubleVectorRel<U,R,MR,S>

org.djunits.value.vdouble.vector.AbstractMutableDoubleVectorRel<ElectricalChargeUnit,ElectricalChargeVector,MutableElectricalChargeVector,ElectricalCharge>

org.djunits.value.vdouble.vector.MutableElectricalChargeVector

All Implemented Interfaces:

Serializable, Iterable<ElectricalCharge>, MathFunctionsAbs<MutableElectricalChargeVector>, MathFunctionsRel<MutableElectricalChargeVector>, Mutable, Relative, Value<ElectricalChargeUnit>, DoubleMathFunctions<MutableElectricalChargeVector>, DoubleVectorInterface<ElectricalChargeUnit>, MutableDoubleVectorInterface<ElectricalChargeUnit>

public class MutableElectricalChargeVector
extends AbstractMutableDoubleVectorRel<ElectricalChargeUnit,ElectricalChargeVector,MutableElectricalChargeVector,ElectricalCharge>

Mutable Double ElectricalChargeVector, 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.vdouble.vector.AbstractDoubleVectorRel

AbstractDoubleVectorRel.Itr

Field Summary

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

data

Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH

Constructor Summary

Constructors

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

Method Summary

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

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

abs, assign, ceil, checkCopyOnWrite, copy, decrementBy, decrementBy, decrementBy, divideBy, divideBy, divideBy, floor, immutable, incrementBy, incrementBy, incrementBy, multiplyBy, multiplyBy, multiplyBy, mutable, neg, normalize, rint, round, set, setCopyOnWrite, setInUnit, setSI

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

checkUnit, checkUnit, checkUnit, divide, get, iterator, minus, 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 org.djunits.value.vdouble.DoubleMathFunctions

DIV, MULT, POW

Methods inherited from interface org.djunits.value.vdouble.vector.DoubleVectorInterface

cardinality, get, getInUnit, getInUnit, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, size, toString, toString, toString, toString, zSum

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MutableElectricalChargeVector

public MutableElectricalChargeVector(double[] values,
                                     ElectricalChargeUnit unit,
                                     StorageType storageType)
                              throws ValueException

Construct a new Relative Immutable Double ElectricalChargeVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MutableElectricalChargeVector

public MutableElectricalChargeVector(List<Double> values,
                                     ElectricalChargeUnit unit,
                                     StorageType storageType)
                              throws ValueException

Construct a new Relative Immutable Double ElectricalChargeVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MutableElectricalChargeVector

public MutableElectricalChargeVector(ElectricalCharge[] values,
                                     StorageType storageType)
                              throws ValueException

Construct a new Relative Immutable Double ElectricalChargeVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MutableElectricalChargeVector

public MutableElectricalChargeVector(List<ElectricalCharge> values,
                                     StorageType storageType)
                              throws ValueException

Construct a new Relative Immutable Double ElectricalChargeVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MutableElectricalChargeVector

public MutableElectricalChargeVector(SortedMap<Integer,ElectricalCharge> values,
                                     int length,
                                     StorageType storageType)
                              throws ValueException

Construct a new Relative Immutable Double ElectricalChargeVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

MutableElectricalChargeVector

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

Construct a new Relative Immutable Double ElectricalChargeVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

MutableElectricalChargeVector

MutableElectricalChargeVector(DoubleVectorData data,
                              ElectricalChargeUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final ElectricalChargeVector instantiateType(DoubleVectorData dvd,
                                                       ElectricalChargeUnit unit)

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

Specified by:

instantiateType in class AbstractDoubleVectorRel<ElectricalChargeUnit,ElectricalChargeVector,MutableElectricalChargeVector,ElectricalCharge>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the DoubleVector of the right type

instantiateMutableType

protected final MutableElectricalChargeVector instantiateMutableType(DoubleVectorData dvd,
                                                                     ElectricalChargeUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleVectorRel<ElectricalChargeUnit,ElectricalChargeVector,MutableElectricalChargeVector,ElectricalCharge>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final ElectricalCharge instantiateScalar(double value,
                                                   ElectricalChargeUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<ElectricalChargeUnit,ElectricalChargeVector,MutableElectricalChargeVector,ElectricalCharge>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final MutableElectricalChargeVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final MutableElectricalChargeVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public ElectricalCharge[] toArray()

Return an array of ElectricalCharge Scalars from this vector.

Returns:

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

Throws:

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