org.djunits.value.vfloat.matrix

Class FloatElectricalPotentialMatrix

java.lang.Object

org.djunits.value.AbstractValue<U>

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

org.djunits.value.vfloat.matrix.AbstractFloatMatrixRel<ElectricalPotentialUnit,FloatElectricalPotentialMatrix,MutableFloatElectricalPotentialMatrix,FloatElectricalPotential>

org.djunits.value.vfloat.matrix.FloatElectricalPotentialMatrix

All Implemented Interfaces:

Serializable, Relative, Value<ElectricalPotentialUnit>, FloatMatrixInterface<ElectricalPotentialUnit>

public class FloatElectricalPotentialMatrix
extends AbstractFloatMatrixRel<ElectricalPotentialUnit,FloatElectricalPotentialMatrix,MutableFloatElectricalPotentialMatrix,FloatElectricalPotential>

Immutable FloatElectricalPotentialMatrix, a matrix of values with a ElectricalPotentialUnit.

Copyright (c) 2013-2018 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.vfloat.matrix.AbstractFloatMatrix

data

Constructor Summary

Constructors

Constructor and Description
FloatElectricalPotentialMatrix(float[][] values, ElectricalPotentialUnit unit, StorageType storageType) Construct a new Relative Immutable FloatElectricalPotentialMatrix.
FloatElectricalPotentialMatrix(FloatElectricalPotential[][] values, StorageType storageType) Construct a new Relative Immutable FloatElectricalPotentialMatrix.
FloatElectricalPotentialMatrix(FloatMatrixData data, ElectricalPotentialUnit unit)

Method Summary

Modifier and Type	Method and Description
protected MutableFloatElectricalPotentialMatrix	instantiateMutableType(FloatMatrixData fmd, ElectricalPotentialUnit unit) Construct a new Relative Mutable FloatMatrix of the right type.
protected FloatElectricalPotential	instantiateScalar(float value, ElectricalPotentialUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
protected FloatElectricalPotentialMatrix	instantiateType(FloatMatrixData fmd, ElectricalPotentialUnit unit) Construct a new Relative Immutable FloatMatrix of the right type.
FloatElectricalPotentialMatrix	toDense() Create a dense version of this FloatMatrix.
FloatElectricalPotentialMatrix	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

FloatElectricalPotentialMatrix

public FloatElectricalPotentialMatrix(float[][] values,
                                      ElectricalPotentialUnit unit,
                                      StorageType storageType)
                               throws ValueException

Construct a new Relative Immutable FloatElectricalPotentialMatrix.

Parameters:

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

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

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

Throws:

ValueException - when values is null

FloatElectricalPotentialMatrix

public FloatElectricalPotentialMatrix(FloatElectricalPotential[][] values,
                                      StorageType storageType)
                               throws ValueException

Construct a new Relative Immutable FloatElectricalPotentialMatrix.

Parameters:

values - FloatScalar.Rel<U>[][]; the values of the entries in the new Relative Immutable Float FloatElectricalPotentialMatrix

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

Throws:

ValueException - when values has zero entries

FloatElectricalPotentialMatrix

FloatElectricalPotentialMatrix(FloatMatrixData data,
                               ElectricalPotentialUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

toDense

public final FloatElectricalPotentialMatrix toDense()

Create a dense version of this FloatMatrix.

Returns:

MutableFloatMatrix<U>; dense version of this FloatMatrix

toSparse

public final FloatElectricalPotentialMatrix toSparse()

Create a sparse version of this FloatMatrix.

Returns:

MutableFloatMatrix<U>; sparse version of this FloatMatrix

instantiateType

protected final FloatElectricalPotentialMatrix instantiateType(FloatMatrixData fmd,
                                                               ElectricalPotentialUnit unit)

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

Specified by:

instantiateType in class AbstractFloatMatrixRel<ElectricalPotentialUnit,FloatElectricalPotentialMatrix,MutableFloatElectricalPotentialMatrix,FloatElectricalPotential>

Parameters:

fmd - an internal data object

unit - the unit

Returns:

M the Mutable FloatMatrix of the right type

instantiateMutableType

protected final MutableFloatElectricalPotentialMatrix instantiateMutableType(FloatMatrixData fmd,
                                                                             ElectricalPotentialUnit unit)

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

Specified by:

instantiateMutableType in class AbstractFloatMatrixRel<ElectricalPotentialUnit,FloatElectricalPotentialMatrix,MutableFloatElectricalPotentialMatrix,FloatElectricalPotential>

Parameters:

fmd - an internal data object

unit - the unit

Returns:

M the Mutable FloatMatrix of the right type

instantiateScalar

protected final FloatElectricalPotential instantiateScalar(float value,
                                                           ElectricalPotentialUnit unit)

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

Specified by:

instantiateScalar in class AbstractFloatMatrixRel<ElectricalPotentialUnit,FloatElectricalPotentialMatrix,MutableFloatElectricalPotentialMatrix,FloatElectricalPotential>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable FloatScalar of the right type