org.djunits.value.vfloat.matrix

Class FloatPositionMatrix

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vfloat.matrix.AbstractFloatMatrixAbs<PositionUnit,LengthUnit,FloatPositionMatrix,FloatLengthMatrix,MutableFloatPositionMatrix,FloatPosition>

org.djunits.value.vfloat.matrix.FloatPositionMatrix

All Implemented Interfaces:

Serializable, Absolute, FunctionsAbs<PositionUnit,LengthUnit,FloatPositionMatrix,FloatLengthMatrix>, Value<PositionUnit>, FloatMatrixInterface<PositionUnit>

public class FloatPositionMatrix
extends AbstractFloatMatrixAbs<PositionUnit,LengthUnit,FloatPositionMatrix,FloatLengthMatrix,MutableFloatPositionMatrix,FloatPosition>

Immutable FloatPosition 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

See Also:

Serialized Form

Field Summary

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

data

Constructor Summary

Constructors

Constructor and Description
FloatPositionMatrix(float[][] values, PositionUnit unit, StorageType storageType) Construct a new Absolute Immutable FloatPositionMatrix.
FloatPositionMatrix(FloatMatrixData data, PositionUnit unit) Construct a new Absolute Immutable FloatPositionMatrix.
FloatPositionMatrix(FloatPosition[][] values, StorageType storageType) Construct a new Absolute Immutable FloatPositionMatrix.

Method Summary

Modifier and Type	Method and Description
protected MutableFloatPositionMatrix	instantiateMutableType(FloatMatrixData fmd, PositionUnit unit) Construct a new Absolute Mutable FloatMatrix of the right type.
protected FloatPosition	instantiateScalar(float value, PositionUnit unit) Construct a new Absolute Immutable FloatScalar of the right type.
protected FloatPositionMatrix	instantiateTypeAbs(FloatMatrixData fmd, PositionUnit unit) Construct a new Absolute Immutable FloatMatrix of the right type.
protected FloatLengthMatrix	instantiateTypeRel(FloatMatrixData fmd, LengthUnit unit) Construct a new Relative Immutable FloatMatrix of the right type.
FloatPositionMatrix	toDense() Create a dense version of this FloatMatrix.
FloatPositionMatrix	toSparse() Create a sparse version of this FloatMatrix.

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

checkUnit, ensureRectangularAndNonEmpty, get, minus, minus, mutable, plus

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, toString, toString, toString, toString, zSum

Constructor Detail

FloatPositionMatrix

public FloatPositionMatrix(float[][] values,
                           PositionUnit unit,
                           StorageType storageType)
                    throws ValueException

Construct a new Absolute Immutable FloatPositionMatrix.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatPositionMatrix

public FloatPositionMatrix(FloatPosition[][] values,
                           StorageType storageType)
                    throws ValueException

Construct a new Absolute Immutable FloatPositionMatrix.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

FloatPositionMatrix

FloatPositionMatrix(FloatMatrixData data,
                    PositionUnit unit)

Construct a new Absolute Immutable FloatPositionMatrix.

Parameters:

data - an internal data object

unit - the unit

Method Detail

toDense

public final FloatPositionMatrix toDense()

Create a dense version of this FloatMatrix.

Returns:

MutableFloatMatrix<U>; dense version of this FloatMatrix

toSparse

public final FloatPositionMatrix toSparse()

Create a sparse version of this FloatMatrix.

Returns:

MutableFloatMatrix<U>; sparse version of this FloatMatrix

instantiateTypeAbs

protected final FloatPositionMatrix instantiateTypeAbs(FloatMatrixData fmd,
                                                       PositionUnit unit)

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

Specified by:

instantiateTypeAbs in class AbstractFloatMatrixAbs<PositionUnit,LengthUnit,FloatPositionMatrix,FloatLengthMatrix,MutableFloatPositionMatrix,FloatPosition>

Parameters:

fmd - an internal data object

unit - the unit

Returns:

M the Mutable FloatMatrix of the right type

instantiateTypeRel

protected final FloatLengthMatrix instantiateTypeRel(FloatMatrixData fmd,
                                                     LengthUnit unit)

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

Specified by:

instantiateTypeRel in class AbstractFloatMatrixAbs<PositionUnit,LengthUnit,FloatPositionMatrix,FloatLengthMatrix,MutableFloatPositionMatrix,FloatPosition>

Parameters:

fmd - an internal data object

unit - the unit

Returns:

M the Mutable FloatMatrix of the right type

instantiateMutableType

protected final MutableFloatPositionMatrix instantiateMutableType(FloatMatrixData fmd,
                                                                  PositionUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatMatrixAbs<PositionUnit,LengthUnit,FloatPositionMatrix,FloatLengthMatrix,MutableFloatPositionMatrix,FloatPosition>

Parameters:

fmd - an internal data object

unit - the unit

Returns:

M the Mutable FloatMatrix of the right type

instantiateScalar

protected final FloatPosition instantiateScalar(float value,
                                                PositionUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatMatrixAbs<PositionUnit,LengthUnit,FloatPositionMatrix,FloatLengthMatrix,MutableFloatPositionMatrix,FloatPosition>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable FloatScalar of the right type