org.djunits.value.vfloat.vector

Class FloatVector.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.FloatVector.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>>, Value<U>, FloatVectorInterface<U>

Direct Known Subclasses:

TypedFloatVectorAbs

Enclosing class:

FloatVector<U extends Unit<U>>

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

ABSOLUTE implementation of FloatVector.

See Also:

Serialized Form

Nested Class Summary

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

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

Field Summary

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

data

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
FloatScalar.Abs<U>	get(int index) Retrieve the value stored at a specified index as a FloatScalar.
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>	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.
FloatVector.Abs<U>	toDense() Create a dense version of this FloatVector.
FloatVector.Abs<U>	toSparse() Create a sparse version of this FloatVector.

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

Constructor Detail

Abs

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

Construct a new Absolute Immutable FloatVector.

Parameters:

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

unit - U; the unit of the new Absolute Immutable 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 Immutable FloatVector.

Parameters:

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

unit - U; the unit of the new Absolute Immutable 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 Immutable FloatVector.

Parameters:

values - FloatScalar.Abs<U>[]; the values of the entries in the new Absolute Immutable 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 Immutable FloatVector.

Type Parameters:

S - the Scalar type used

Parameters:

values - List; the values of the entries in the new Absolute Immutable 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 Immutable 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 Immutable 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 Immutable FloatVector.

Parameters:

data - an internal data object

unit - the unit

Method Detail

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

toDense

public FloatVector.Abs<U> toDense()

Create a dense version of this FloatVector.

Specified by:

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

Returns:

MutableFloatVector<U>; dense version of this FloatVector

toSparse

public FloatVector.Abs<U> toSparse()

Create a sparse version of this FloatVector.

Specified by:

toSparse in interface FloatVectorInterface<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())

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