Package org.djunits.value.vfloat.matrix.base

Class FloatMatrixRelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends FloatScalarAbs<AU,A,RU,R>,AV extends FloatVectorAbs<AU,A,AV,RU,R,RV>,AM extends FloatMatrixAbs<AU,A,AV,AM,RU,R,RV,RM>,RU extends Unit<RU>,R extends FloatScalarRelWithAbs<AU,A,RU,R>,RV extends FloatVectorRelWithAbs<AU,A,AV,RU,R,RV>,RM extends FloatMatrixRelWithAbs<AU,A,AV,AM,RU,R,RV,RM>>

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<RU,R,RV,RM>
org.djunits.value.vfloat.matrix.base.FloatMatrixRelWithAbs<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, Relative<RU,RM>, RelWithAbs<AU,AM,RU,RM>, Value<RU,RM>
Direct Known Subclasses:
FloatAngleMatrix, FloatDurationMatrix, FloatLengthMatrix, FloatTemperatureMatrix
public abstract class FloatMatrixRelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends FloatScalarAbs<AU,A,RU,R>,AV extends FloatVectorAbs<AU,A,AV,RU,R,RV>,AM extends FloatMatrixAbs<AU,A,AV,AM,RU,R,RV,RM>,RU extends Unit<RU>,R extends FloatScalarRelWithAbs<AU,A,RU,R>,RV extends FloatVectorRelWithAbs<AU,A,AV,RU,R,RV>,RM extends FloatMatrixRelWithAbs<AU,A,AV,AM,RU,R,RV,RM>> extends FloatMatrixRel<RU,R,RV,RM> implements RelWithAbs<AU,AM,RU,RM>
AbstractMutableFloatMatrixRelWithAbs.java.

Copyright (c) 2019-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
See Also:

  • Constructor Details

    • FloatMatrixRelWithAbs

      protected FloatMatrixRelWithAbs(FloatMatrixData data, RU unit)
      Construct a new Relative Mutable FloatMatrix.
      Parameters:
      data - FloatMatrixData; an internal data object
      unit - RU; the unit

  • Method Details

    • plus

      public AM plus(AM increment)
      Description copied from interface: RelWithAbs
      Add an Absolute value to this relative value. A new value is returned due to immutability. The unit of the result is the unit of the absolute operand.
      Specified by:
      plus in interface RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends FloatScalarAbs<AU,A,RU,R>,AV extends FloatVectorAbs<AU,A,AV,RU,R,RV>,AM extends FloatMatrixAbs<AU,A,AV,AM,RU,R,RV,RM>>
      Parameters:
      increment - A; A the right operand
      Returns:
      A; the sum of this value and the operand

    • instantiateMatrixAbs

      public abstract AM instantiateMatrixAbs(FloatMatrixData dmd, AU displayUnit)
      Instantiate a new absolute matrix of the class of this relative matrix. This can be used instead of the FloatMatrix.instiantiate() methods in case another matrix of this relative with absolute class is known. The method is faster than FloatMatrix.instantiate, and it will also work if the matrix is user-defined.
      Parameters:
      dmd - FloatMatrixData; the data used to instantiate the matrix
      displayUnit - AU; the display unit of the absolute matrix
      Returns:
      AM; an absolute matrix of the correct type, belonging to this relative matrix type

    • instantiateVectorAbs

      public abstract AV instantiateVectorAbs(FloatVectorData dvd, AU displayUnit)
      Instantiate a new absolute vector of the class of this relative matrix. This can be used instead of the FloatVector.instiantiate() methods in case another matrix of this relative with absolute class is known. The method is faster than FloatVector.instantiate, and it will also work if the matrix or vector is user-defined.
      Parameters:
      dvd - FloatVectorData; the data used to instantiate the vector
      displayUnit - AU; the display unit of the absolute vector
      Returns:
      AV; an absolute vector of the correct type, belonging to this relative matrix type

    • instantiateScalarAbsSI

      public abstract A instantiateScalarAbsSI(float valueSI, AU displayUnit)
      Instantiate a new absolute scalar for the class of this relative 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.
      Parameters:
      valueSI - float; the SI value of the absolute scalar
      displayUnit - AU; the unit in which the absolute value will be displayed
      Returns:
      A; an absolute scalar of the correct type, belonging to this relative matrix type