org.djunits.value.vfloat.matrix

Class AbstractFloatMatrixAbs<AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,A extends AbstractFloatMatrixAbs<AU,RU,A,R,MA,S>,R extends AbstractFloatMatrixRel<RU,R,?,?>,MA extends AbstractMutableFloatMatrixAbs<AU,RU,A,R,MA,S>,S extends AbstractFloatScalarAbs<AU,S,RU,?>>

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vfloat.matrix.AbstractFloatMatrix<AU,A>

org.djunits.value.vfloat.matrix.AbstractFloatMatrixAbs<AU,RU,A,R,MA,S>

Type Parameters:

AU - the absolute unit

RU - the relative unit

A - the absolute matrix type

R - the relative matrix type

MA - the mutable absolute matrix type

S - the absolute scalar type

All Implemented Interfaces:

Serializable, Absolute, FunctionsAbs<AU,RU,A,R>, Value<AU>, FloatMatrixInterface<AU>

Direct Known Subclasses:

AbstractMutableFloatMatrixAbs, FloatAbsoluteTemperatureMatrix, FloatDirectionMatrix, FloatMatrix.Abs, FloatPositionMatrix, FloatTimeMatrix

abstract class AbstractFloatMatrixAbs<AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,A extends AbstractFloatMatrixAbs<AU,RU,A,R,MA,S>,R extends AbstractFloatMatrixRel<RU,R,?,?>,MA extends AbstractMutableFloatMatrixAbs<AU,RU,A,R,MA,S>,S extends AbstractFloatScalarAbs<AU,S,RU,?>>
extends AbstractFloatMatrix<AU,A>
implements FunctionsAbs<AU,RU,A,R>, FloatMatrixInterface<AU>, Absolute, Serializable

Absolute Immutable typed matrix.

Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

$LastChangedDate: 2015-09-29 14:14:28 +0200 (Tue, 29 Sep 2015) $, @version $Revision: 73 $, by $Author: pknoppers $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

Field Summary

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

data

Constructor Summary

Constructors

Constructor and Description
AbstractFloatMatrixAbs(float[][] values, AU unit, StorageType storageType) Construct a new Absolute Immutable FloatMatrix.
AbstractFloatMatrixAbs(FloatMatrixData data, AU unit) Construct a new Relative Immutable FloatMatrix.
AbstractFloatMatrixAbs(S[][] values, StorageType storageType) Construct a new Absolute Immutable FloatMatrix.

Method Summary

Modifier and Type	Method and Description
(package private) static <AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,S extends AbstractFloatScalarAbs<AU,S,RU,?>> AU	checkUnit(S[][] dsArray) Check that a provided array can be used to create some descendant of a FloatMatrix, and return the Unit.
protected static <AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,S extends AbstractFloatScalarAbs<AU,S,RU,?>> void	ensureRectangularAndNonEmpty(S[][] values) Check that a 2D array of FloatScalar<?> is rectangular; i.e.
S	get(int row, int column) Retrieve a value from the matrix.
protected abstract MA	instantiateMutableType(FloatMatrixData dmd, AU unit) Construct a new Absolute Mutable FloatMatrix of the right type.
protected abstract S	instantiateScalar(float value, AU unit) Construct a new Absolute Immutable FloatScalar of the right type.
protected abstract A	instantiateTypeAbs(FloatMatrixData dmd, AU unit) Construct a new Absolute Immutable FloatMatrix of the right type.
protected abstract R	instantiateTypeRel(FloatMatrixData dmd, RU unit) Construct a new Relative Immutable FloatMatrix of the right type.
R	minus(A abs) Subtract an Absolute value from this Absolute value for a vector or matrix.
A	minus(R rel) Subtract a Relative value from this Absolute value for a vector or matrix.
MA	mutable() Create a mutable version of this FloatMatrix.
A	plus(R rel) Add a Relative value to this Absolute value for a vector or matrix.

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

cardinality, checkIndex, checkSize, checkSize, columns, determinant, ensureRectangularAndNonEmpty, equals, getData, getInUnit, getInUnit, getSI, getStorageType, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, rows, 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.vfloat.matrix.FloatMatrixInterface

cardinality, columns, determinant, getInUnit, getInUnit, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, rows, toDense, toSparse, toString, toString, toString, toString, zSum

Constructor Detail

AbstractFloatMatrixAbs

AbstractFloatMatrixAbs(float[][] values,
                       AU 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 - AU; 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

AbstractFloatMatrixAbs

AbstractFloatMatrixAbs(S[][] values,
                       StorageType storageType)
                throws ValueException

Construct a new Absolute Immutable FloatMatrix.

Parameters:

values - S[][]; 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

AbstractFloatMatrixAbs

AbstractFloatMatrixAbs(FloatMatrixData data,
                       AU unit)

Construct a new Relative Immutable FloatMatrix.

Parameters:

data - an internal data object

unit - the unit

Method Detail

mutable

public MA 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.

Returns:

MA; mutable version of this FloatMatrix

instantiateTypeAbs

protected abstract A instantiateTypeAbs(FloatMatrixData dmd,
                                        AU unit)

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

Parameters:

dmd - an internal data object

unit - the unit

Returns:

M the Mutable FloatMatrix of the right type

instantiateTypeRel

protected abstract R instantiateTypeRel(FloatMatrixData dmd,
                                        RU unit)

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

Parameters:

dmd - an internal data object

unit - the unit

Returns:

M the Mutable FloatMatrix of the right type

instantiateMutableType

protected abstract MA instantiateMutableType(FloatMatrixData dmd,
                                             AU unit)

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

Parameters:

dmd - an internal data object

unit - the unit

Returns:

M the Mutable FloatMatrix of the right type

instantiateScalar

protected abstract S instantiateScalar(float value,
                                       AU unit)

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

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable FloatScalar of the right type

get

public final S get(int row,
                   int column)
            throws ValueException

Retrieve a value from the matrix.

Specified by:

get in interface FloatMatrixInterface<AU extends AbsoluteLinearUnit<AU,RU>>

Parameters:

row - int; row of the value to retrieve

column - int; column of the value to retrieve

Returns:

the value as a DoubleScalar

Throws:

ValueException - in case row or column is out of bounds

plus

public final A plus(R 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<AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,A extends AbstractFloatMatrixAbs<AU,RU,A,R,MA,S>,R extends AbstractFloatMatrixRel<RU,R,?,?>>

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 final A minus(R 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<AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,A extends AbstractFloatMatrixAbs<AU,RU,A,R,MA,S>,R extends AbstractFloatMatrixRel<RU,R,?,?>>

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 final R minus(A 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<AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,A extends AbstractFloatMatrixAbs<AU,RU,A,R,MA,S>,R extends AbstractFloatMatrixRel<RU,R,?,?>>

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

checkUnit

static <AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,S extends AbstractFloatScalarAbs<AU,S,RU,?>> AU checkUnit(S[][] dsArray)
                                                                                                                    throws ValueException

Check that a provided array can be used to create some descendant of a FloatMatrix, and return the Unit.

Type Parameters:

AU - the absolute unit

RU - the corresponding relative unit

S - the scalar type

Parameters:

dsArray - the array to check and get the unit for

Returns:

the unit of the object

Throws:

ValueException - when the array is null, has length equal to 0, or has first entry with length equal to 0

ensureRectangularAndNonEmpty

protected static <AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,S extends AbstractFloatScalarAbs<AU,S,RU,?>> void ensureRectangularAndNonEmpty(S[][] values)
                                                                                                                                                   throws ValueException

Check that a 2D array of FloatScalar<?> is rectangular; i.e. all rows have the same length and is non empty.

Type Parameters:

AU - the absolute unit

RU - the corresponding relative unit

S - the scalar type

Parameters:

values - FloatScalar<?>[][]; the 2D array to check

Throws:

ValueException - when values is not rectangular, or contains no data