org.djunits.value.vdouble.matrix

Class MutableDimensionlessMatrix

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.matrix.AbstractDoubleMatrix<U,R>

org.djunits.value.vdouble.matrix.AbstractDoubleMatrixRel<U,R,MR,S>

org.djunits.value.vdouble.matrix.AbstractMutableDoubleMatrixRel<DimensionlessUnit,DimensionlessMatrix,MutableDimensionlessMatrix,Dimensionless>

org.djunits.value.vdouble.matrix.MutableDimensionlessMatrix

All Implemented Interfaces:

Serializable, MathFunctionsAbs<MutableDimensionlessMatrix>, MathFunctionsDimensionless<MutableDimensionlessMatrix>, MathFunctionsRel<MutableDimensionlessMatrix>, Mutable, Relative, Value<DimensionlessUnit>, DoubleMathFunctions<MutableDimensionlessMatrix>, DoubleMatrixInterface<DimensionlessUnit>

public class MutableDimensionlessMatrix
extends AbstractMutableDoubleMatrixRel<DimensionlessUnit,DimensionlessMatrix,MutableDimensionlessMatrix,Dimensionless>
implements MathFunctionsDimensionless<MutableDimensionlessMatrix>

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

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

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Oct 9, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields inherited from class org.djunits.value.vdouble.matrix.AbstractDoubleMatrix

data

Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH

Constructor Summary

Constructors

Constructor and Description
MutableDimensionlessMatrix(Dimensionless[][] values, StorageType storageType) Construct a new Relative Immutable Double DimensionlessMatrix.
MutableDimensionlessMatrix(double[][] values, DimensionlessUnit unit, StorageType storageType) Construct a new Relative Immutable Double DimensionlessMatrix.
MutableDimensionlessMatrix(DoubleMatrixData data, DimensionlessUnit unit)

Method Summary

Modifier and Type	Method and Description
MutableDimensionlessMatrix	acos() Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.
MutableDimensionlessMatrix	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.
MutableDimensionlessMatrix	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.
MutableDimensionlessMatrix	cbrt() Set the value(s) to the(ir) cube root.
MutableDimensionlessMatrix	cos() Set the value(s) to the trigonometric cosine of the value(s).
MutableDimensionlessMatrix	cosh() Set the value(s) to the hyperbolic cosine of the value(s).
MutableDimensionlessMatrix	exp() Set the value(s) to Euler's number e raised to the power of the value(s).
MutableDimensionlessMatrix	expm1() Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
protected MutableDimensionlessMatrix	instantiateMutableType(DoubleMatrixData dmd, DimensionlessUnit unit) Construct a new Relative Mutable DoubleMatrix of the right type.
protected Dimensionless	instantiateScalar(double value, DimensionlessUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected DimensionlessMatrix	instantiateType(DoubleMatrixData dmd, DimensionlessUnit unit) Construct a new Relative Immutable DoubleMatrix of the right type.
MutableDimensionlessMatrix	inv() Set the value(s) to the complement (1.0/x) of the value(s).
MutableDimensionlessMatrix	log() Set the value(s) to the natural logarithm (base e) of the value(s).
MutableDimensionlessMatrix	log10() Set the value(s) to the base 10 logarithm of the value(s).
MutableDimensionlessMatrix	log1p() Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
MutableDimensionlessMatrix	pow(double x) Set the value(s) to the value(s) raised to the power of the argument.
MutableDimensionlessMatrix	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.
MutableDimensionlessMatrix	sin() Set the value(s) to the trigonometric sine of the value(s).
MutableDimensionlessMatrix	sinh() Set the value(s) to the hyperbolic sine of the value(s).
MutableDimensionlessMatrix	sqrt() Set the value(s) to the correctly rounded positive square root of the value(s).
MutableDimensionlessMatrix	tan() Set the value(s) to the trigonometric tangent of the value(s).
MutableDimensionlessMatrix	tanh() Set the value(s) to the hyperbolic tangent of the value(s).
MutableDimensionlessMatrix	toDense() Create a dense version of this DoubleMatrix.
MutableDimensionlessMatrix	toSparse() Create a sparse version of this DoubleMatrix.

Methods inherited from class org.djunits.value.vdouble.matrix.AbstractMutableDoubleMatrixRel

abs, assign, ceil, checkCopyOnWrite, copy, decrementBy, decrementBy, decrementBy, divideBy, divideBy, divideBy, floor, immutable, incrementBy, incrementBy, incrementBy, multiplyBy, multiplyBy, multiplyBy, mutable, neg, normalize, rint, round, set, setCopyOnWrite, setInUnit, setSI

Methods inherited from class org.djunits.value.vdouble.matrix.AbstractDoubleMatrixRel

checkUnit, divide, ensureRectangularAndNonEmpty, get, minus, plus, times

Methods inherited from class org.djunits.value.vdouble.matrix.AbstractDoubleMatrix

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

neg

Methods inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

DIV, MULT, POW

Constructor Detail

MutableDimensionlessMatrix

public MutableDimensionlessMatrix(double[][] values,
                                  DimensionlessUnit unit,
                                  StorageType storageType)
                           throws ValueException

Construct a new Relative Immutable Double DimensionlessMatrix.

Parameters:

values - double[][]; the values of the entries in the new Relative Immutable Double DimensionlessMatrix

unit - DimensionlessUnit; the unit of the new Relative Immutable Double DimensionlessMatrix

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

Throws:

ValueException - when values is null

MutableDimensionlessMatrix

public MutableDimensionlessMatrix(Dimensionless[][] values,
                                  StorageType storageType)
                           throws ValueException

Construct a new Relative Immutable Double DimensionlessMatrix.

Parameters:

values - Dimensionless[][]; the values of the entries in the new Relative Immutable Double DimensionlessMatrix

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

Throws:

ValueException - when values has zero entries

MutableDimensionlessMatrix

MutableDimensionlessMatrix(DoubleMatrixData data,
                           DimensionlessUnit unit)

Parameters:

data - DoubleMatrixData; an internal data object

unit - DimensionlessUnit; the unit

Method Detail

toDense

public final MutableDimensionlessMatrix toDense()

Create a dense version of this DoubleMatrix.

Specified by:

toDense in interface DoubleMatrixInterface<DimensionlessUnit>

Returns:

MutableDoubleMatrix<U>; dense version of this DoubleMatrix

toSparse

public final MutableDimensionlessMatrix toSparse()

Create a sparse version of this DoubleMatrix.

Specified by:

toSparse in interface DoubleMatrixInterface<DimensionlessUnit>

Returns:

MutableDoubleMatrix<U>; sparse version of this DoubleMatrix

instantiateType

protected final DimensionlessMatrix instantiateType(DoubleMatrixData dmd,
                                                    DimensionlessUnit unit)

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

Specified by:

instantiateType in class AbstractDoubleMatrixRel<DimensionlessUnit,DimensionlessMatrix,MutableDimensionlessMatrix,Dimensionless>

Parameters:

dmd - DoubleMatrixData; an internal data object

unit - U; the unit

Returns:

M the Mutable DoubleMatrix of the right type

instantiateMutableType

protected final MutableDimensionlessMatrix instantiateMutableType(DoubleMatrixData dmd,
                                                                  DimensionlessUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleMatrixRel<DimensionlessUnit,DimensionlessMatrix,MutableDimensionlessMatrix,Dimensionless>

Parameters:

dmd - DoubleMatrixData; an internal data object

unit - U; the unit

Returns:

M the Mutable DoubleMatrix of the right type

instantiateScalar

protected final Dimensionless instantiateScalar(double value,
                                                DimensionlessUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleMatrixRel<DimensionlessUnit,DimensionlessMatrix,MutableDimensionlessMatrix,Dimensionless>

Parameters:

value - double; the value

unit - U; the unit

Returns:

S the Immutable DoubleScalar of the right type

acos

public final MutableDimensionlessMatrix 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 MathFunctionsDimensionless<MutableDimensionlessMatrix>

Returns:

T; the modified T

asin

public final MutableDimensionlessMatrix 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 MathFunctionsDimensionless<MutableDimensionlessMatrix>

Returns:

T; the modified T

atan

public final MutableDimensionlessMatrix 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 MathFunctionsDimensionless<MutableDimensionlessMatrix>

Returns:

T; the modified T

cbrt

public final MutableDimensionlessMatrix cbrt()

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

Specified by:

cbrt in interface MathFunctionsDimensionless<MutableDimensionlessMatrix>

Returns:

T; the modified T

cos

public final MutableDimensionlessMatrix cos()

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

Specified by:

cos in interface MathFunctionsDimensionless<MutableDimensionlessMatrix>

Returns:

T; the modified T

cosh

public final MutableDimensionlessMatrix cosh()

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

Specified by:

cosh in interface MathFunctionsDimensionless<MutableDimensionlessMatrix>

Returns:

T; the modified T

exp

public final MutableDimensionlessMatrix exp()

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

Specified by:

exp in interface MathFunctionsDimensionless<MutableDimensionlessMatrix>

Returns:

T; the modified T

expm1

public final MutableDimensionlessMatrix 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 MathFunctionsDimensionless<MutableDimensionlessMatrix>

Returns:

T; the modified T

log

public final MutableDimensionlessMatrix log()

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

Specified by:

log in interface MathFunctionsDimensionless<MutableDimensionlessMatrix>

Returns:

T; the modified T

log10

public final MutableDimensionlessMatrix log10()

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

Specified by:

log10 in interface MathFunctionsDimensionless<MutableDimensionlessMatrix>

Returns:

T; the modified T

log1p

public final MutableDimensionlessMatrix log1p()

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

Specified by:

log1p in interface MathFunctionsDimensionless<MutableDimensionlessMatrix>

Returns:

T; the modified T

pow

public final MutableDimensionlessMatrix pow(double x)

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

Specified by:

pow in interface MathFunctionsDimensionless<MutableDimensionlessMatrix>

Parameters:

x - double; the value to use as the power

Returns:

T; the modified T

signum

public final MutableDimensionlessMatrix 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 MathFunctionsDimensionless<MutableDimensionlessMatrix>

Returns:

T; the modified T

sin

public final MutableDimensionlessMatrix sin()

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

Specified by:

sin in interface MathFunctionsDimensionless<MutableDimensionlessMatrix>

Returns:

T; the modified T

sinh

public final MutableDimensionlessMatrix sinh()

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

Specified by:

sinh in interface MathFunctionsDimensionless<MutableDimensionlessMatrix>

Returns:

T; the modified T

sqrt

public final MutableDimensionlessMatrix sqrt()

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

Specified by:

sqrt in interface MathFunctionsDimensionless<MutableDimensionlessMatrix>

Returns:

T; the modified T

tan

public final MutableDimensionlessMatrix tan()

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

Specified by:

tan in interface MathFunctionsDimensionless<MutableDimensionlessMatrix>

Returns:

T; the modified T

tanh

public final MutableDimensionlessMatrix tanh()

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

Specified by:

tanh in interface MathFunctionsDimensionless<MutableDimensionlessMatrix>

Returns:

T; the modified T

inv

public final MutableDimensionlessMatrix inv()

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

Specified by:

inv in interface MathFunctionsDimensionless<MutableDimensionlessMatrix>

Returns:

T; the modified T