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

Class AbstractFloatMatrixAbs<AU extends AbsoluteLinearUnit<AU,​RU>,​A extends AbstractFloatScalarAbs<AU,​A,​RU,​R>,​AV extends AbstractFloatVectorAbs<AU,​A,​AV,​RU,​R,​RV>,​AM extends AbstractFloatMatrixAbs<AU,​A,​AV,​AM,​RU,​R,​RV,​RM>,​RU extends Unit<RU>,​R extends AbstractFloatScalarRelWithAbs<AU,​A,​RU,​R>,​RV extends AbstractFloatVectorRelWithAbs<AU,​A,​AV,​RU,​R,​RV>,​RM extends AbstractFloatMatrixRelWithAbs<AU,​A,​AV,​AM,​RU,​R,​RV,​RM>>

    • Constructor Detail

      • AbstractFloatMatrixAbs

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

    • Method Detail

      • 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 or when the sizes of the matrices differ

      • instantiateMatrixRel

        public abstract RM instantiateMatrixRel​(FloatMatrixData dmd,
                                        RU displayUnit)
        Instantiate a new relative matrix of the class of this absolute matrix. This can be used instead of the FloatMatrix.instiantiate() methods in case another matrix of this absolute matrix 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 - 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​(FloatVectorData dvd,
                                        RU displayUnit)
        Instantiate a new relative vector of the class of this absolute matrix. This can be used instead of the FloatVector.instiantiate() methods in case another matrix of this absolute matrix 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 - 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​(float valueSI,
                                         RU displayUnit)
        Instantiate a new relative scalar for the class of this absolute 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 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