org.djunits.value.vdouble.vector

Class MutableDimensionlessVector

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<DimensionlessUnit,DimensionlessVector,MutableDimensionlessVector,Dimensionless>

org.djunits.value.vdouble.vector.MutableDimensionlessVector

All Implemented Interfaces:

Serializable, Iterable<Dimensionless>, MathFunctionsAbs<MutableDimensionlessVector>, MathFunctionsDimensionless<MutableDimensionlessVector>, MathFunctionsRel<MutableDimensionlessVector>, Mutable, Relative, Value<DimensionlessUnit>, DoubleMathFunctions<MutableDimensionlessVector>, DoubleVectorInterface<DimensionlessUnit>, MutableDoubleVectorInterface<DimensionlessUnit>

public class MutableDimensionlessVector
extends AbstractMutableDoubleVectorRel<DimensionlessUnit,DimensionlessVector,MutableDimensionlessVector,Dimensionless>
implements MathFunctionsDimensionless<MutableDimensionlessVector>

Mutable Double DimensionlessVector, a vector of values with a DimensionlessUnit.

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

Method Summary

Modifier and Type	Method and Description
MutableDimensionlessVector	acos() Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.
MutableDimensionlessVector	asin() Set the value(s) to the arc sine of the value(s); the resulting angle is in the range -pi/2 through pi/2.
MutableDimensionlessVector	atan() Set the value(s) to the arc tangent of the value(s); the resulting angle is in the range -pi/2 through pi/2.
MutableDimensionlessVector	cbrt() Set the value(s) to the(ir) cube root.
MutableDimensionlessVector	cos() Set the value(s) to the trigonometric cosine of the value(s).
MutableDimensionlessVector	cosh() Set the value(s) to the hyperbolic cosine of the value(s).
MutableDimensionlessVector	exp() Set the value(s) to Euler's number e raised to the power of the value(s).
MutableDimensionlessVector	expm1() Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
protected MutableDimensionlessVector	instantiateMutableType(DoubleVectorData dvd, DimensionlessUnit unit) Construct a new Relative Mutable DoubleVector of the right type.
protected Dimensionless	instantiateScalar(double value, DimensionlessUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected DimensionlessVector	instantiateType(DoubleVectorData dvd, DimensionlessUnit unit) Construct a new Relative Immutable DoubleVector of the right type.
MutableDimensionlessVector	inv() Set the value(s) to the complement (1.0/x) of the value(s).
MutableDimensionlessVector	log() Set the value(s) to the natural logarithm (base e) of the value(s).
MutableDimensionlessVector	log10() Set the value(s) to the base 10 logarithm of the value(s).
MutableDimensionlessVector	log1p() Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
MutableDimensionlessVector	pow(double x) Set the value(s) to the value(s) raised to the power of the argument.
MutableDimensionlessVector	signum() Set the value(s) to the signum function of the value(s); zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.
MutableDimensionlessVector	sin() Set the value(s) to the trigonometric sine of the value(s).
MutableDimensionlessVector	sinh() Set the value(s) to the hyperbolic sine of the value(s).
MutableDimensionlessVector	sqrt() Set the value(s) to the correctly rounded positive square root of the value(s).
MutableDimensionlessVector	tan() Set the value(s) to the trigonometric tangent of the value(s).
MutableDimensionlessVector	tanh() Set the value(s) to the hyperbolic tangent of the value(s).
Dimensionless[]	toArray() Return an array of Dimensionless Scalars from this vector.
MutableDimensionlessVector	toDense() return a dense version of this vector.
MutableDimensionlessVector	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.MathFunctionsDimensionless

neg

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

MutableDimensionlessVector

public MutableDimensionlessVector(double[] values,
                                  DimensionlessUnit unit,
                                  StorageType storageType)
                           throws ValueException

Construct a new Relative Immutable Double DimensionlessVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MutableDimensionlessVector

public MutableDimensionlessVector(List<Double> values,
                                  DimensionlessUnit unit,
                                  StorageType storageType)
                           throws ValueException

Construct a new Relative Immutable Double DimensionlessVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

MutableDimensionlessVector

public MutableDimensionlessVector(Dimensionless[] values,
                                  StorageType storageType)
                           throws ValueException

Construct a new Relative Immutable Double DimensionlessVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MutableDimensionlessVector

public MutableDimensionlessVector(List<Dimensionless> values,
                                  StorageType storageType)
                           throws ValueException

Construct a new Relative Immutable Double DimensionlessVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

MutableDimensionlessVector

public MutableDimensionlessVector(SortedMap<Integer,Dimensionless> values,
                                  int length,
                                  StorageType storageType)
                           throws ValueException

Construct a new Relative Immutable Double DimensionlessVector.

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

MutableDimensionlessVector

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

Construct a new Relative Immutable Double DimensionlessVector.

Parameters:

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

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

length - the size of the vector

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

Throws:

ValueException - when values is null

MutableDimensionlessVector

MutableDimensionlessVector(DoubleVectorData data,
                           DimensionlessUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final DimensionlessVector instantiateType(DoubleVectorData dvd,
                                                    DimensionlessUnit unit)

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

Specified by:

instantiateType in class AbstractDoubleVectorRel<DimensionlessUnit,DimensionlessVector,MutableDimensionlessVector,Dimensionless>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the DoubleVector of the right type

instantiateMutableType

protected final MutableDimensionlessVector instantiateMutableType(DoubleVectorData dvd,
                                                                  DimensionlessUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleVectorRel<DimensionlessUnit,DimensionlessVector,MutableDimensionlessVector,Dimensionless>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final Dimensionless instantiateScalar(double value,
                                                DimensionlessUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<DimensionlessUnit,DimensionlessVector,MutableDimensionlessVector,Dimensionless>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final MutableDimensionlessVector toDense()

return a dense version of this vector.

Specified by:

toDense in interface DoubleVectorInterface<DimensionlessUnit>

Returns:

a dense version of this vector

toSparse

public final MutableDimensionlessVector toSparse()

return a sparse version of this vector.

Specified by:

toSparse in interface DoubleVectorInterface<DimensionlessUnit>

Returns:

a sparse version of this vector

toArray

public Dimensionless[] toArray()

Return an array of Dimensionless Scalars from this vector.

Returns:

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

Throws:

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

acos

public final MutableDimensionlessVector acos()

Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.

Specified by:

acos in interface MathFunctionsDimensionless<MutableDimensionlessVector>

Returns:

T; the modified T

asin

public final MutableDimensionlessVector asin()

Set the value(s) to the arc sine of the value(s); the resulting angle is in the range -pi/2 through pi/2.

Specified by:

asin in interface MathFunctionsDimensionless<MutableDimensionlessVector>

Returns:

T; the modified T

atan

public final MutableDimensionlessVector atan()

Set the value(s) to the arc tangent of the value(s); the resulting angle is in the range -pi/2 through pi/2.

Specified by:

atan in interface MathFunctionsDimensionless<MutableDimensionlessVector>

Returns:

T; the modified T

cbrt

public final MutableDimensionlessVector cbrt()

Set the value(s) to the(ir) cube root.

Specified by:

cbrt in interface MathFunctionsDimensionless<MutableDimensionlessVector>

Returns:

T; the modified T

cos

public final MutableDimensionlessVector cos()

Set the value(s) to the trigonometric cosine of the value(s).

Specified by:

cos in interface MathFunctionsDimensionless<MutableDimensionlessVector>

Returns:

T; the modified T

cosh

public final MutableDimensionlessVector cosh()

Set the value(s) to the hyperbolic cosine of the value(s).

Specified by:

cosh in interface MathFunctionsDimensionless<MutableDimensionlessVector>

Returns:

T; the modified T

exp

public final MutableDimensionlessVector exp()

Set the value(s) to Euler's number e raised to the power of the value(s).

Specified by:

exp in interface MathFunctionsDimensionless<MutableDimensionlessVector>

Returns:

T; the modified T

expm1

public final MutableDimensionlessVector expm1()

Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).

Specified by:

expm1 in interface MathFunctionsDimensionless<MutableDimensionlessVector>

Returns:

T; the modified T

log

public final MutableDimensionlessVector log()

Set the value(s) to the natural logarithm (base e) of the value(s).

Specified by:

log in interface MathFunctionsDimensionless<MutableDimensionlessVector>

Returns:

T; the modified T

log10

public final MutableDimensionlessVector log10()

Set the value(s) to the base 10 logarithm of the value(s).

Specified by:

log10 in interface MathFunctionsDimensionless<MutableDimensionlessVector>

Returns:

T; the modified T

log1p

public final MutableDimensionlessVector log1p()

Set the value(s) to the natural logarithm of the sum of the value(s) and 1.

Specified by:

log1p in interface MathFunctionsDimensionless<MutableDimensionlessVector>

Returns:

T; the modified T

pow

public final MutableDimensionlessVector pow(double x)

Set the value(s) to the value(s) raised to the power of the argument.

Specified by:

pow in interface MathFunctionsDimensionless<MutableDimensionlessVector>

Parameters:

x - double; the value to use as the power

Returns:

T; the modified T

signum

public final MutableDimensionlessVector signum()

Set the value(s) to the signum function of the value(s); zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.

Specified by:

signum in interface MathFunctionsDimensionless<MutableDimensionlessVector>

Returns:

T; the modified T

sin

public final MutableDimensionlessVector sin()

Set the value(s) to the trigonometric sine of the value(s).

Specified by:

sin in interface MathFunctionsDimensionless<MutableDimensionlessVector>

Returns:

T; the modified T

sinh

public final MutableDimensionlessVector sinh()

Set the value(s) to the hyperbolic sine of the value(s).

Specified by:

sinh in interface MathFunctionsDimensionless<MutableDimensionlessVector>

Returns:

T; the modified T

sqrt

public final MutableDimensionlessVector sqrt()

Set the value(s) to the correctly rounded positive square root of the value(s).

Specified by:

sqrt in interface MathFunctionsDimensionless<MutableDimensionlessVector>

Returns:

T; the modified T

tan

public final MutableDimensionlessVector tan()

Set the value(s) to the trigonometric tangent of the value(s).

Specified by:

tan in interface MathFunctionsDimensionless<MutableDimensionlessVector>

Returns:

T; the modified T

tanh

public final MutableDimensionlessVector tanh()

Set the value(s) to the hyperbolic tangent of the value(s).

Specified by:

tanh in interface MathFunctionsDimensionless<MutableDimensionlessVector>

Returns:

T; the modified T

inv

public final MutableDimensionlessVector inv()

Set the value(s) to the complement (1.0/x) of the value(s).

Specified by:

inv in interface MathFunctionsDimensionless<MutableDimensionlessVector>

Returns:

T; the modified T