org.djunits.value.vfloat.matrix

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

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vfloat.matrix.FloatMatrix<U>

org.djunits.value.vfloat.matrix.FloatMatrix.Abs<U>

Type Parameters:

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

All Implemented Interfaces:

Serializable, Absolute, FunctionsAbs<U,FloatMatrix.Abs<U>,FloatMatrix.Rel<U>>, Value<U>, FloatMatrixInterface<U>

Direct Known Subclasses:

TypedFloatMatrixAbs

Enclosing class:

FloatMatrix<U extends Unit<U>>

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

ABSOLUTE implementation of FloatMatrix.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vfloat.matrix.FloatMatrix

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

Field Summary

Fields inherited from class org.djunits.value.vfloat.matrix.FloatMatrix

data

Constructor Summary

Constructors

Constructor and Description
Abs(float[][] values, U unit, StorageType storageType) Construct a new Absolute Immutable FloatMatrix.
Abs(FloatMatrixData data, U unit) Construct a new Absolute Immutable FloatMatrix.
Abs(FloatScalar.Abs<U>[][] values, StorageType storageType) Construct a new Absolute Immutable FloatMatrix.

Method Summary

Modifier and Type	Method and Description
FloatScalar.Abs<U>	get(int row, int column) Retrieve the value stored at a specified row and column as a FloatScalar.
FloatMatrix.Rel<U>	minus(FloatMatrix.Abs<U> abs) Subtract an Absolute value from this Absolute value for a vector or matrix.
FloatMatrix.Abs<U>	minus(FloatMatrix.Rel<U> rel) Subtract a Relative value from this Absolute value for a vector or matrix.
MutableFloatMatrix.Abs<U>	mutable() Create a mutable version of this FloatMatrix.
FloatMatrix.Abs<U>	plus(FloatMatrix.Rel<U> rel) Add a Relative value to this Absolute value for a vector or matrix.
FloatMatrix.Abs<U>	toDense() Create a dense version of this FloatMatrix.
FloatMatrix.Abs<U>	toSparse() Create a sparse version of this FloatMatrix.

Methods inherited from class org.djunits.value.vfloat.matrix.FloatMatrix

cardinality, checkIndex, checkSize, checkSize, checkUnit, columns, determinant, divide, ensureRectangularAndNonEmpty, ensureRectangularAndNonEmpty, equals, getData, getInUnit, getInUnit, getSI, getStorageType, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, instantiateAbs, instantiateRel, minus, minus, minus, plus, plus, rows, times, 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 FloatMatrix.

Parameters:

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

unit - U; the unit of the new Absolute Immutable FloatMatrix

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

Parameters:

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

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

Throws:

ValueException - when values has zero entries

Abs

Abs(FloatMatrixData data,
    U unit)

Construct a new Absolute Immutable FloatMatrix.

Parameters:

data - an internal data object

unit - the unit

Method Detail

mutable

public MutableFloatMatrix.Abs<U> mutable()

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

Returns:

MutableFloatMatrix<U>; mutable version of this FloatMatrix

toDense

public FloatMatrix.Abs<U> toDense()

Create a dense version of this FloatMatrix.

Specified by:

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

Returns:

MutableFloatMatrix<U>; dense version of this FloatMatrix

toSparse

public FloatMatrix.Abs<U> toSparse()

Create a sparse version of this FloatMatrix.

Specified by:

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

Returns:

MutableFloatMatrix<U>; sparse version of this FloatMatrix

get

public FloatScalar.Abs<U> get(int row,
                              int column)
                       throws ValueException

Retrieve the value stored at a specified row and column as a FloatScalar.

Specified by:

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

Parameters:

row - int; row of the value to retrieve

column - int; column of the value to retrieve

Returns:

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

Throws:

ValueException - when row or column out of range (row < 0 or row >= rows() or column < 0 or column >= columns())

plus

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