org.djunits.value.vfloat.vector

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

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vfloat.vector.FloatVector<U>

org.djunits.value.vfloat.vector.MutableFloatVector<U>

org.djunits.value.vfloat.vector.MutableFloatVector.Abs<U>

Type Parameters:

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

All Implemented Interfaces:

Serializable, Absolute, FunctionsAbs<U,FloatVector.Abs<U>,FloatVector.Rel<U>>, MathFunctionsAbs<MutableFloatVector.Abs<U>>, Value<U>, FloatMathFunctions<MutableFloatVector.Abs<U>>, FloatVectorInterface<U>, MutableFloatVectorInterface<U>

Direct Known Subclasses:

MutableTypedFloatVectorAbs

Enclosing class:

MutableFloatVector<U extends Unit<U>>

public static class MutableFloatVector.Abs<U extends Unit<U>>
extends MutableFloatVector<U>
implements Absolute, MathFunctionsAbs<MutableFloatVector.Abs<U>>, FunctionsAbs<U,FloatVector.Abs<U>,FloatVector.Rel<U>>, FloatMathFunctions<MutableFloatVector.Abs<U>>

ABSOLUTE implementation of MutableFloatVector.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vfloat.vector.MutableFloatVector

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

Field Summary

Fields inherited from class org.djunits.value.vfloat.vector.FloatVector

data

Fields inherited from interface org.djunits.value.vfloat.FloatMathFunctions

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

Constructor Summary

Constructors

Constructor and Description
Abs(float[] values, U unit, StorageType storageType) Construct a new Absolute Mutable FloatVector.
Abs(FloatScalar.Abs<U>[] values, StorageType storageType) Construct a new Absolute Mutable FloatVector.
Abs(FloatVectorData data, U unit) Construct a new Absolute Mutable FloatVector.
Abs(List<Float> values, U unit, StorageType storageType) Construct a new Absolute Mutable FloatVector.
Abs(List<S> values, StorageType storageType) Construct a new Absolute Mutable FloatVector.
Abs(SortedMap<Integer,Float> values, U unit, int length, StorageType storageType) Construct a new Relative Mutable FloatVector.
Abs(SortedMap<Integer,S> values, int length, StorageType storageType) Construct a new Relative Mutable FloatVector.

Method Summary

Modifier and Type	Method and Description
MutableFloatVector.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.
MutableFloatVector.Abs<U>	copy() Create a deep copy of this MutableFloatVector.
MutableFloatVector.Abs<U>	decrementBy(float decrement) Decrement the value by the supplied constant and return the changed vector.
MutableFloatVector.Abs<U>	decrementBy(FloatScalar.Rel<U> decrement) Decrement the value by the supplied value and return the changed vector.
MutableFloatVector.Abs<U>	decrementBy(FloatVector.Rel<U> decrement) Decrement the value by the supplied value and return the changed vector.
MutableFloatVector.Abs<U>	divideBy(float factor) Scale the value(s) by the inverse of a factor; i.e.
MutableFloatVector.Abs<U>	divideBy(FloatScalar.Rel<U> factor) Divide the values in the vector by the supplied value and return the changed vector.
MutableFloatVector.Abs<U>	divideBy(FloatVector.Rel<U> factors) Divide the values in the vector by the supplied values and return the changed vector.
MutableFloatVector.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.
FloatScalar.Abs<U>	get(int index) Retrieve the value stored at a specified index as a FloatScalar.
FloatVector.Abs<U>	immutable() Create a immutable version of this MutableFloatVector.
MutableFloatVector.Abs<U>	incrementBy(float increment) Increment the value by the supplied constant and return the changed vector.
MutableFloatVector.Abs<U>	incrementBy(FloatScalar.Rel<U> increment) Increment the value by the supplied value and return the changed vector.
MutableFloatVector.Abs<U>	incrementBy(FloatVector.Rel<U> increment) Increment the value by the supplied value and return the changed vector.
FloatVector.Rel<U>	minus(FloatVector.Abs<U> abs) Subtract an Absolute value from this Absolute value for a vector or matrix.
FloatVector.Abs<U>	minus(FloatVector.Rel<U> rel) Subtract a Relative value from this Absolute value for a vector or matrix.
MutableFloatVector.Abs<U>	multiplyBy(float factor) Scale the value(s) by a factor.
MutableFloatVector.Abs<U>	multiplyBy(FloatScalar.Rel<U> factor) Multiply the values in the vector by the supplied value and return the changed vector.
MutableFloatVector.Abs<U>	multiplyBy(FloatVector.Rel<U> factors) Multiply the values in the vector by the supplied values and return the changed vector.
MutableFloatVector.Abs<U>	mutable() Create a mutable version of this FloatVector.
FloatVector.Abs<U>	plus(FloatVector.Rel<U> rel) Add a Relative value to this Absolute value for a vector or matrix.
MutableFloatVector.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.
MutableFloatVector.Abs<U>	round() Set the value(s) to the closest long to the argument with ties rounding up.
MutableFloatVector.Abs<U>	toDense() Create a dense version of this FloatVector.
MutableFloatVector.Abs<U>	toSparse() Create a sparse version of this FloatVector.

Methods inherited from class org.djunits.value.vfloat.vector.MutableFloatVector

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

Methods inherited from class org.djunits.value.vfloat.vector.FloatVector

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.vfloat.FloatMathFunctions

DIV, MULT, POW

Methods inherited from interface org.djunits.value.vfloat.vector.FloatVectorInterface

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

Constructor Detail

Abs

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

Construct a new Absolute Mutable FloatVector.

Parameters:

values - float[]; the values of the entries in the new Absolute Mutable FloatVector

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

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

Throws:

ValueException - when values is null

Abs

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

Construct a new Absolute Mutable FloatVector.

Parameters:

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

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

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

Throws:

ValueException - when values is null

Abs

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

Construct a new Absolute Mutable FloatVector.

Parameters:

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

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 FloatVector.

Type Parameters:

S - the Scalar type used

Parameters:

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

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 FloatVector.

Type Parameters:

S - the Scalar type used

Parameters:

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

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,Float> values,
           U unit,
           int length,
           StorageType storageType)
    throws ValueException

Construct a new Relative Mutable FloatVector.

Parameters:

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

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

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(FloatVectorData data,
    U unit)

Construct a new Absolute Mutable FloatVector.

Parameters:

data - an internal data object

unit - the unit

Method Detail

immutable

public FloatVector.Abs<U> immutable()

Create a immutable version of this MutableFloatVector.

Specified by:

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

Returns:

FloatVector<U>; mutable version of this MutableFloatVector

mutable

public MutableFloatVector.Abs<U> mutable()

Create a mutable version of this FloatVector.
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 FloatVectorInterface<U extends Unit<U>>

Returns:

MutableFloatVector<U>; mutable version of this FloatVector

copy

public MutableFloatVector.Abs<U> copy()

Create a deep copy of this MutableFloatVector.

Specified by:

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

Returns:

FloatVector<U>; deep copy of this MutableFloatVector

toDense

public MutableFloatVector.Abs<U> toDense()

Create a dense version of this FloatVector.

Specified by:

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

Specified by:

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

Returns:

MutableFloatVector<U>; dense version of this FloatVector

toSparse

public MutableFloatVector.Abs<U> toSparse()

Create a sparse version of this FloatVector.

Specified by:

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

Specified by:

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

Returns:

MutableFloatVector<U>; sparse version of this FloatVector

get

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

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

Specified by:

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

Parameters:

index - int; index of the value to retrieve

Returns:

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

Throws:

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

incrementBy

public final MutableFloatVector.Abs<U> incrementBy(FloatVector.Rel<U> increment)
                                            throws ValueException

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

Parameters:

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

Returns:

the changed MutableFloatVector.Abs<U>

Throws:

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

incrementBy

public final MutableFloatVector.Abs<U> incrementBy(FloatScalar.Rel<U> increment)

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

Parameters:

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

Returns:

the changed MutableFloatVector.Abs<U>

incrementBy

public final MutableFloatVector.Abs<U> incrementBy(float 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 MutableFloatVector.Abs<U>

decrementBy

public final MutableFloatVector.Abs<U> decrementBy(FloatVector.Rel<U> decrement)
                                            throws ValueException

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

Parameters:

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

Returns:

the changed MutableFloatVector.Abs<U>

Throws:

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

decrementBy

public final MutableFloatVector.Abs<U> decrementBy(FloatScalar.Rel<U> decrement)

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

Parameters:

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

Returns:

the changed MutableFloatVector.Abs<U>

decrementBy

public final MutableFloatVector.Abs<U> decrementBy(float 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 MutableFloatVector.Abs<U>

multiplyBy

public final MutableFloatVector.Abs<U> multiplyBy(FloatVector.Rel<U> factors)
                                           throws ValueException

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

Parameters:

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

Returns:

the changed MutableFloatVector.Abs<U>

Throws:

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

multiplyBy

public final MutableFloatVector.Abs<U> multiplyBy(FloatScalar.Rel<U> factor)

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

Parameters:

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

Returns:

the changed MutableFloatVector.Abs<U>

multiplyBy

public MutableFloatVector.Abs<U> multiplyBy(float factor)

Scale the value(s) by a factor.

Specified by:

multiplyBy in interface FloatMathFunctions<MutableFloatVector.Abs<U extends Unit<U>>>

Parameters:

factor - float; the multiplier

Returns:

T; the modified T

divideBy

public final MutableFloatVector.Abs<U> divideBy(FloatVector.Rel<U> factors)
                                         throws ValueException

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

Parameters:

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

Returns:

the changed MutableFloatVector.Abs<U>

Throws:

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

divideBy

public MutableFloatVector.Abs<U> divideBy(float factor)

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

Specified by:

divideBy in interface FloatMathFunctions<MutableFloatVector.Abs<U extends Unit<U>>>

Parameters:

factor - float; the divisor

Returns:

T; the modified T

divideBy

public final MutableFloatVector.Abs<U> divideBy(FloatScalar.Rel<U> factor)

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

Parameters:

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

Returns:

the changed MutableFloatVector.Abs<U>

plus

public FloatVector.Abs<U> plus(FloatVector.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>,FloatVector.Abs<U extends Unit<U>>,FloatVector.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 FloatVector.Abs<U> minus(FloatVector.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>,FloatVector.Abs<U extends Unit<U>>,FloatVector.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 FloatVector.Rel<U> minus(FloatVector.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>,FloatVector.Abs<U extends Unit<U>>,FloatVector.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 MutableFloatVector.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<MutableFloatVector.Abs<U extends Unit<U>>>

Returns:

T; the modified T

floor

public MutableFloatVector.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<MutableFloatVector.Abs<U extends Unit<U>>>

Returns:

T; the modified T

rint

public MutableFloatVector.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<MutableFloatVector.Abs<U extends Unit<U>>>

Returns:

T; the modified T

round

public MutableFloatVector.Abs<U> round()

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

Specified by:

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

Returns:

T; the modified T