Package org.djunits.value.vfloat.matrix

Class FloatPositionMatrix

java.lang.Object

org.djunits.value.IndexedValue<U,S,M,DM>

org.djunits.value.base.Matrix<U,S,V,FloatVectorData,M,FloatMatrixData>

org.djunits.value.vfloat.matrix.base.FloatMatrix<AU,A,AV,AM>

org.djunits.value.vfloat.matrix.base.FloatMatrixAbs<PositionUnit,FloatPosition,FloatPositionVector,FloatPositionMatrix,LengthUnit,FloatLength,FloatLengthVector,FloatLengthMatrix>

org.djunits.value.vfloat.matrix.FloatPositionMatrix

All Implemented Interfaces:

Serializable, Cloneable, Absolute<PositionUnit,FloatPositionMatrix,LengthUnit,FloatLengthMatrix>, Value<PositionUnit,FloatPositionMatrix>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class FloatPositionMatrix
extends FloatMatrixAbs<PositionUnit,FloatPosition,FloatPositionVector,FloatPositionMatrix,LengthUnit,FloatLength,FloatLengthVector,FloatLengthMatrix>

Immutable FloatPosition Matrix.

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

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

• Serialized Form

Field Summary

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

data

Constructor Summary

Constructors

Constructor	Description
FloatPositionMatrix(float[][] data)	Construct a FloatPositionMatrix from a float[][] object with SI-unit values.
FloatPositionMatrix(float[][] data, PositionUnit displayUnit)	Construct a FloatPositionMatrix from a float[][] object.
FloatPositionMatrix(float[][] data, PositionUnit displayUnit, StorageType storageType)	Construct a FloatPositionMatrix from a float[][] object.
FloatPositionMatrix(float[][] data, StorageType storageType)	Construct a FloatPositionMatrix from a float[][] object with SI-unit values.
FloatPositionMatrix(Collection<FloatSparseValue<PositionUnit,FloatPosition>> data, int rows, int cols)	Construct a FloatPositionMatrix from a (sparse) collection of FloatSparseValue objects.
FloatPositionMatrix(Collection<FloatSparseValue<PositionUnit,FloatPosition>> data, int rows, int cols, StorageType storageType)	Construct a FloatPositionMatrix from a (sparse) collection of FloatSparseValue objects.
FloatPositionMatrix(Collection<FloatSparseValue<PositionUnit,FloatPosition>> data, PositionUnit displayUnit, int rows, int cols)	Construct a FloatPositionMatrix from a (sparse) collection of FloatSparseValue objects.
FloatPositionMatrix(Collection<FloatSparseValue<PositionUnit,FloatPosition>> data, PositionUnit displayUnit, int rows, int cols, StorageType storageType)	Construct a FloatPositionMatrix from a (sparse) collection of FloatSparseValue objects.
FloatPositionMatrix(FloatMatrixData data, PositionUnit displayUnit)	Construct a PositionMatrix from an internal data object.
FloatPositionMatrix(FloatPosition[][] data)	Construct a FloatPositionMatrix from an array of an array of FloatPosition objects.
FloatPositionMatrix(FloatPosition[][] data, PositionUnit displayUnit)	Construct a FloatPositionMatrix from an array of an array of FloatPosition objects.
FloatPositionMatrix(FloatPosition[][] data, PositionUnit displayUnit, StorageType storageType)	Construct a FloatPositionMatrix from an array of an array of FloatPosition objects.
FloatPositionMatrix(FloatPosition[][] data, StorageType storageType)	Construct a FloatPositionMatrix from an array of an array of FloatPosition objects.

Method Summary

Modifier and Type	Method	Description
Class<FloatPosition>	getScalarClass()	Return the class of the corresponding scalar.
Class<FloatPositionVector>	getVectorClass()	Return the class of the corresponding vector.
FloatPositionMatrix	instantiateMatrix(FloatMatrixData fmd, PositionUnit displayUnit)	Instantiate a new matrix of the class of this matrix.
FloatLengthMatrix	instantiateMatrixRel(FloatMatrixData fmd, LengthUnit displayUnit)	Instantiate a new relative matrix of the class of this absolute matrix.
FloatLength	instantiateScalarRelSI(float valueSI, LengthUnit displayUnit)	Instantiate a new relative scalar for the class of this absolute matrix.
FloatPosition	instantiateScalarSI(float valueSI, PositionUnit displayUnit)	Instantiate a new scalar for the class of this matrix.
FloatPositionVector	instantiateVector(FloatVectorData fvd, PositionUnit displayUnit)	Instantiate a new vector of the class of this matrix.
FloatLengthVector	instantiateVectorRel(FloatVectorData fvd, LengthUnit displayUnit)	Instantiate a new relative vector of the class of this absolute matrix.

Methods inherited from class org.djunits.value.vfloat.matrix.base.FloatMatrixAbs

decrementBy, decrementBy, minus, minus, plus

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

abs, assign, ceil, checkColumnIndex, checkIndex, checkRowIndex, checkSquare, cols, determinantSI, equals, floor, get, getColumn, getColumnScalars, getColumnSI, getData, getDiagonal, getDiagonalScalars, getDiagonalSI, getInUnit, getInUnit, getRow, getRowScalars, getRowSI, getScalars, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, neg, rint, rows, set, setData, setInUnit, setInUnit, setSI, toDense, toSparse, toString, toString, toString, toString

Methods inherited from class org.djunits.value.IndexedValue

cardinality, checkCopyOnWrite, clone, getDisplayUnit, getStorageType, immutable, isCopyOnWrite, isDense, isMutable, isSparse, mutable, setCopyOnWrite, setDisplayUnit, setMutable

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.djunits.value.Value

isAbsolute, isRelative

Constructor Details

FloatPositionMatrix

public FloatPositionMatrix(FloatMatrixData data,
 PositionUnit displayUnit)

Construct a PositionMatrix from an internal data object.

Parameters:

data - FloatMatrixData; the internal data object for the matrix

displayUnit - PositionUnit; the display unit of the matrix data

FloatPositionMatrix

public FloatPositionMatrix(float[][] data,
 PositionUnit displayUnit,
 StorageType storageType)

Construct a FloatPositionMatrix from a float[][] object. The float values are expressed in the displayUnit, and will be printed using the displayUnit.

Parameters:

data - float[][]; the data for the matrix, expressed in the displayUnit

displayUnit - PositionUnit; the unit of the values in the data array, and display unit when printing

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix

FloatPositionMatrix

public FloatPositionMatrix(float[][] data,
 PositionUnit displayUnit)

Construct a FloatPositionMatrix from a float[][] object. The float values are expressed in the displayUnit. Assume that the StorageType is DENSE since we offer the data as an array of an array.

Parameters:

data - float[][]; the data for the matrix

displayUnit - PositionUnit; the unit of the values in the data array, and display unit when printing

FloatPositionMatrix

public FloatPositionMatrix(float[][] data,
 StorageType storageType)

Construct a FloatPositionMatrix from a float[][] object with SI-unit values.

Parameters:

data - float[][]; the data for the matrix, in SI units

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix

FloatPositionMatrix

public FloatPositionMatrix(float[][] data)

Construct a FloatPositionMatrix from a float[][] object with SI-unit values. Assume that the StorageType is DENSE since we offer the data as an array of an array.

Parameters:

data - float[][]; the data for the matrix, in SI units

FloatPositionMatrix

public FloatPositionMatrix(FloatPosition[][] data,
 PositionUnit displayUnit,
 StorageType storageType)

Construct a FloatPositionMatrix from an array of an array of FloatPosition objects. The FloatPosition values are each expressed in their own unit, but will be internally stored as SI values, all expressed in the displayUnit when printing.

Parameters:

data - FloatPosition[][]; the data for the matrix

displayUnit - PositionUnit; the display unit of the values when printing

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix

FloatPositionMatrix

public FloatPositionMatrix(FloatPosition[][] data,
 PositionUnit displayUnit)

Construct a FloatPositionMatrix from an array of an array of FloatPosition objects. The FloatPosition values are each expressed in their own unit, but will be internally stored as SI values, all expressed in the displayUnit when printing. Assume that the StorageType is DENSE since we offer the data as an array of an array.

Parameters:

data - FloatPosition[][]; the data for the matrix

displayUnit - PositionUnit; the display unit of the values when printing

FloatPositionMatrix

public FloatPositionMatrix(FloatPosition[][] data,
 StorageType storageType)

Construct a FloatPositionMatrix from an array of an array of FloatPosition objects. The FloatPosition values are each expressed in their own unit, but will be internally stored as SI values, and expressed using SI units when printing. since we offer the data as an array of an array.

Parameters:

data - FloatPosition[][]; the data for the matrix

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix

FloatPositionMatrix

public FloatPositionMatrix(FloatPosition[][] data)

Construct a FloatPositionMatrix from an array of an array of FloatPosition objects. The FloatPosition values are each expressed in their own unit, but will be internally stored as SI values, and expressed using SI units when printing. Assume that the StorageType is DENSE since we offer the data as an array of an array.

Parameters:

data - FloatPosition[][]; the data for the matrix

FloatPositionMatrix

public FloatPositionMatrix(Collection<FloatSparseValue<PositionUnit,FloatPosition>> data,
 PositionUnit displayUnit,
 int rows,
 int cols,
 StorageType storageType)

Construct a FloatPositionMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit indicates the unit in which the values in the collection are expressed, as well as the unit in which they will be printed.

Parameters:

data - Collection<FloatSparseValue>; the data for the matrix

displayUnit - PositionUnit; the display unit of the matrix data, and the unit of the data points

rows - int; the number of rows of the matrix

cols - int; the number of columns of the matrix

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix

FloatPositionMatrix

public FloatPositionMatrix(Collection<FloatSparseValue<PositionUnit,FloatPosition>> data,
 PositionUnit displayUnit,
 int rows,
 int cols)

Construct a FloatPositionMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit indicates the unit in which the values in the collection are expressed, as well as the unit in which they will be printed. Assume the storage type is SPARSE, since we offer the data as a collection.

Parameters:

data - Collection<FloatSparseValue>; the data for the matrix

displayUnit - PositionUnit; the display unit of the matrix data, and the unit of the data points

rows - int; the number of rows of the matrix

cols - int; the number of columns of the matrix

FloatPositionMatrix

public FloatPositionMatrix(Collection<FloatSparseValue<PositionUnit,FloatPosition>> data,
 int rows,
 int cols,
 StorageType storageType)

Construct a FloatPositionMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit indicates the unit in which the values in the collection are expressed, as well as the unit in which they will be printed. Use the SI unit or base unit as the displayUnit.

Parameters:

data - Collection<FloatSparseValue>; the data for the matrix

rows - int; the number of rows of the matrix

cols - int; the number of columns of the matrix

storageType - StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix

FloatPositionMatrix

public FloatPositionMatrix(Collection<FloatSparseValue<PositionUnit,FloatPosition>> data,
 int rows,
 int cols)

Construct a FloatPositionMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit indicates the unit in which the values in the collection are expressed, as well as the unit in which they will be printed. Use the SI unit or base unit as the displayUnit. Assume the storage type is SPARSE, since we offer the data as a collection.

Parameters:

data - Collection<FloatSparseValue>; the data for the matrix

rows - int; the number of rows of the matrix

cols - int; the number of columns of the matrix

Method Details

getScalarClass

public Class<FloatPosition> getScalarClass()

Return the class of the corresponding scalar.

Specified by:

getScalarClass in class IndexedValue<PositionUnit,FloatPosition,FloatPositionMatrix,FloatMatrixData>

Returns:

Class<S>; the class of the corresponding scalar

getVectorClass

public Class<FloatPositionVector> getVectorClass()

Return the class of the corresponding vector.

Specified by:

getVectorClass in class Matrix<PositionUnit,FloatPosition,FloatPositionVector,FloatVectorData,FloatPositionMatrix,FloatMatrixData>

Returns:

Class<V>; the class of the corresponding vector

instantiateMatrix

public FloatPositionMatrix instantiateMatrix(FloatMatrixData fmd,
 PositionUnit displayUnit)

Instantiate a new matrix of the class of this matrix. This can be used instead of the FloatMatrix.instiantiate() methods in case another matrix of this class is known. The method is faster than FloatMatrix.instantiate, and it will also work if the matrix is user-defined.

Specified by:

instantiateMatrix in class FloatMatrix<PositionUnit,FloatPosition,FloatPositionVector,FloatPositionMatrix>

Parameters:

fmd - FloatMatrixData; the data used to instantiate the matrix

displayUnit - U; the display unit of the matrix

Returns:

V; a matrix of the correct type

instantiateVector

public FloatPositionVector instantiateVector(FloatVectorData fvd,
 PositionUnit displayUnit)

Instantiate a new vector of the class of this matrix. This can be used instead of the FloatVector.instiantiate() methods in case another matrix of this class is known. The method is faster than FloatVector.instantiate, and it will also work if the matrix and/or vector are user-defined.

Specified by:

instantiateVector in class FloatMatrix<PositionUnit,FloatPosition,FloatPositionVector,FloatPositionMatrix>

Parameters:

fvd - FloatVectorData; the data used to instantiate the vector

displayUnit - U; the display unit of the vector

Returns:

V; a vector of the correct type

instantiateScalarSI

public FloatPosition instantiateScalarSI(float valueSI,
 PositionUnit displayUnit)

Instantiate a new scalar for the class of this matrix. This can be used instead of the FloatScalar.instiantiate() methods in case a matrix of this class is known. The method is faster than FloatScalar.instantiate, and it will also work if the matrix and/or scalar are user-defined.

Specified by:

instantiateScalarSI in class FloatMatrix<PositionUnit,FloatPosition,FloatPositionVector,FloatPositionMatrix>

Parameters:

valueSI - float; the SI value of the scalar

displayUnit - U; the unit in which the value will be displayed

Returns:

S; a scalar of the correct type, belonging to the matrix type

instantiateMatrixRel

public FloatLengthMatrix instantiateMatrixRel(FloatMatrixData fmd,
 LengthUnit displayUnit)

Instantiate a new relative matrix of the class of this absolute matrix. This can be used instead of the FloatMatrix.instiantiate() methods in case another matrix of this absolute matrix class is known. The method is faster than FloatMatrix.instantiate, and it will also work if the matrix is user-defined.

Specified by:

instantiateMatrixRel in class FloatMatrixAbs<PositionUnit,FloatPosition,FloatPositionVector,FloatPositionMatrix,LengthUnit,FloatLength,FloatLengthVector,FloatLengthMatrix>

Parameters:

fmd - FloatMatrixData; the data used to instantiate the matrix

displayUnit - RU; the display unit of the relative matrix

Returns:

RM; a relative matrix of the correct type, belonging to this absolute matrix type

instantiateVectorRel

public FloatLengthVector instantiateVectorRel(FloatVectorData fvd,
 LengthUnit displayUnit)

Instantiate a new relative vector of the class of this absolute matrix. This can be used instead of the FloatVector.instiantiate() methods in case another matrix of this absolute matrix class is known. The method is faster than FloatVector.instantiate, and it will also work if the matrix or vector is user-defined.

Specified by:

instantiateVectorRel in class FloatMatrixAbs<PositionUnit,FloatPosition,FloatPositionVector,FloatPositionMatrix,LengthUnit,FloatLength,FloatLengthVector,FloatLengthMatrix>

Parameters:

fvd - FloatVectorData; the data used to instantiate the vector

displayUnit - RU; the display unit of the relative vector

Returns:

RV; a relative vector of the correct type, belonging to this absolute matrix type

instantiateScalarRelSI

public FloatLength instantiateScalarRelSI(float valueSI,
 LengthUnit displayUnit)

Instantiate a new relative scalar for the class of this absolute matrix. This can be used instead of the FloatScalar.instiantiate() methods in case a matrix of this class is known. The method is faster than FloatScalar.instantiate, and it will also work if the matrix and/or scalar are user-defined.

Specified by:

instantiateScalarRelSI in class FloatMatrixAbs<PositionUnit,FloatPosition,FloatPositionVector,FloatPositionMatrix,LengthUnit,FloatLength,FloatLengthVector,FloatLengthMatrix>

Parameters:

valueSI - float; the SI value of the relative scalar

displayUnit - RU; the unit in which the relative value will be displayed

Returns:

R; a relative scalar of the correct type, belonging to this absolute matrix type