org.djunits.value.vdouble.vector

Class MutableDoubleVector.Abs<U extends Unit<U>>

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.vector.DoubleVector<U>

org.djunits.value.vdouble.vector.MutableDoubleVector<U>

org.djunits.value.vdouble.vector.MutableDoubleVector.Abs<U>

Type Parameters:

U - Unit the unit for which this Vector will be created

All Implemented Interfaces:

Serializable, Absolute, FunctionsAbs<U,DoubleVector.Abs<U>,DoubleVector.Rel<U>>, MathFunctionsAbs<MutableDoubleVector.Abs<U>>, Value<U>, DoubleMathFunctions<MutableDoubleVector.Abs<U>>, DoubleVectorInterface<U>, MutableDoubleVectorInterface<U>

Direct Known Subclasses:

MutableTypedDoubleVectorAbs

Enclosing class:

MutableDoubleVector<U extends Unit<U>>

public static class MutableDoubleVector.Abs<U extends Unit<U>>
extends MutableDoubleVector<U>
implements Absolute, MathFunctionsAbs<MutableDoubleVector.Abs<U>>, FunctionsAbs<U,DoubleVector.Abs<U>,DoubleVector.Rel<U>>, DoubleMathFunctions<MutableDoubleVector.Abs<U>>

ABSOLUTE implementation of MutableDoubleVector.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vdouble.vector.MutableDoubleVector

MutableDoubleVector.Abs<U extends Unit<U>>, MutableDoubleVector.Rel<U extends Unit<U>>

Field Summary

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

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, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH

Constructor Summary

Constructors

Constructor and Description
Abs(double[] values, U unit, StorageType storageType) Construct a new Absolute Mutable DoubleVector.
Abs(DoubleScalar.Abs<U>[] values, StorageType storageType) Construct a new Absolute Mutable DoubleVector.
Abs(DoubleVectorData data, U unit) Construct a new Absolute Mutable DoubleVector.
Abs(List<Double> values, U unit, StorageType storageType) Construct a new Absolute Mutable DoubleVector.
Abs(List<S> values, StorageType storageType) Construct a new Absolute Mutable DoubleVector.
Abs(SortedMap<Integer,Double> values, U unit, int length, StorageType storageType) Construct a new Relative Mutable DoubleVector.
Abs(SortedMap<Integer,S> values, int length, StorageType storageType) Construct a new Relative Mutable DoubleVector.

Method Summary

Modifier and Type	Method and Description
MutableDoubleVector.Abs<U>	ceil() Set the value(s) to the smallest (closest to negative infinity) value(s) that are greater than or equal to the argument and equal to a mathematical integer.
MutableDoubleVector.Abs<U>	copy() Create a deep copy of this MutableDoubleVector.
MutableDoubleVector.Abs<U>	decrementBy(double decrement) Decrement the value by the supplied constant and return the changed vector.
MutableDoubleVector.Abs<U>	decrementBy(DoubleScalar.Rel<U> decrement) Decrement the value by the supplied value and return the changed vector.
MutableDoubleVector.Abs<U>	decrementBy(DoubleVector.Rel<U> decrement) Decrement the value by the supplied value and return the changed vector.
MutableDoubleVector.Abs<U>	divideBy(double factor) Scale the value(s) by the inverse of a factor; i.e.
MutableDoubleVector.Abs<U>	divideBy(DoubleScalar.Rel<U> factor) Divide the values in the vector by the supplied value and return the changed vector.
MutableDoubleVector.Abs<U>	divideBy(DoubleVector.Rel<U> factors) Divide the values in the vector by the supplied values and return the changed vector.
MutableDoubleVector.Abs<U>	floor() Set the value(s) to the largest (closest to positive infinity) value(s) that are less than or equal to the argument and equal to a mathematical integer.
DoubleScalar.Abs<U>	get(int index) Retrieve the value stored at a specified index as a DoubleScalar.
DoubleVector.Abs<U>	immutable() Create a immutable version of this MutableDoubleVector.
MutableDoubleVector.Abs<U>	incrementBy(double increment) Increment the value by the supplied constant and return the changed vector.
MutableDoubleVector.Abs<U>	incrementBy(DoubleScalar.Rel<U> increment) Increment the value by the supplied value and return the changed vector.
MutableDoubleVector.Abs<U>	incrementBy(DoubleVector.Rel<U> increment) Increment the value by the supplied value and return the changed vector.
DoubleVector.Rel<U>	minus(DoubleVector.Abs<U> abs) Subtract an Absolute value from this Absolute value for a vector or matrix.
DoubleVector.Abs<U>	minus(DoubleVector.Rel<U> rel) Subtract a Relative value from this Absolute value for a vector or matrix.
MutableDoubleVector.Abs<U>	multiplyBy(double factor) Scale the value(s) by a factor.
MutableDoubleVector.Abs<U>	multiplyBy(DoubleScalar.Rel<U> factor) Multiply the values in the vector by the supplied value and return the changed vector.
MutableDoubleVector.Abs<U>	multiplyBy(DoubleVector.Rel<U> factors) Multiply the values in the vector by the supplied values and return the changed vector.
MutableDoubleVector.Abs<U>	mutable() Create a mutable version of this DoubleVector.
DoubleVector.Abs<U>	plus(DoubleVector.Rel<U> rel) Add a Relative value to this Absolute value for a vector or matrix.
MutableDoubleVector.Abs<U>	rint() Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.
MutableDoubleVector.Abs<U>	round() Set the value(s) to the closest long to the argument with ties rounding up.
MutableDoubleVector.Abs<U>	toDense() Create a dense version of this DoubleVector.
MutableDoubleVector.Abs<U>	toSparse() Create a sparse version of this DoubleVector.

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

assign, checkCopyOnWrite, instantiateMutableAbs, normalize, set, setCopyOnWrite, setInUnit, setSI

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

cardinality, checkIndex, checkSize, checkSize, checkUnit, checkUnit, checkUnit, equals, getData, getInUnit, getInUnit, getSI, getStorageType, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, instantiateAbs, instantiateRel, size, toString, toString, toString, toString, zSum

Methods inherited from class org.djunits.value.AbstractValue

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative

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, getInUnit, getInUnit, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, size, toString, toString, toString, toString, zSum

Constructor Detail

Abs

public Abs(double[] values,
           U unit,
           StorageType storageType)
    throws ValueException

Construct a new Absolute Mutable DoubleVector.

Parameters:

values - double[]; the values of the entries in the new Absolute Mutable DoubleVector

unit - U; the unit of the new Absolute Mutable DoubleVector

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

Throws:

ValueException - when values is null

Abs

public Abs(List<Double> values,
           U unit,
           StorageType storageType)
    throws ValueException

Construct a new Absolute Mutable DoubleVector.

Parameters:

values - List; the values of the entries in the new Absolute Mutable DoubleVector

unit - U; the unit of the new Absolute Mutable DoubleVector

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

Throws:

ValueException - when values is null

Abs

public Abs(DoubleScalar.Abs<U>[] values,
           StorageType storageType)
    throws ValueException

Construct a new Absolute Mutable DoubleVector.

Parameters:

values - DoubleScalar.Abs<U>[]; the values of the entries in the new Absolute Mutable DoubleVector

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

Throws:

ValueException - when values has zero entries

Abs

public Abs(List<S> values,
           StorageType storageType)
    throws ValueException

Construct a new Absolute Mutable DoubleVector.

Type Parameters:

S - the Scalar type used

Parameters:

values - List; the values of the entries in the new Absolute Mutable DoubleVector

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

Throws:

ValueException - when values has zero entries

Abs

public Abs(SortedMap<Integer,S> values,
           int length,
           StorageType storageType)
    throws ValueException

Construct a new Relative Mutable DoubleVector.

Type Parameters:

S - the Scalar type used

Parameters:

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

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

Abs

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

Construct a new Relative Mutable DoubleVector.

Parameters:

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

unit - U; the unit of the new Relative Sparse Mutable DoubleVector

length - the size of the vector

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

Throws:

ValueException - when values is null

Abs

Abs(DoubleVectorData data,
    U unit)

Construct a new Absolute Mutable DoubleVector.

Parameters:

data - an internal data object

unit - the unit

Method Detail

immutable

public DoubleVector.Abs<U> immutable()

Create a immutable version of this MutableDoubleVector.

Specified by:

immutable in interface MutableDoubleVectorInterface<U extends Unit<U>>

Returns:

DoubleVector<U>; mutable version of this MutableDoubleVector

mutable

public MutableDoubleVector.Abs<U> mutable()

Create a mutable version of this DoubleVector.
The mutable version is created with a shallow copy of the data and the internal copyOnWrite flag set. The first operation in the mutable version that modifies the data shall trigger a deep copy of the data.

Specified by:

mutable in interface DoubleVectorInterface<U extends Unit<U>>

Returns:

MutableDoubleVector<U>; mutable version of this DoubleVector

copy

public MutableDoubleVector.Abs<U> copy()

Create a deep copy of this MutableDoubleVector.

Specified by:

copy in interface MutableDoubleVectorInterface<U extends Unit<U>>

Returns:

DoubleVector<U>; deep copy of this MutableDoubleVector

toDense

public MutableDoubleVector.Abs<U> toDense()

Create a dense version of this DoubleVector.

Specified by:

toDense in interface DoubleVectorInterface<U extends Unit<U>>

Specified by:

toDense in interface MutableDoubleVectorInterface<U extends Unit<U>>

Returns:

DoubleVector<U>; dense version of this DoubleVector

toSparse

public MutableDoubleVector.Abs<U> toSparse()

Create a sparse version of this DoubleVector.

Specified by:

toSparse in interface DoubleVectorInterface<U extends Unit<U>>

Specified by:

toSparse in interface MutableDoubleVectorInterface<U extends Unit<U>>

Returns:

DoubleVector<U>; sparse version of this DoubleVector

get

public DoubleScalar.Abs<U> get(int index)
                        throws ValueException

Retrieve the value stored at a specified index as a DoubleScalar.

Specified by:

get in interface DoubleVectorInterface<U extends Unit<U>>

Parameters:

index - int; index of the value to retrieve

Returns:

DoubleScalar<U>; the strongly typed value of the selected cell

Throws:

ValueException - when index out of range (index < 0 or index >= size())

incrementBy

public final MutableDoubleVector.Abs<U> incrementBy(DoubleVector.Rel<U> increment)
                                             throws ValueException

Increment the value by the supplied value and return the changed vector.

Parameters:

increment - DoubleVector.Rel<U>; amount by which the value is incremented

Returns:

the changed MutableDoubleVector.Abs<U>

Throws:

ValueException - when the size of increment is not identical to the size of this

incrementBy

public final MutableDoubleVector.Abs<U> incrementBy(DoubleScalar.Rel<U> increment)

Increment the value by the supplied value and return the changed vector.

Parameters:

increment - DoubleScalar.Rel<U>; amount by which the value is incremented

Returns:

the changed MutableDoubleVector.Abs<U>

incrementBy

public final MutableDoubleVector.Abs<U> incrementBy(double increment)

Increment the value by the supplied constant and return the changed vector.

Parameters:

increment - amount by which the value is incremented

Returns:

the changed MutableDoubleVector.Abs<U>

decrementBy

public final MutableDoubleVector.Abs<U> decrementBy(DoubleVector.Rel<U> decrement)
                                             throws ValueException

Decrement the value by the supplied value and return the changed vector.

Parameters:

decrement - DoubleVector.Rel<U>; amount by which the value is decremented

Returns:

the changed MutableDoubleVector.Abs<U>

Throws:

ValueException - when the size of increment is not identical to the size of this

decrementBy

public final MutableDoubleVector.Abs<U> decrementBy(DoubleScalar.Rel<U> decrement)

Decrement the value by the supplied value and return the changed vector.

Parameters:

decrement - DoubleScalar.Rel<U>; amount by which the value is decremented

Returns:

the changed MutableDoubleVector.Abs<U>

decrementBy

public final MutableDoubleVector.Abs<U> decrementBy(double decrement)

Decrement the value by the supplied constant and return the changed vector.

Parameters:

decrement - amount by which the value is decremented

Returns:

the changed MutableDoubleVector.Abs<U>

multiplyBy

public final MutableDoubleVector.Abs<U> multiplyBy(DoubleVector.Rel<U> factors)
                                            throws ValueException

Multiply the values in the vector by the supplied values and return the changed vector.

Parameters:

factors - DoubleVector.Rel<U>; amounts by which the value is multiplied

Returns:

the changed MutableDoubleVector.Abs<U>

Throws:

ValueException - when the size of the factors is not identical to the size of this

multiplyBy

public final MutableDoubleVector.Abs<U> multiplyBy(DoubleScalar.Rel<U> factor)

Multiply the values in the vector by the supplied value and return the changed vector.

Parameters:

factor - DoubleScalar.Rel<U>; amount by which the values in the vector are multiplied

Returns:

the changed MutableDoubleVector.Abs<U>

multiplyBy

public MutableDoubleVector.Abs<U> multiplyBy(double factor)

Scale the value(s) by a factor.

Specified by:

multiplyBy in interface DoubleMathFunctions<MutableDoubleVector.Abs<U extends Unit<U>>>

Parameters:

factor - double; the multiplier

Returns:

T; the modified T

divideBy

public final MutableDoubleVector.Abs<U> divideBy(DoubleVector.Rel<U> factors)
                                          throws ValueException

Divide the values in the vector by the supplied values and return the changed vector.

Parameters:

factors - DoubleVector.Rel<U>; amounts by which the value is divided

Returns:

the changed MutableDoubleVector.Abs<U>

Throws:

ValueException - when the size of the factors is not identical to the size of this

divideBy

public MutableDoubleVector.Abs<U> divideBy(double factor)

Scale the value(s) by the inverse of a factor; i.e. a divisor.

Specified by:

divideBy in interface DoubleMathFunctions<MutableDoubleVector.Abs<U extends Unit<U>>>

Parameters:

factor - double; the divisor

Returns:

T; the modified T

divideBy

public final MutableDoubleVector.Abs<U> divideBy(DoubleScalar.Rel<U> factor)

Divide the values in the vector by the supplied value and return the changed vector.

Parameters:

factor - DoubleScalar.Rel<U>; amount by which the values in the vector are divided

Returns:

the changed MutableDoubleVector.Abs<U>

plus

public DoubleVector.Abs<U> plus(DoubleVector.Rel<U> rel)
                         throws ValueException

Add a Relative value to this Absolute value for a vector or matrix. The addition is done value by value and the result is stored in a new Absolute value. If both operands are sparse, the result is a sparse vector or matrix, otherwise the result is a dense vector or matrix.

Specified by:

plus in interface FunctionsAbs<U extends Unit<U>,DoubleVector.Abs<U extends Unit<U>>,DoubleVector.Rel<U extends Unit<U>>>

Parameters:

rel - R the right operand

Returns:

A the sum of this vector and the operand

Throws:

ValueException - in case this vector and the operand have a different size

minus

public DoubleVector.Abs<U> minus(DoubleVector.Rel<U> rel)
                          throws ValueException

Subtract a Relative value from this Absolute value for a vector or matrix. The subtraction is done value by value and the result is stored in a new Absolute value. If both operands are sparse, the result is a sparse vector or matrix, otherwise the result is a dense vector or matrix.

Specified by:

minus in interface FunctionsAbs<U extends Unit<U>,DoubleVector.Abs<U extends Unit<U>>,DoubleVector.Rel<U extends Unit<U>>>

Parameters:

rel - R the right operand

Returns:

A the subtraction of this vector and the operand

Throws:

ValueException - in case this vector and the operand have a different size

minus

public DoubleVector.Rel<U> minus(DoubleVector.Abs<U> abs)
                          throws ValueException

Subtract an Absolute value from this Absolute value for a vector or matrix. The subtraction is done value by value and the result is stored in a new Relative value. If both operands are sparse, the result is a sparse vector or matrix, otherwise the result is a dense vector or matrix.

Specified by:

minus in interface FunctionsAbs<U extends Unit<U>,DoubleVector.Abs<U extends Unit<U>>,DoubleVector.Rel<U extends Unit<U>>>

Parameters:

abs - A the right operand

Returns:

R the subtraction of this vector and the operand

Throws:

ValueException - in case this vector and the operand have a different size

ceil

public MutableDoubleVector.Abs<U> ceil()

Set the value(s) to the smallest (closest to negative infinity) value(s) that are greater than or equal to the argument and equal to a mathematical integer.

Specified by:

ceil in interface MathFunctionsAbs<MutableDoubleVector.Abs<U extends Unit<U>>>

Returns:

T; the modified T

floor

public MutableDoubleVector.Abs<U> floor()

Set the value(s) to the largest (closest to positive infinity) value(s) that are less than or equal to the argument and equal to a mathematical integer.

Specified by:

floor in interface MathFunctionsAbs<MutableDoubleVector.Abs<U extends Unit<U>>>

Returns:

T; the modified T

rint

public MutableDoubleVector.Abs<U> rint()

Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.

Specified by:

rint in interface MathFunctionsAbs<MutableDoubleVector.Abs<U extends Unit<U>>>

Returns:

T; the modified T

round

public MutableDoubleVector.Abs<U> round()

Set the value(s) to the closest long to the argument with ties rounding up.

Specified by:

round in interface MathFunctionsAbs<MutableDoubleVector.Abs<U extends Unit<U>>>

Returns:

T; the modified T