Package org.djunits.value.vdouble.matrix.base

Class AbstractDoubleMatrixAbs<AU extends AbsoluteLinearUnit<AU,​RU>,​A extends AbstractDoubleScalarAbs<AU,​A,​RU,​R>,​AV extends AbstractDoubleVectorAbs<AU,​A,​AV,​RU,​R,​RV>,​AM extends AbstractDoubleMatrixAbs<AU,​A,​AV,​AM,​RU,​R,​RV,​RM>,​RU extends Unit<RU>,​R extends AbstractDoubleScalarRelWithAbs<AU,​A,​RU,​R>,​RV extends AbstractDoubleVectorRelWithAbs<AU,​A,​AV,​RU,​R,​RV>,​RM extends AbstractDoubleMatrixRelWithAbs<AU,​A,​AV,​AM,​RU,​R,​RV,​RM>>

java.lang.Object
org.djunits.value.AbstractValue<U,​T>
org.djunits.value.AbstractIndexedValue<U,​S,​M,​DoubleMatrixData>
org.djunits.value.vdouble.matrix.base.AbstractDoubleMatrix<AU,​A,​AV,​AM>
org.djunits.value.vdouble.matrix.base.AbstractDoubleMatrixAbs<AU,​A,​AV,​AM,​RU,​R,​RV,​RM>
Type Parameters:
AU - the absolute unit belonging to the relative unit
A - the absolute scalar type belonging to the absolute matrix type
AV - the absolute vector type belonging to the absolute matrix type
AM - the (immutable or mutable) absolute matrix type
RU - the relative unit belonging to the absolute unit
R - the relative scalar type belonging to the relative matrix type
RV - the relative vector type belonging to the relative matrix type
RM - the relative (immutable or mutable) matrix type with this unit
All Implemented Interfaces:
Serializable, Cloneable, Absolute, Matrix<AU,​A,​AV,​AM>, Matrix.Abs<AU,​A,​AV,​AM,​RU,​R,​RV,​RM>, ValueFunctions<AU,​AM>, IndexedValue<AU,​A,​AM>, Value<AU,​AM>, DoubleMatrixInterface<AU,​A,​AV,​AM>
Direct Known Subclasses:
AbsoluteTemperatureMatrix, DirectionMatrix, PositionMatrix, TimeMatrix
public abstract class AbstractDoubleMatrixAbs<AU extends AbsoluteLinearUnit<AU,​RU>,​A extends AbstractDoubleScalarAbs<AU,​A,​RU,​R>,​AV extends AbstractDoubleVectorAbs<AU,​A,​AV,​RU,​R,​RV>,​AM extends AbstractDoubleMatrixAbs<AU,​A,​AV,​AM,​RU,​R,​RV,​RM>,​RU extends Unit<RU>,​R extends AbstractDoubleScalarRelWithAbs<AU,​A,​RU,​R>,​RV extends AbstractDoubleVectorRelWithAbs<AU,​A,​AV,​RU,​R,​RV>,​RM extends AbstractDoubleMatrixRelWithAbs<AU,​A,​AV,​AM,​RU,​R,​RV,​RM>>
extends AbstractDoubleMatrix<AU,​A,​AV,​AM>
implements Matrix.Abs<AU,​A,​AV,​AM,​RU,​R,​RV,​RM>, Absolute
AbstractMutableDoubleMatrixRelWithAbs.java.

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

Author:
Alexander Verbraeck
See Also:
Serialized Form

  • Constructor Details

    • AbstractDoubleMatrixAbs

      protected AbstractDoubleMatrixAbs​(DoubleMatrixData data, AU unit)
      Construct a new Relative Mutable DoubleMatrix.
      Parameters:
      data - DoubleMatrixData; an internal data object
      unit - AU; the unit

  • Method Details

    • plus

      public AM plus​(RM increment) throws ValueRuntimeException
      Add a relative matrix to this absolute matrix. A new absolute matrix is returned. The display unit of the new matrix is the display unit of this absolute matrix. The addition is done value by value and the result is stored in a new matrix. If both operands are sparse, the result is a sparse matrix, otherwise the result is a dense matrix.
      Specified by:
      plus in interface Matrix.Abs<AU extends AbsoluteLinearUnit<AU,​RU>,​A extends AbstractDoubleScalarAbs<AU,​A,​RU,​R>,​AV extends AbstractDoubleVectorAbs<AU,​A,​AV,​RU,​R,​RV>,​AM extends AbstractDoubleMatrixAbs<AU,​A,​AV,​AM,​RU,​R,​RV,​RM>,​RU extends Unit<RU>,​R extends AbstractDoubleScalarRelWithAbs<AU,​A,​RU,​R>,​RV extends AbstractDoubleVectorRelWithAbs<AU,​A,​AV,​RU,​R,​RV>,​RM extends AbstractDoubleMatrixRelWithAbs<AU,​A,​AV,​AM,​RU,​R,​RV,​RM>>
      Parameters:
      increment - RM; the relative matrix (mutable or immutable, sparse or dense) to add to this absolute matrix
      Returns:
      AIV; the sum of this value and the operand as a new absolute, immutable matrix
      Throws:
      ValueRuntimeException - in case this matrix and the operand have a different size

    • minus

      public AM minus​(RM decrement) throws ValueRuntimeException
      Subtract a relative matrix from this absolute matrix. A new absolute matrix is returned. The display unit of the new matrix is the display unit of this absolute matrix. The subtraction is done value by value and the result is stored in a new matrix. If both operands are sparse, the result is a sparse matrix, otherwise the result is a dense matrix.
      Specified by:
      minus in interface Matrix.Abs<AU extends AbsoluteLinearUnit<AU,​RU>,​A extends AbstractDoubleScalarAbs<AU,​A,​RU,​R>,​AV extends AbstractDoubleVectorAbs<AU,​A,​AV,​RU,​R,​RV>,​AM extends AbstractDoubleMatrixAbs<AU,​A,​AV,​AM,​RU,​R,​RV,​RM>,​RU extends Unit<RU>,​R extends AbstractDoubleScalarRelWithAbs<AU,​A,​RU,​R>,​RV extends AbstractDoubleVectorRelWithAbs<AU,​A,​AV,​RU,​R,​RV>,​RM extends AbstractDoubleMatrixRelWithAbs<AU,​A,​AV,​AM,​RU,​R,​RV,​RM>>
      Parameters:
      decrement - RM; the relative matrix (mutable or immutable, sparse or dense) to subtract from this absolute matrix
      Returns:
      AIV; the difference of this value and the operand as a new absolute, immutable matrix
      Throws:
      ValueRuntimeException - in case this matrix and the operand have a different size

    • minus

      public RM minus​(AM decrement) throws ValueRuntimeException
      Subtract an absolute matrix from this absolute matrix. A new relative matrix is returned. The display unit of the new matrix is the relative counterpart of the display unit of this absolute matrix. The subtraction is done value by value and the result is stored in a new matrix. If both operands are sparse, the result is a sparse matrix, otherwise the result is a dense matrix.
      Specified by:
      minus in interface Matrix.Abs<AU extends AbsoluteLinearUnit<AU,​RU>,​A extends AbstractDoubleScalarAbs<AU,​A,​RU,​R>,​AV extends AbstractDoubleVectorAbs<AU,​A,​AV,​RU,​R,​RV>,​AM extends AbstractDoubleMatrixAbs<AU,​A,​AV,​AM,​RU,​R,​RV,​RM>,​RU extends Unit<RU>,​R extends AbstractDoubleScalarRelWithAbs<AU,​A,​RU,​R>,​RV extends AbstractDoubleVectorRelWithAbs<AU,​A,​AV,​RU,​R,​RV>,​RM extends AbstractDoubleMatrixRelWithAbs<AU,​A,​AV,​AM,​RU,​R,​RV,​RM>>
      Parameters:
      decrement - AM; the absolute matrix (mutable or immutable, sparse or dense) to subtract from this absolute matrix
      Returns:
      RIV; the difference of this value and the operand as a new relative, immutable matrix
      Throws:
      ValueRuntimeException - in case this matrix and the operand have a different size

    • decrementBy

      public AM decrementBy​(R decrement)
      Decrement all values of this matrix by the decrement. This only works if this matrix is mutable.
      Parameters:
      decrement - R; the scalar by which to decrement all values
      Returns:
      AM; this modified vector
      Throws:
      ValueRuntimeException - in case this vector is immutable

    • decrementBy

      public AM decrementBy​(RM decrement)
      Decrement all values of this matrix by the decrement on a value by value basis. This only works if this matrix is mutable.
      Parameters:
      decrement - RM; the matrix that contains the values by which to decrement the corresponding values
      Returns:
      AV; this modified matrix
      Throws:
      ValueRuntimeException - in case this matrix is immutable
      ValueRuntimeException - when the sizes of the matrices differ, or decrement is null

    • instantiateMatrixRel

      public abstract RM instantiateMatrixRel​(DoubleMatrixData dmd, RU displayUnit)
      Instantiate a new relative matrix of the class of this absolute matrix. This can be used instead of the DoubleMatrix.instiantiate() methods in case another matrix of this absolute matrix class is known. The method is faster than DoubleMatrix.instantiate, and it will also work if the matrix is user-defined.
      Parameters:
      dmd - DoubleMatrixData; 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 abstract RV instantiateVectorRel​(DoubleVectorData dvd, RU displayUnit)
      Instantiate a new relative vector of the class of this absolute matrix. This can be used instead of the DoubleVector.instiantiate() methods in case another matrix of this absolute matrix class is known. The method is faster than DoubleVector.instantiate, and it will also work if the matrix or vector is user-defined.
      Parameters:
      dvd - DoubleVectorData; 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 abstract R instantiateScalarRelSI​(double valueSI, RU displayUnit)
      Instantiate a new relative scalar for the class of this absolute 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.
      Parameters:
      valueSI - double; 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