org.djunits.value.vfloat.matrix

Class FloatMatrix.Rel<U extends Unit<U>>

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vfloat.matrix.AbstractFloatMatrix<U,R>

org.djunits.value.vfloat.matrix.AbstractFloatMatrixRel<U,FloatMatrix.Rel<U>,MutableFloatMatrix.Rel<U>,FloatScalar.Rel<U>>

org.djunits.value.vfloat.matrix.FloatMatrix.Rel<U>

Type Parameters:

U - Unit the unit for which this Matrix will be created

All Implemented Interfaces:

Serializable, Relative, Value<U>, FloatMatrixInterface<U>

Enclosing class:

FloatMatrix

public static class FloatMatrix.Rel<U extends Unit<U>>
extends AbstractFloatMatrixRel<U,FloatMatrix.Rel<U>,MutableFloatMatrix.Rel<U>,FloatScalar.Rel<U>>

RELATIVE implementation of FloatMatrix.

See Also:

Serialized Form

Field Summary

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

data

Constructor Summary

Constructors

Constructor and Description
Rel(float[][] values, U unit, StorageType storageType) Construct a new Relative Immutable FloatMatrix.
Rel(FloatMatrixData data, U unit) Construct a new Relative Immutable FloatMatrix.
Rel(FloatScalar.Rel<U>[][] values, StorageType storageType) Construct a new Relative Immutable FloatMatrix.

Method Summary

Modifier and Type	Method and Description
protected MutableFloatMatrix.Rel<U>	instantiateMutableType(FloatMatrixData dmd, U unit) Construct a new Relative Mutable FloatMatrix of the right type.
protected FloatScalar.Rel<U>	instantiateScalar(float value, U unit) Construct a new Relative Immutable FloatScalar of the right type.
protected FloatMatrix.Rel<U>	instantiateType(FloatMatrixData dmd, U unit) Construct a new Relative Immutable FloatMatrix of the right type.
FloatMatrix.Rel<U>	toDense() Create a dense version of this FloatMatrix.
FloatMatrix.Rel<U>	toSparse() Create a sparse version of this FloatMatrix.

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

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

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

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.vfloat.matrix.FloatMatrixInterface

cardinality, columns, determinant, getInUnit, getInUnit, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, rows, toString, toString, toString, toString, zSum

Constructor Detail

Rel

public Rel(float[][] values,
           U unit,
           StorageType storageType)
    throws ValueException

Construct a new Relative Immutable FloatMatrix.

Parameters:

values - float[][]; the values of the entries in the new Relative Immutable FloatMatrix

unit - U; the unit of the new Relative Immutable FloatMatrix

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

Throws:

ValueException - when values is null

Rel

public Rel(FloatScalar.Rel<U>[][] values,
           StorageType storageType)
    throws ValueException

Construct a new Relative Immutable FloatMatrix.

Parameters:

values - FloatScalar.Abs<U>[][]; the values of the entries in the new Relative Immutable FloatMatrix

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

Throws:

ValueException - when values has zero entries

Rel

Rel(FloatMatrixData data,
    U unit)

Construct a new Relative Immutable FloatMatrix.

Parameters:

data - an internal data object

unit - the unit

Method Detail

toDense

public FloatMatrix.Rel<U> toDense()

Create a dense version of this FloatMatrix.

Returns:

MutableFloatMatrix<U>; dense version of this FloatMatrix

toSparse

public FloatMatrix.Rel<U> toSparse()

Create a sparse version of this FloatMatrix.

Returns:

MutableFloatMatrix<U>; sparse version of this FloatMatrix

instantiateType

protected final FloatMatrix.Rel<U> instantiateType(FloatMatrixData dmd,
                                                   U unit)

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

Specified by:

instantiateType in class AbstractFloatMatrixRel<U extends Unit<U>,FloatMatrix.Rel<U extends Unit<U>>,MutableFloatMatrix.Rel<U extends Unit<U>>,FloatScalar.Rel<U extends Unit<U>>>

Parameters:

dmd - an internal data object

unit - the unit

Returns:

M the Mutable FloatMatrix of the right type

instantiateMutableType

protected final MutableFloatMatrix.Rel<U> instantiateMutableType(FloatMatrixData dmd,
                                                                 U unit)

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

Specified by:

instantiateMutableType in class AbstractFloatMatrixRel<U extends Unit<U>,FloatMatrix.Rel<U extends Unit<U>>,MutableFloatMatrix.Rel<U extends Unit<U>>,FloatScalar.Rel<U extends Unit<U>>>

Parameters:

dmd - an internal data object

unit - the unit

Returns:

M the Mutable FloatMatrix of the right type

instantiateScalar

protected final FloatScalar.Rel<U> instantiateScalar(float value,
                                                     U unit)

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

Specified by:

instantiateScalar in class AbstractFloatMatrixRel<U extends Unit<U>,FloatMatrix.Rel<U extends Unit<U>>,MutableFloatMatrix.Rel<U extends Unit<U>>,FloatScalar.Rel<U extends Unit<U>>>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable FloatScalar of the right type