Package org.djunits.value.vfloat.matrix
Class FloatElectricalPotentialMatrix
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<ElectricalPotentialUnit,FloatElectricalPotential,FloatElectricalPotentialVector,FloatElectricalPotentialMatrix>
org.djunits.value.vfloat.matrix.FloatElectricalPotentialMatrix
- All Implemented Interfaces:
Serializable
,Cloneable
,Relative<ElectricalPotentialUnit,
,FloatElectricalPotentialMatrix> Value<ElectricalPotentialUnit,
FloatElectricalPotentialMatrix>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
date="2023-07-23T14:06:38.224104100Z")
public class FloatElectricalPotentialMatrix
extends FloatMatrixRel<ElectricalPotentialUnit,FloatElectricalPotential,FloatElectricalPotentialVector,FloatElectricalPotentialMatrix>
Immutable FloatFloatElectricalPotentialMatrix, a matrix of values with a ElectricalPotentialUnit.
Copyright (c) 2013-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, Peter Knoppers
- See Also:
-
Field Summary
Fields inherited from class org.djunits.value.vfloat.matrix.base.FloatMatrix
data
-
Constructor Summary
ConstructorDescriptionFloatElectricalPotentialMatrix
(float[][] data) Construct a FloatElectricalPotentialMatrix from a float[][] object with SI-unit values.FloatElectricalPotentialMatrix
(float[][] data, ElectricalPotentialUnit displayUnit) Construct a FloatElectricalPotentialMatrix from a float[][] object.FloatElectricalPotentialMatrix
(float[][] data, ElectricalPotentialUnit displayUnit, StorageType storageType) Construct a FloatElectricalPotentialMatrix from a float[][] object.FloatElectricalPotentialMatrix
(float[][] data, StorageType storageType) Construct a FloatElectricalPotentialMatrix from a float[][] object with SI-unit values.FloatElectricalPotentialMatrix
(Collection<FloatSparseValue<ElectricalPotentialUnit, FloatElectricalPotential>> data, int rows, int cols) Construct a FloatElectricalPotentialMatrix from a (sparse) collection of FloatSparseValue objects.FloatElectricalPotentialMatrix
(Collection<FloatSparseValue<ElectricalPotentialUnit, FloatElectricalPotential>> data, int rows, int cols, StorageType storageType) Construct a FloatElectricalPotentialMatrix from a (sparse) collection of FloatSparseValue objects.FloatElectricalPotentialMatrix
(Collection<FloatSparseValue<ElectricalPotentialUnit, FloatElectricalPotential>> data, ElectricalPotentialUnit displayUnit, int rows, int cols) Construct a FloatElectricalPotentialMatrix from a (sparse) collection of FloatSparseValue objects.FloatElectricalPotentialMatrix
(Collection<FloatSparseValue<ElectricalPotentialUnit, FloatElectricalPotential>> data, ElectricalPotentialUnit displayUnit, int rows, int cols, StorageType storageType) Construct a FloatElectricalPotentialMatrix from a (sparse) collection of FloatSparseValue objects.FloatElectricalPotentialMatrix
(FloatMatrixData data, ElectricalPotentialUnit displayUnit) Construct a FloatElectricalPotentialMatrix from an internal data object.Construct a FloatElectricalPotentialMatrix from an array of an array of FloatElectricalPotential objects.FloatElectricalPotentialMatrix
(FloatElectricalPotential[][] data, ElectricalPotentialUnit displayUnit) Construct a FloatElectricalPotentialMatrix from an array of an array of FloatElectricalPotential objects.FloatElectricalPotentialMatrix
(FloatElectricalPotential[][] data, ElectricalPotentialUnit displayUnit, StorageType storageType) Construct a FloatElectricalPotentialMatrix from an array of an array of FloatElectricalPotential objects.FloatElectricalPotentialMatrix
(FloatElectricalPotential[][] data, StorageType storageType) Construct a FloatElectricalPotentialMatrix from an array of an array of FloatElectricalPotential objects. -
Method Summary
Modifier and TypeMethodDescriptionReturn the class of the corresponding scalar.Return the class of the corresponding vector.instantiateMatrix
(FloatMatrixData fmd, ElectricalPotentialUnit displayUnit) Instantiate a new matrix of the class of this matrix.instantiateScalarSI
(float valueSI, ElectricalPotentialUnit displayUnit) Instantiate a new scalar for the class of this matrix.instantiateVector
(FloatVectorData fvd, ElectricalPotentialUnit displayUnit) Instantiate a new vector of the class of this matrix.Methods inherited from class org.djunits.value.vfloat.matrix.base.FloatMatrixRel
decrementBy, decrementBy, divide, divide, divide, divideBy, divideBy, incrementBy, incrementBy, minus, multiplyBy, multiplyBy, plus, times, times, times, zSum
Methods inherited from class org.djunits.value.vfloat.matrix.base.FloatMatrix
abs, assign, ceil, checkColumnIndex, checkIndex, checkRowIndex, checkSquare, cols, determinantSI, equals, floor, get, getColumn, getColumnScalars, getColumnSI, getData, getDiagonal, getDiagonalScalars, getDiagonalSI, getInUnit, getInUnit, getRow, getRowScalars, getRowSI, getScalars, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, neg, rint, rows, set, setData, setInUnit, setInUnit, setSI, toDense, toSparse, toString, toString, toString, toString
Methods inherited from class org.djunits.value.IndexedValue
cardinality, checkCopyOnWrite, clone, getDisplayUnit, getStorageType, immutable, isCopyOnWrite, isDense, isMutable, isSparse, mutable, setCopyOnWrite, setDisplayUnit, setMutable
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.djunits.value.Value
isAbsolute, isRelative
-
Constructor Details
-
FloatElectricalPotentialMatrix
Construct a FloatElectricalPotentialMatrix from an internal data object.- Parameters:
data
- FloatMatrixData; the internal data object for the matrixdisplayUnit
- ElectricalPotentialUnit; the display unit of the matrix data
-
FloatElectricalPotentialMatrix
public FloatElectricalPotentialMatrix(float[][] data, ElectricalPotentialUnit displayUnit, StorageType storageType) Construct a FloatElectricalPotentialMatrix from a float[][] object. The float values are expressed in the displayUnit, and will be printed using the displayUnit.- Parameters:
data
- float[][]; the data for the matrix, expressed in the displayUnitdisplayUnit
- ElectricalPotentialUnit; the unit of the values in the data array, and display unit when printingstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
-
FloatElectricalPotentialMatrix
Construct a FloatElectricalPotentialMatrix from a float[][] object. The float values are expressed in the displayUnit. Assume that the StorageType is DENSE since we offer the data as an array of an array.- Parameters:
data
- float[][]; the data for the matrixdisplayUnit
- ElectricalPotentialUnit; the unit of the values in the data array, and display unit when printing
-
FloatElectricalPotentialMatrix
Construct a FloatElectricalPotentialMatrix from a float[][] object with SI-unit values.- Parameters:
data
- float[][]; the data for the matrix, in SI unitsstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
-
FloatElectricalPotentialMatrix
public FloatElectricalPotentialMatrix(float[][] data) Construct a FloatElectricalPotentialMatrix from a float[][] object with SI-unit values. Assume that the StorageType is DENSE since we offer the data as an array of an array.- Parameters:
data
- float[][]; the data for the matrix, in SI units
-
FloatElectricalPotentialMatrix
public FloatElectricalPotentialMatrix(FloatElectricalPotential[][] data, ElectricalPotentialUnit displayUnit, StorageType storageType) Construct a FloatElectricalPotentialMatrix from an array of an array of FloatElectricalPotential objects. The FloatElectricalPotential values are each expressed in their own unit, but will be internally stored as SI values, all expressed in the displayUnit when printing.- Parameters:
data
- FloatElectricalPotential[][]; the data for the matrixdisplayUnit
- ElectricalPotentialUnit; the display unit of the values when printingstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
-
FloatElectricalPotentialMatrix
public FloatElectricalPotentialMatrix(FloatElectricalPotential[][] data, ElectricalPotentialUnit displayUnit) Construct a FloatElectricalPotentialMatrix from an array of an array of FloatElectricalPotential objects. The FloatElectricalPotential values are each expressed in their own unit, but will be internally stored as SI values, all expressed in the displayUnit when printing. Assume that the StorageType is DENSE since we offer the data as an array of an array.- Parameters:
data
- FloatElectricalPotential[][]; the data for the matrixdisplayUnit
- ElectricalPotentialUnit; the display unit of the values when printing
-
FloatElectricalPotentialMatrix
Construct a FloatElectricalPotentialMatrix from an array of an array of FloatElectricalPotential objects. The FloatElectricalPotential values are each expressed in their own unit, but will be internally stored as SI values, and expressed using SI units when printing. since we offer the data as an array of an array.- Parameters:
data
- FloatElectricalPotential[][]; the data for the matrixstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
-
FloatElectricalPotentialMatrix
Construct a FloatElectricalPotentialMatrix from an array of an array of FloatElectricalPotential objects. The FloatElectricalPotential values are each expressed in their own unit, but will be internally stored as SI values, and expressed using SI units when printing. Assume that the StorageType is DENSE since we offer the data as an array of an array.- Parameters:
data
- FloatElectricalPotential[][]; the data for the matrix
-
FloatElectricalPotentialMatrix
public FloatElectricalPotentialMatrix(Collection<FloatSparseValue<ElectricalPotentialUnit, FloatElectricalPotential>> data, ElectricalPotentialUnit displayUnit, int rows, int cols, StorageType storageType) Construct a FloatElectricalPotentialMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit indicates the unit in which the values in the collection are expressed, as well as the unit in which they will be printed.- Parameters:
data
- Collection<FloatSparseValue>; the data for the matrixdisplayUnit
- ElectricalPotentialUnit; the display unit of the matrix data, and the unit of the data pointsrows
- int; the number of rows of the matrixcols
- int; the number of columns of the matrixstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
-
FloatElectricalPotentialMatrix
public FloatElectricalPotentialMatrix(Collection<FloatSparseValue<ElectricalPotentialUnit, FloatElectricalPotential>> data, ElectricalPotentialUnit displayUnit, int rows, int cols) Construct a FloatElectricalPotentialMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit indicates the unit in which the values in the collection are expressed, as well as the unit in which they will be printed. Assume the storage type is SPARSE, since we offer the data as a collection.- Parameters:
data
- Collection<FloatSparseValue>; the data for the matrixdisplayUnit
- ElectricalPotentialUnit; the display unit of the matrix data, and the unit of the data pointsrows
- int; the number of rows of the matrixcols
- int; the number of columns of the matrix
-
FloatElectricalPotentialMatrix
public FloatElectricalPotentialMatrix(Collection<FloatSparseValue<ElectricalPotentialUnit, FloatElectricalPotential>> data, int rows, int cols, StorageType storageType) Construct a FloatElectricalPotentialMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit indicates the unit in which the values in the collection are expressed, as well as the unit in which they will be printed. Use the SI unit or base unit as the displayUnit.- Parameters:
data
- Collection<FloatSparseValue>; the data for the matrixrows
- int; the number of rows of the matrixcols
- int; the number of columns of the matrixstorageType
- StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
-
FloatElectricalPotentialMatrix
public FloatElectricalPotentialMatrix(Collection<FloatSparseValue<ElectricalPotentialUnit, FloatElectricalPotential>> data, int rows, int cols) Construct a FloatElectricalPotentialMatrix from a (sparse) collection of FloatSparseValue objects. The displayUnit indicates the unit in which the values in the collection are expressed, as well as the unit in which they will be printed. Use the SI unit or base unit as the displayUnit. Assume the storage type is SPARSE, since we offer the data as a collection.- Parameters:
data
- Collection<FloatSparseValue>; the data for the matrixrows
- int; the number of rows of the matrixcols
- int; the number of columns of the matrix
-
-
Method Details
-
getScalarClass
Description copied from class:IndexedValue
Return the class of the corresponding scalar.- Specified by:
getScalarClass
in classIndexedValue<ElectricalPotentialUnit,
FloatElectricalPotential, FloatElectricalPotentialMatrix, FloatMatrixData> - Returns:
- Class<S>; the class of the corresponding scalar
-
getVectorClass
Description copied from class:Matrix
Return the class of the corresponding vector.- Specified by:
getVectorClass
in classMatrix<ElectricalPotentialUnit,
FloatElectricalPotential, FloatElectricalPotentialVector, FloatVectorData, FloatElectricalPotentialMatrix, FloatMatrixData> - Returns:
- Class<V>; the class of the corresponding vector
-
instantiateMatrix
public FloatElectricalPotentialMatrix instantiateMatrix(FloatMatrixData fmd, ElectricalPotentialUnit displayUnit) Description copied from class:FloatMatrix
Instantiate a new matrix of the class of this matrix. This can be used instead of the FloatMatrix.instiantiate() methods in case another matrix of this class is known. The method is faster than FloatMatrix.instantiate, and it will also work if the matrix is user-defined.- Specified by:
instantiateMatrix
in classFloatMatrix<ElectricalPotentialUnit,
FloatElectricalPotential, FloatElectricalPotentialVector, FloatElectricalPotentialMatrix> - Parameters:
fmd
- FloatMatrixData; the data used to instantiate the matrixdisplayUnit
- U; the display unit of the matrix- Returns:
- V; a matrix of the correct type
-
instantiateVector
public FloatElectricalPotentialVector instantiateVector(FloatVectorData fvd, ElectricalPotentialUnit displayUnit) Description copied from class:FloatMatrix
Instantiate a new vector of the class of this matrix. This can be used instead of the FloatVector.instiantiate() methods in case another matrix of this class is known. The method is faster than FloatVector.instantiate, and it will also work if the matrix and/or vector are user-defined.- Specified by:
instantiateVector
in classFloatMatrix<ElectricalPotentialUnit,
FloatElectricalPotential, FloatElectricalPotentialVector, FloatElectricalPotentialMatrix> - Parameters:
fvd
- FloatVectorData; the data used to instantiate the vectordisplayUnit
- U; the display unit of the vector- Returns:
- V; a vector of the correct type
-
instantiateScalarSI
public FloatElectricalPotential instantiateScalarSI(float valueSI, ElectricalPotentialUnit displayUnit) Description copied from class:FloatMatrix
Instantiate a new scalar for the class of this 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.- Specified by:
instantiateScalarSI
in classFloatMatrix<ElectricalPotentialUnit,
FloatElectricalPotential, FloatElectricalPotentialVector, FloatElectricalPotentialMatrix> - Parameters:
valueSI
- float; the SI value of the scalardisplayUnit
- U; the unit in which the value will be displayed- Returns:
- S; a scalar of the correct type, belonging to the matrix type
-