Package org.djunits.value.vfloat.matrix

Class FloatDimensionlessMatrix

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<U,S,RV,RM>

org.djunits.value.vfloat.matrix.base.FloatMatrixRel<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector,FloatDimensionlessMatrix>

org.djunits.value.vfloat.matrix.FloatDimensionlessMatrix

All Implemented Interfaces:

Serializable, Cloneable, DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>, Relative<DimensionlessUnit,FloatDimensionlessMatrix>, Value<DimensionlessUnit,FloatDimensionlessMatrix>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class FloatDimensionlessMatrix
extends FloatMatrixRel<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector,FloatDimensionlessMatrix>
implements DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Immutable FloatFloatDimensionlessMatrix, a matrix of values with a DimensionlessUnit.

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
FloatDimensionlessMatrix(float[][] data)	Construct a FloatDimensionlessMatrix from a float[][] object with SI-unit values.
FloatDimensionlessMatrix(float[][] data, DimensionlessUnit displayUnit)	Construct a FloatDimensionlessMatrix from a float[][] object.
FloatDimensionlessMatrix(float[][] data, DimensionlessUnit displayUnit, StorageType storageType)	Construct a FloatDimensionlessMatrix from a float[][] object.
FloatDimensionlessMatrix(float[][] data, StorageType storageType)	Construct a FloatDimensionlessMatrix from a float[][] object with SI-unit values.
FloatDimensionlessMatrix(Collection<FloatSparseValue<DimensionlessUnit,FloatDimensionless>> data, int rows, int cols)	Construct a FloatDimensionlessMatrix from a (sparse) collection of FloatSparseValue objects.
FloatDimensionlessMatrix(Collection<FloatSparseValue<DimensionlessUnit,FloatDimensionless>> data, int rows, int cols, StorageType storageType)	Construct a FloatDimensionlessMatrix from a (sparse) collection of FloatSparseValue objects.
FloatDimensionlessMatrix(Collection<FloatSparseValue<DimensionlessUnit,FloatDimensionless>> data, DimensionlessUnit displayUnit, int rows, int cols)	Construct a FloatDimensionlessMatrix from a (sparse) collection of FloatSparseValue objects.
FloatDimensionlessMatrix(Collection<FloatSparseValue<DimensionlessUnit,FloatDimensionless>> data, DimensionlessUnit displayUnit, int rows, int cols, StorageType storageType)	Construct a FloatDimensionlessMatrix from a (sparse) collection of FloatSparseValue objects.
FloatDimensionlessMatrix(FloatMatrixData data, DimensionlessUnit displayUnit)	Construct a FloatDimensionlessMatrix from an internal data object.
FloatDimensionlessMatrix(FloatDimensionless[][] data)	Construct a FloatDimensionlessMatrix from an array of an array of FloatDimensionless objects.
FloatDimensionlessMatrix(FloatDimensionless[][] data, DimensionlessUnit displayUnit)	Construct a FloatDimensionlessMatrix from an array of an array of FloatDimensionless objects.
FloatDimensionlessMatrix(FloatDimensionless[][] data, DimensionlessUnit displayUnit, StorageType storageType)	Construct a FloatDimensionlessMatrix from an array of an array of FloatDimensionless objects.
FloatDimensionlessMatrix(FloatDimensionless[][] data, StorageType storageType)	Construct a FloatDimensionlessMatrix from an array of an array of FloatDimensionless objects.

Method Summary

Modifier and Type	Method	Description
final FloatDimensionlessMatrix	acos()	Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.
final FloatDimensionlessMatrix	asin()	Set the value(s) to the arc sine of the value(s); the resulting angle is in the range -pi/2 through pi/2.
final FloatDimensionlessMatrix	atan()	Set the value(s) to the arc tangent of the value(s); the resulting angle is in the range -pi/2 through pi/2.
final FloatDimensionlessMatrix	cbrt()	Set the value(s) to the(ir) cube root.
final FloatDimensionlessMatrix	cos()	Set the value(s) to the trigonometric cosine of the value(s).
final FloatDimensionlessMatrix	cosh()	Set the value(s) to the hyperbolic cosine of the value(s).
final FloatDimensionlessMatrix	exp()	Set the value(s) to Euler's number e raised to the power of the value(s).
final FloatDimensionlessMatrix	expm1()	Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
Class<FloatDimensionless>	getScalarClass()	Return the class of the corresponding scalar.
Class<FloatDimensionlessVector>	getVectorClass()	Return the class of the corresponding vector.
FloatDimensionlessMatrix	instantiateMatrix(FloatMatrixData fmd, DimensionlessUnit displayUnit)	Instantiate a new matrix of the class of this matrix.
FloatDimensionless	instantiateScalarSI(float valueSI, DimensionlessUnit displayUnit)	Instantiate a new scalar for the class of this matrix.
FloatDimensionlessVector	instantiateVector(FloatVectorData fvd, DimensionlessUnit displayUnit)	Instantiate a new vector of the class of this matrix.
final FloatDimensionlessMatrix	inv()	Set the value(s) to the complement (1.0/x) of the value(s).
final FloatDimensionlessMatrix	log()	Set the value(s) to the natural logarithm (base e) of the value(s).
final FloatDimensionlessMatrix	log10()	Set the value(s) to the base 10 logarithm of the value(s).
final FloatDimensionlessMatrix	log1p()	Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
final FloatDimensionlessMatrix	pow(double x)	Set the value(s) to the value(s) raised to the power of the argument.
final FloatDimensionlessMatrix	signum()	Set the value(s) to the signum function of the value(s); zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.
final FloatDimensionlessMatrix	sin()	Set the value(s) to the trigonometric sine of the value(s).
final FloatDimensionlessMatrix	sinh()	Set the value(s) to the hyperbolic sine of the value(s).
final FloatDimensionlessMatrix	sqrt()	Set the value(s) to the correctly rounded positive square root of the value(s).
final FloatDimensionlessMatrix	tan()	Set the value(s) to the trigonometric tangent of the value(s).
final FloatDimensionlessMatrix	tanh()	Set the value(s) to the hyperbolic tangent of the value(s).

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

decrementBy, decrementBy, divide, divide, divide, divideBy, divideBy, incrementBy, incrementBy, minus, multiplyBy, multiplyBy, plus, times, times, times, zSum

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

FloatDimensionlessMatrix

public FloatDimensionlessMatrix(FloatMatrixData data,
 DimensionlessUnit displayUnit)

Construct a FloatDimensionlessMatrix from an internal data object.

Parameters:

data - FloatMatrixData; the internal data object for the matrix

displayUnit - DimensionlessUnit; the display unit of the matrix data

FloatDimensionlessMatrix

public FloatDimensionlessMatrix(float[][] data,
 DimensionlessUnit displayUnit,
 StorageType storageType)

Construct a FloatDimensionlessMatrix 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 - DimensionlessUnit; 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

FloatDimensionlessMatrix

public FloatDimensionlessMatrix(float[][] data,
 DimensionlessUnit displayUnit)

Construct a FloatDimensionlessMatrix 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 - DimensionlessUnit; the unit of the values in the data array, and display unit when printing

FloatDimensionlessMatrix

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

Construct a FloatDimensionlessMatrix 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

FloatDimensionlessMatrix

public FloatDimensionlessMatrix(float[][] data)

Construct a FloatDimensionlessMatrix 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

FloatDimensionlessMatrix

public FloatDimensionlessMatrix(FloatDimensionless[][] data,
 DimensionlessUnit displayUnit,
 StorageType storageType)

Construct a FloatDimensionlessMatrix from an array of an array of FloatDimensionless objects. The FloatDimensionless 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 - FloatDimensionless[][]; the data for the matrix

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

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

FloatDimensionlessMatrix

public FloatDimensionlessMatrix(FloatDimensionless[][] data,
 DimensionlessUnit displayUnit)

Construct a FloatDimensionlessMatrix from an array of an array of FloatDimensionless objects. The FloatDimensionless 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 - FloatDimensionless[][]; the data for the matrix

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

FloatDimensionlessMatrix

public FloatDimensionlessMatrix(FloatDimensionless[][] data,
 StorageType storageType)

Construct a FloatDimensionlessMatrix from an array of an array of FloatDimensionless objects. The FloatDimensionless 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 - FloatDimensionless[][]; the data for the matrix

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

FloatDimensionlessMatrix

public FloatDimensionlessMatrix(FloatDimensionless[][] data)

Construct a FloatDimensionlessMatrix from an array of an array of FloatDimensionless objects. The FloatDimensionless 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 - FloatDimensionless[][]; the data for the matrix

FloatDimensionlessMatrix

public FloatDimensionlessMatrix(Collection<FloatSparseValue<DimensionlessUnit,FloatDimensionless>> data,
 DimensionlessUnit displayUnit,
 int rows,
 int cols,
 StorageType storageType)

Construct a FloatDimensionlessMatrix 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 - DimensionlessUnit; 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

FloatDimensionlessMatrix

public FloatDimensionlessMatrix(Collection<FloatSparseValue<DimensionlessUnit,FloatDimensionless>> data,
 DimensionlessUnit displayUnit,
 int rows,
 int cols)

Construct a FloatDimensionlessMatrix 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 - DimensionlessUnit; 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

FloatDimensionlessMatrix

public FloatDimensionlessMatrix(Collection<FloatSparseValue<DimensionlessUnit,FloatDimensionless>> data,
 int rows,
 int cols,
 StorageType storageType)

Construct a FloatDimensionlessMatrix 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

FloatDimensionlessMatrix

public FloatDimensionlessMatrix(Collection<FloatSparseValue<DimensionlessUnit,FloatDimensionless>> data,
 int rows,
 int cols)

Construct a FloatDimensionlessMatrix 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<FloatDimensionless> getScalarClass()

Return the class of the corresponding scalar.

Specified by:

getScalarClass in class IndexedValue<DimensionlessUnit,FloatDimensionless,FloatDimensionlessMatrix,FloatMatrixData>

Returns:

Class<S>; the class of the corresponding scalar

getVectorClass

public Class<FloatDimensionlessVector> getVectorClass()

Return the class of the corresponding vector.

Specified by:

getVectorClass in class Matrix<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector,FloatVectorData,FloatDimensionlessMatrix,FloatMatrixData>

Returns:

Class<V>; the class of the corresponding vector

instantiateMatrix

public FloatDimensionlessMatrix instantiateMatrix(FloatMatrixData fmd,
 DimensionlessUnit 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<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector,FloatDimensionlessMatrix>

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 FloatDimensionlessVector instantiateVector(FloatVectorData fvd,
 DimensionlessUnit 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<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector,FloatDimensionlessMatrix>

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 FloatDimensionless instantiateScalarSI(float valueSI,
 DimensionlessUnit 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<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector,FloatDimensionlessMatrix>

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

acos

public final FloatDimensionlessMatrix acos()

Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.

Specified by:

acos in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Returns:

T; the modified T

asin

public final FloatDimensionlessMatrix asin()

Set the value(s) to the arc sine of the value(s); the resulting angle is in the range -pi/2 through pi/2.

Specified by:

asin in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Returns:

T; the modified T

atan

public final FloatDimensionlessMatrix atan()

Set the value(s) to the arc tangent of the value(s); the resulting angle is in the range -pi/2 through pi/2.

Specified by:

atan in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Returns:

T; the modified T

cbrt

public final FloatDimensionlessMatrix cbrt()

Set the value(s) to the(ir) cube root.

Specified by:

cbrt in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Returns:

T; the modified T

cos

public final FloatDimensionlessMatrix cos()

Set the value(s) to the trigonometric cosine of the value(s).

Specified by:

cos in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Returns:

T; the modified T

cosh

public final FloatDimensionlessMatrix cosh()

Set the value(s) to the hyperbolic cosine of the value(s).

Specified by:

cosh in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Returns:

T; the modified T

exp

public final FloatDimensionlessMatrix exp()

Set the value(s) to Euler's number e raised to the power of the value(s).

Specified by:

exp in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Returns:

T; the modified T

expm1

public final FloatDimensionlessMatrix expm1()

Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).

Specified by:

expm1 in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Returns:

T; the modified T

log

public final FloatDimensionlessMatrix log()

Set the value(s) to the natural logarithm (base e) of the value(s).

Specified by:

log in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Returns:

T; the modified T

log10

public final FloatDimensionlessMatrix log10()

Set the value(s) to the base 10 logarithm of the value(s).

Specified by:

log10 in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Returns:

T; the modified T

log1p

public final FloatDimensionlessMatrix log1p()

Set the value(s) to the natural logarithm of the sum of the value(s) and 1.

Specified by:

log1p in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Returns:

T; the modified T

pow

public final FloatDimensionlessMatrix pow(double x)

Set the value(s) to the value(s) raised to the power of the argument.

Specified by:

pow in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Parameters:

x - double; the value to use as the power

Returns:

T; the modified T

signum

public final FloatDimensionlessMatrix signum()

Set the value(s) to the signum function of the value(s); zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.

Specified by:

signum in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Returns:

T; the modified T

sin

public final FloatDimensionlessMatrix sin()

Set the value(s) to the trigonometric sine of the value(s).

Specified by:

sin in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Returns:

T; the modified T

sinh

public final FloatDimensionlessMatrix sinh()

Set the value(s) to the hyperbolic sine of the value(s).

Specified by:

sinh in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Returns:

T; the modified T

sqrt

public final FloatDimensionlessMatrix sqrt()

Set the value(s) to the correctly rounded positive square root of the value(s).

Specified by:

sqrt in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Returns:

T; the modified T

tan

public final FloatDimensionlessMatrix tan()

Set the value(s) to the trigonometric tangent of the value(s).

Specified by:

tan in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Returns:

T; the modified T

tanh

public final FloatDimensionlessMatrix tanh()

Set the value(s) to the hyperbolic tangent of the value(s).

Specified by:

tanh in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Returns:

T; the modified T

inv

public final FloatDimensionlessMatrix inv()

Set the value(s) to the complement (1.0/x) of the value(s).

Specified by:

inv in interface DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Returns:

T; the modified T