Package org.djunits.value.vdouble.matrix

Class DimensionlessMatrix

java.lang.Object

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

org.djunits.value.base.Matrix<U,S,V,DoubleVectorData,M,DoubleMatrixData>

org.djunits.value.vdouble.matrix.base.DoubleMatrix<U,S,RV,RM>

org.djunits.value.vdouble.matrix.base.DoubleMatrixRel<DimensionlessUnit,Dimensionless,DimensionlessVector,DimensionlessMatrix>

org.djunits.value.vdouble.matrix.DimensionlessMatrix

All Implemented Interfaces:

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

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class DimensionlessMatrix
extends DoubleMatrixRel<DimensionlessUnit,Dimensionless,DimensionlessVector,DimensionlessMatrix>
implements DimensionlessFunctions<DimensionlessUnit,DimensionlessMatrix>

Immutable Double DimensionlessMatrix, a matrix of values with a DimensionlessUnit.

Copyright (c) 2013-2025 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.vdouble.matrix.base.DoubleMatrix

data

Constructor Summary

Constructors

Constructor	Description
DimensionlessMatrix(double[][] data)	Construct a DimensionlessMatrix from a double[][] object with SI-unit values.
DimensionlessMatrix(double[][] data, DimensionlessUnit displayUnit)	Construct a DimensionlessMatrix from a double[][] object.
DimensionlessMatrix(double[][] data, DimensionlessUnit displayUnit, StorageType storageType)	Construct a DimensionlessMatrix from a double[][] object.
DimensionlessMatrix(double[][] data, StorageType storageType)	Construct a DimensionlessMatrix from a double[][] object with SI-unit values.
DimensionlessMatrix(Collection<DoubleSparseValue<DimensionlessUnit,Dimensionless>> data, int rows, int cols)	Construct a DimensionlessMatrix from a (sparse) collection of DoubleSparseValue objects.
DimensionlessMatrix(Collection<DoubleSparseValue<DimensionlessUnit,Dimensionless>> data, int rows, int cols, StorageType storageType)	Construct a DimensionlessMatrix from a (sparse) collection of DoubleSparseValue objects.
DimensionlessMatrix(Collection<DoubleSparseValue<DimensionlessUnit,Dimensionless>> data, DimensionlessUnit displayUnit, int rows, int cols)	Construct a DimensionlessMatrix from a (sparse) collection of DoubleSparseValue objects.
DimensionlessMatrix(Collection<DoubleSparseValue<DimensionlessUnit,Dimensionless>> data, DimensionlessUnit displayUnit, int rows, int cols, StorageType storageType)	Construct a DimensionlessMatrix from a (sparse) collection of DoubleSparseValue objects.
DimensionlessMatrix(DoubleMatrixData data, DimensionlessUnit displayUnit)	Construct a DimensionlessMatrix from an internal data object.
DimensionlessMatrix(Dimensionless[][] data)	Construct a DimensionlessMatrix from an array of an array of Dimensionless objects.
DimensionlessMatrix(Dimensionless[][] data, DimensionlessUnit displayUnit)	Construct a DimensionlessMatrix from an array of an array of Dimensionless objects.
DimensionlessMatrix(Dimensionless[][] data, DimensionlessUnit displayUnit, StorageType storageType)	Construct a DimensionlessMatrix from an array of an array of Dimensionless objects.
DimensionlessMatrix(Dimensionless[][] data, StorageType storageType)	Construct a DimensionlessMatrix from an array of an array of Dimensionless objects.

Method Summary

Modifier and Type	Method	Description
final DimensionlessMatrix	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 DimensionlessMatrix	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 DimensionlessMatrix	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 DimensionlessMatrix	cbrt()	Set the value(s) to the(ir) cube root.
final DimensionlessMatrix	cos()	Set the value(s) to the trigonometric cosine of the value(s).
final DimensionlessMatrix	cosh()	Set the value(s) to the hyperbolic cosine of the value(s).
final DimensionlessMatrix	exp()	Set the value(s) to Euler's number e raised to the power of the value(s).
final DimensionlessMatrix	expm1()	Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
Class<Dimensionless>	getScalarClass()	Return the class of the corresponding scalar.
Class<DimensionlessVector>	getVectorClass()	Return the class of the corresponding vector.
DimensionlessMatrix	instantiateMatrix(DoubleMatrixData dmd, DimensionlessUnit displayUnit)	Instantiate a new matrix of the class of this matrix.
Dimensionless	instantiateScalarSI(double valueSI, DimensionlessUnit displayUnit)	Instantiate a new scalar for the class of this matrix.
DimensionlessVector	instantiateVector(DoubleVectorData dvd, DimensionlessUnit displayUnit)	Instantiate a new vector of the class of this matrix.
final DimensionlessMatrix	inv()	Set the value(s) to the complement (1.0/x) of the value(s).
final DimensionlessMatrix	log()	Set the value(s) to the natural logarithm (base e) of the value(s).
final DimensionlessMatrix	log10()	Set the value(s) to the base 10 logarithm of the value(s).
final DimensionlessMatrix	log1p()	Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
final DimensionlessMatrix	pow(double x)	Set the value(s) to the value(s) raised to the power of the argument.
final DimensionlessMatrix	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 DimensionlessMatrix	sin()	Set the value(s) to the trigonometric sine of the value(s).
final DimensionlessMatrix	sinh()	Set the value(s) to the hyperbolic sine of the value(s).
final DimensionlessMatrix	sqrt()	Set the value(s) to the correctly rounded positive square root of the value(s).
final DimensionlessMatrix	tan()	Set the value(s) to the trigonometric tangent of the value(s).
final DimensionlessMatrix	tanh()	Set the value(s) to the hyperbolic tangent of the value(s).

Methods inherited from class org.djunits.value.vdouble.matrix.base.DoubleMatrixRel

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

Methods inherited from class org.djunits.value.vdouble.matrix.base.DoubleMatrix

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

DimensionlessMatrix

public DimensionlessMatrix(DoubleMatrixData data,
 DimensionlessUnit displayUnit)

Construct a DimensionlessMatrix from an internal data object.

Parameters:

data - the internal data object for the matrix

displayUnit - the display unit of the matrix data

DimensionlessMatrix

public DimensionlessMatrix(double[][] data,
 DimensionlessUnit displayUnit,
 StorageType storageType)

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

Parameters:

data - the data for the matrix, expressed in the displayUnit

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

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

DimensionlessMatrix

public DimensionlessMatrix(double[][] data,
 DimensionlessUnit displayUnit)

Construct a DimensionlessMatrix from a double[][] object. The double 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 - the data for the matrix

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

DimensionlessMatrix

public DimensionlessMatrix(double[][] data,
 StorageType storageType)

Construct a DimensionlessMatrix from a double[][] object with SI-unit values.

Parameters:

data - the data for the matrix, in SI units

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

DimensionlessMatrix

public DimensionlessMatrix(double[][] data)

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

Parameters:

data - the data for the matrix, in SI units

DimensionlessMatrix

public DimensionlessMatrix(Dimensionless[][] data,
 DimensionlessUnit displayUnit,
 StorageType storageType)

Construct a DimensionlessMatrix from an array of an array of Dimensionless objects. The Dimensionless 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 - the data for the matrix

displayUnit - the display unit of the values when printing

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

DimensionlessMatrix

public DimensionlessMatrix(Dimensionless[][] data,
 DimensionlessUnit displayUnit)

Construct a DimensionlessMatrix from an array of an array of Dimensionless objects. The Dimensionless 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 - the data for the matrix

displayUnit - the display unit of the values when printing

DimensionlessMatrix

public DimensionlessMatrix(Dimensionless[][] data,
 StorageType storageType)

Construct a DimensionlessMatrix from an array of an array of Dimensionless objects. The Dimensionless 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 - the data for the matrix

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

DimensionlessMatrix

public DimensionlessMatrix(Dimensionless[][] data)

Construct a DimensionlessMatrix from an array of an array of Dimensionless objects. The Dimensionless 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 - the data for the matrix

DimensionlessMatrix

public DimensionlessMatrix(Collection<DoubleSparseValue<DimensionlessUnit,Dimensionless>> data,
 DimensionlessUnit displayUnit,
 int rows,
 int cols,
 StorageType storageType)

Construct a DimensionlessMatrix from a (sparse) collection of DoubleSparseValue 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 - the data for the matrix

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

rows - the number of rows of the matrix

cols - the number of columns of the matrix

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

DimensionlessMatrix

public DimensionlessMatrix(Collection<DoubleSparseValue<DimensionlessUnit,Dimensionless>> data,
 DimensionlessUnit displayUnit,
 int rows,
 int cols)

Construct a DimensionlessMatrix from a (sparse) collection of DoubleSparseValue 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 - the data for the matrix

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

rows - the number of rows of the matrix

cols - the number of columns of the matrix

DimensionlessMatrix

public DimensionlessMatrix(Collection<DoubleSparseValue<DimensionlessUnit,Dimensionless>> data,
 int rows,
 int cols,
 StorageType storageType)

Construct a DimensionlessMatrix from a (sparse) collection of DoubleSparseValue 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 - the data for the matrix

rows - the number of rows of the matrix

cols - the number of columns of the matrix

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

DimensionlessMatrix

public DimensionlessMatrix(Collection<DoubleSparseValue<DimensionlessUnit,Dimensionless>> data,
 int rows,
 int cols)

Construct a DimensionlessMatrix from a (sparse) collection of DoubleSparseValue 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 - the data for the matrix

rows - the number of rows of the matrix

cols - the number of columns of the matrix

Method Details

getScalarClass

public Class<Dimensionless> getScalarClass()

Description copied from class: IndexedValue

Return the class of the corresponding scalar.

Specified by:

getScalarClass in class IndexedValue<DimensionlessUnit,Dimensionless,DimensionlessMatrix,DoubleMatrixData>

Returns:

the class of the corresponding scalar

getVectorClass

public Class<DimensionlessVector> getVectorClass()

Description copied from class: Matrix

Return the class of the corresponding vector.

Specified by:

getVectorClass in class Matrix<DimensionlessUnit,Dimensionless,DimensionlessVector,DoubleVectorData,DimensionlessMatrix,DoubleMatrixData>

Returns:

the class of the corresponding vector

instantiateMatrix

public DimensionlessMatrix instantiateMatrix(DoubleMatrixData dmd,
 DimensionlessUnit displayUnit)

Description copied from class: DoubleMatrix

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

Specified by:

instantiateMatrix in class DoubleMatrix<DimensionlessUnit,Dimensionless,DimensionlessVector,DimensionlessMatrix>

Parameters:

dmd - the data used to instantiate the matrix

displayUnit - the display unit of the matrix

Returns:

a matrix of the correct type

instantiateVector

public DimensionlessVector instantiateVector(DoubleVectorData dvd,
 DimensionlessUnit displayUnit)

Description copied from class: DoubleMatrix

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

Specified by:

instantiateVector in class DoubleMatrix<DimensionlessUnit,Dimensionless,DimensionlessVector,DimensionlessMatrix>

Parameters:

dvd - the data used to instantiate the vector

displayUnit - the display unit of the vector

Returns:

a vector of the correct type

instantiateScalarSI

public Dimensionless instantiateScalarSI(double valueSI,
 DimensionlessUnit displayUnit)

Description copied from class: DoubleMatrix

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

Specified by:

instantiateScalarSI in class DoubleMatrix<DimensionlessUnit,Dimensionless,DimensionlessVector,DimensionlessMatrix>

Parameters:

valueSI - the SI value of the scalar

displayUnit - the unit in which the value will be displayed

Returns:

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

acos

public final DimensionlessMatrix acos()

Description copied from interface: DimensionlessFunctions

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,DimensionlessMatrix>

Returns:

the modified T

asin

public final DimensionlessMatrix asin()

Description copied from interface: DimensionlessFunctions

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,DimensionlessMatrix>

Returns:

the modified T

atan

public final DimensionlessMatrix atan()

Description copied from interface: DimensionlessFunctions

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,DimensionlessMatrix>

Returns:

the modified T

cbrt

public final DimensionlessMatrix cbrt()

Description copied from interface: DimensionlessFunctions

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

Specified by:

cbrt in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessMatrix>

Returns:

the modified T

cos

public final DimensionlessMatrix cos()

Description copied from interface: DimensionlessFunctions

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

Specified by:

cos in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessMatrix>

Returns:

the modified T

cosh

public final DimensionlessMatrix cosh()

Description copied from interface: DimensionlessFunctions

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

Specified by:

cosh in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessMatrix>

Returns:

the modified T

exp

public final DimensionlessMatrix exp()

Description copied from interface: DimensionlessFunctions

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

Specified by:

exp in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessMatrix>

Returns:

the modified T

expm1

public final DimensionlessMatrix expm1()

Description copied from interface: DimensionlessFunctions

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,DimensionlessMatrix>

Returns:

the modified T

log

public final DimensionlessMatrix log()

Description copied from interface: DimensionlessFunctions

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

Specified by:

log in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessMatrix>

Returns:

the modified T

log10

public final DimensionlessMatrix log10()

Description copied from interface: DimensionlessFunctions

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

Specified by:

log10 in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessMatrix>

Returns:

the modified T

log1p

public final DimensionlessMatrix log1p()

Description copied from interface: DimensionlessFunctions

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

Specified by:

log1p in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessMatrix>

Returns:

the modified T

pow

public final DimensionlessMatrix pow(double x)

Description copied from interface: DimensionlessFunctions

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

Specified by:

pow in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessMatrix>

Parameters:

x - the value to use as the power

Returns:

the modified T

signum

public final DimensionlessMatrix signum()

Description copied from interface: DimensionlessFunctions

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,DimensionlessMatrix>

Returns:

the modified T

sin

public final DimensionlessMatrix sin()

Description copied from interface: DimensionlessFunctions

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

Specified by:

sin in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessMatrix>

Returns:

the modified T

sinh

public final DimensionlessMatrix sinh()

Description copied from interface: DimensionlessFunctions

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

Specified by:

sinh in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessMatrix>

Returns:

the modified T

sqrt

public final DimensionlessMatrix sqrt()

Description copied from interface: DimensionlessFunctions

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

Specified by:

sqrt in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessMatrix>

Returns:

the modified T

tan

public final DimensionlessMatrix tan()

Description copied from interface: DimensionlessFunctions

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

Specified by:

tan in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessMatrix>

Returns:

the modified T

tanh

public final DimensionlessMatrix tanh()

Description copied from interface: DimensionlessFunctions

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

Specified by:

tanh in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessMatrix>

Returns:

the modified T

inv

public final DimensionlessMatrix inv()

Description copied from interface: DimensionlessFunctions

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

Specified by:

inv in interface DimensionlessFunctions<DimensionlessUnit,DimensionlessMatrix>

Returns:

the modified T