org.djunits.value.vfloat.matrix

Class FloatDirectionMatrix

java.lang.Object

org.djunits.value.AbstractValue<U>

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

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

org.djunits.value.vfloat.matrix.TypedFloatMatrixAbs<AngleUnit,FloatDirectionMatrix,FloatAngleMatrix,MutableFloatDirectionMatrix,FloatDirection>

org.djunits.value.vfloat.matrix.FloatDirectionMatrix

All Implemented Interfaces:

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

public class FloatDirectionMatrix
extends TypedFloatMatrixAbs<AngleUnit,FloatDirectionMatrix,FloatAngleMatrix,MutableFloatDirectionMatrix,FloatDirection>

Immutable FloatDirection Matrix.

Copyright (c) 2013-2016 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

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
FloatDirectionMatrix(float[][] values, AngleUnit unit, StorageType storageType) Construct a new Absolute Immutable FloatDirectionMatrix.
FloatDirectionMatrix(FloatDirection[][] values, StorageType storageType) Construct a new Absolute Immutable FloatDirectionMatrix.
FloatDirectionMatrix(FloatMatrixData data, AngleUnit unit) Construct a new Absolute Immutable FloatDirectionMatrix.

Method Summary

Modifier and Type	Method and Description
FloatDirection	get(int row, int column) Retrieve the value stored at a specified row and column as a FloatScalar.
protected MutableFloatDirectionMatrix	instantiateMutableType(FloatMatrixData fmd, AngleUnit unit) Construct a new Absolute Mutable FloatMatrix of the right type.
protected FloatDirectionMatrix	instantiateTypeAbs(FloatMatrixData fmd, AngleUnit unit) Construct a new Absolute Immutable FloatMatrix of the right type.
protected FloatAngleMatrix	instantiateTypeRel(FloatMatrixData fmd, AngleUnit unit) Construct a new Relative Immutable FloatMatrix of the right type.
FloatAngleMatrix	toRel() Translate the absolute matrix into a relative matrix (e.g., before or after a multiplication or division).

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

minus, minus, mutable, plus, toDense, toSparse

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

minus, minus, plus

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

FloatDirectionMatrix

public FloatDirectionMatrix(float[][] values,
                            AngleUnit unit,
                            StorageType storageType)
                     throws ValueException

Construct a new Absolute Immutable FloatDirectionMatrix.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatDirectionMatrix

public FloatDirectionMatrix(FloatDirection[][] values,
                            StorageType storageType)
                     throws ValueException

Construct a new Absolute Immutable FloatDirectionMatrix.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatDirectionMatrix

FloatDirectionMatrix(FloatMatrixData data,
                     AngleUnit unit)

Construct a new Absolute Immutable FloatDirectionMatrix.

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateTypeAbs

protected final FloatDirectionMatrix instantiateTypeAbs(FloatMatrixData fmd,
                                                        AngleUnit unit)

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

Specified by:

instantiateTypeAbs in class TypedFloatMatrixAbs<AngleUnit,FloatDirectionMatrix,FloatAngleMatrix,MutableFloatDirectionMatrix,FloatDirection>

Parameters:

fmd - an internal data object

unit - the unit

Returns:

M the Mutable FloatMatrix of the right type

instantiateTypeRel

protected final FloatAngleMatrix instantiateTypeRel(FloatMatrixData fmd,
                                                    AngleUnit unit)

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

Specified by:

instantiateTypeRel in class TypedFloatMatrixAbs<AngleUnit,FloatDirectionMatrix,FloatAngleMatrix,MutableFloatDirectionMatrix,FloatDirection>

Parameters:

fmd - an internal data object

unit - the unit

Returns:

M the Mutable FloatMatrix of the right type

instantiateMutableType

protected final MutableFloatDirectionMatrix instantiateMutableType(FloatMatrixData fmd,
                                                                   AngleUnit unit)

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

Specified by:

instantiateMutableType in class TypedFloatMatrixAbs<AngleUnit,FloatDirectionMatrix,FloatAngleMatrix,MutableFloatDirectionMatrix,FloatDirection>

Parameters:

fmd - an internal data object

unit - the unit

Returns:

M the Mutable FloatMatrix of the right type

get

public final FloatDirection 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<AngleUnit>

Specified by:

get in class TypedFloatMatrixAbs<AngleUnit,FloatDirectionMatrix,FloatAngleMatrix,MutableFloatDirectionMatrix,FloatDirection>

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())

toRel

public final FloatAngleMatrix toRel()

Translate the absolute matrix into a relative matrix (e.g., before or after a multiplication or division).

Returns:

a relative version of this absolute FloatDirection matrix.