Package org.djunits.value.vfloat.matrix

Class FloatDimensionlessMatrix

java.lang.Object

org.djunits.value.AbstractValue<U,T>

org.djunits.value.AbstractIndexedValue<U,S,M,FloatMatrixData>

org.djunits.value.vfloat.matrix.base.AbstractFloatMatrix<U,S,RV,RM>

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

org.djunits.value.vfloat.matrix.FloatDimensionlessMatrix

All Implemented Interfaces:

Serializable, Cloneable, Matrix<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector,FloatDimensionlessMatrix>, Matrix.Rel<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector,FloatDimensionlessMatrix>, DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>, ValueFunctions<DimensionlessUnit,FloatDimensionlessMatrix>, IndexedValue<DimensionlessUnit,FloatDimensionless,FloatDimensionlessMatrix>, Relative<DimensionlessUnit,FloatDimensionlessMatrix>, Value<DimensionlessUnit,FloatDimensionlessMatrix>, FloatMatrixInterface<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector,FloatDimensionlessMatrix>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2022-03-14T11:14:15.180987200Z")
public class FloatDimensionlessMatrix
extends AbstractFloatMatrixRel<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector,FloatDimensionlessMatrix>
implements DimensionlessFunctions<DimensionlessUnit,FloatDimensionlessMatrix>

Immutable FloatFloatDimensionlessMatrix, a matrix of values with a DimensionlessUnit.

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.djunits.value.base.Matrix

Matrix.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar<AU,A>,AV extends Vector.Abs<AU,A,AV,RU,R,RV>,AM extends Matrix.Abs<AU,A,AV,AM,RU,R,RV,RM>,RU extends Unit<RU>,R extends Scalar<RU,R>,RV extends Vector.RelWithAbs<AU,A,AV,RU,R,RV>,RM extends Matrix.RelWithAbs<AU,A,AV,AM,RU,R,RV,RM>>, Matrix.Rel<U extends Unit<U>,S extends Scalar<U,S>,V extends Vector<U,S,V>,RM extends Matrix.Rel<U,S,V,RM>>, Matrix.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar<AU,A>,AV extends Vector.Abs<AU,A,AV,RU,R,RV>,AM extends Matrix.Abs<AU,A,AV,AM,RU,R,RV,RM>,RU extends Unit<RU>,R extends Scalar<RU,R>,RV extends Vector.RelWithAbs<AU,A,AV,RU,R,RV>,RM extends Matrix.RelWithAbs<AU,A,AV,AM,RU,R,RV,RM>>

Field Summary

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

data

Constructor Summary

Constructors

Constructor	Description
FloatDimensionlessMatrix(FloatMatrixData data, DimensionlessUnit unit)

Method Summary

Modifier and Type	Method	Description
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.
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.
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.
FloatDimensionlessMatrix	cbrt()	Set the value(s) to the(ir) cube root.
FloatDimensionlessMatrix	cos()	Set the value(s) to the trigonometric cosine of the value(s).
FloatDimensionlessMatrix	cosh()	Set the value(s) to the hyperbolic cosine of the value(s).
FloatDimensionlessMatrix	exp()	Set the value(s) to Euler's number e raised to the power of the value(s).
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.
FloatDimensionlessMatrix	inv()	Set the value(s) to the complement (1.0/x) of the value(s).
FloatDimensionlessMatrix	log()	Set the value(s) to the natural logarithm (base e) of the value(s).
FloatDimensionlessMatrix	log10()	Set the value(s) to the base 10 logarithm of the value(s).
FloatDimensionlessMatrix	log1p()	Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
FloatDimensionlessMatrix	pow(double x)	Set the value(s) to the value(s) raised to the power of the argument.
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.
FloatDimensionlessMatrix	sin()	Set the value(s) to the trigonometric sine of the value(s).
FloatDimensionlessMatrix	sinh()	Set the value(s) to the hyperbolic sine of the value(s).
FloatDimensionlessMatrix	sqrt()	Set the value(s) to the correctly rounded positive square root of the value(s).
FloatDimensionlessMatrix	tan()	Set the value(s) to the trigonometric tangent of the value(s).
FloatDimensionlessMatrix	tanh()	Set the value(s) to the hyperbolic tangent of the value(s).

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

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

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

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.AbstractIndexedValue

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

Methods inherited from class org.djunits.value.AbstractValue

getDisplayUnit, isAbsolute, isRelative, setDisplayUnit

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.djunits.value.IndexedValue

cardinality, getStorageType, immutable, isDense, isMutable, isSparse, mutable, toDense, toSparse

Methods inherited from interface org.djunits.value.base.Matrix

cols, get, getColumn, getColumnScalars, getDiagonal, getDiagonalScalars, getRow, getRowScalars, getScalars, rows

Methods inherited from interface org.djunits.value.Value

getDisplayUnit, isAbsolute, isRelative, setDisplayUnit, toString, toString, toString, toString

Methods inherited from interface org.djunits.value.function.ValueFunctions

abs, ceil, floor, neg, rint

Constructor Detail

FloatDimensionlessMatrix

public FloatDimensionlessMatrix(FloatMatrixData data,
                                DimensionlessUnit unit)

Parameters:

data - FloatMatrixData; an internal data object

unit - DimensionlessUnit; the unit

Method Detail

getScalarClass

public Class<FloatDimensionless> getScalarClass()

Return the class of the corresponding scalar.

Specified by:

getScalarClass in interface IndexedValue<DimensionlessUnit,FloatDimensionless,FloatDimensionlessMatrix>

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 interface Matrix<DimensionlessUnit,FloatDimensionless,FloatDimensionlessVector,FloatDimensionlessMatrix>

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 interface FloatMatrixInterface<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 interface FloatMatrixInterface<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 interface FloatMatrixInterface<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