FloatVolumeMatrix.java
package org.djunits.value.vfloat.matrix;
import java.util.Collection;
import org.djunits.unit.VolumeUnit;
import org.djunits.value.storage.StorageType;
import org.djunits.value.vfloat.matrix.base.FloatMatrixRel;
import org.djunits.value.vfloat.matrix.base.FloatSparseValue;
import org.djunits.value.vfloat.matrix.data.FloatMatrixData;
import org.djunits.value.vfloat.scalar.FloatVolume;
import org.djunits.value.vfloat.vector.FloatVolumeVector;
import org.djunits.value.vfloat.vector.data.FloatVectorData;
import jakarta.annotation.Generated;
/**
* Immutable FloatFloatVolumeMatrix, a matrix of values with a VolumeUnit.
* <p>
* Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
* BSD-style license. See <a href="https://djunits.org/docs/license.html">DJUNITS License</a>.
* </p>
* @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck</a>
* @author <a href="https://www.tudelft.nl/staff/p.knoppers/">Peter Knoppers</a>
*/
@Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2023-07-23T14:06:38.224104100Z")
public class FloatVolumeMatrix extends FloatMatrixRel<VolumeUnit, FloatVolume, FloatVolumeVector, FloatVolumeMatrix>
{
/** */
private static final long serialVersionUID = 20151109L;
/**
* Construct a FloatVolumeMatrix from an internal data object.
* @param data FloatMatrixData; the internal data object for the matrix
* @param displayUnit VolumeUnit; the display unit of the matrix data
*/
public FloatVolumeMatrix(final FloatMatrixData data, final VolumeUnit displayUnit)
{
super(data, displayUnit);
}
/* CONSTRUCTORS WITH float[][] */
/**
* Construct a FloatVolumeMatrix from a float[][] object. The float values are expressed in the displayUnit, and will be
* printed using the displayUnit.
* @param data float[][]; the data for the matrix, expressed in the displayUnit
* @param displayUnit VolumeUnit; the unit of the values in the data array, and display unit when printing
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
*/
public FloatVolumeMatrix(final float[][] data, final VolumeUnit displayUnit, final StorageType storageType)
{
this(FloatMatrixData.instantiate(data, displayUnit.getScale(), storageType), displayUnit);
}
/**
* Construct a FloatVolumeMatrix 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.
* @param data float[][]; the data for the matrix
* @param displayUnit VolumeUnit; the unit of the values in the data array, and display unit when printing
*/
public FloatVolumeMatrix(final float[][] data, final VolumeUnit displayUnit)
{
this(data, displayUnit, StorageType.DENSE);
}
/**
* Construct a FloatVolumeMatrix from a float[][] object with SI-unit values.
* @param data float[][]; the data for the matrix, in SI units
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
*/
public FloatVolumeMatrix(final float[][] data, final StorageType storageType)
{
this(data, VolumeUnit.SI, storageType);
}
/**
* Construct a FloatVolumeMatrix 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.
* @param data float[][]; the data for the matrix, in SI units
*/
public FloatVolumeMatrix(final float[][] data)
{
this(data, StorageType.DENSE);
}
/* CONSTRUCTORS WITH Volume[][] */
/**
* Construct a FloatVolumeMatrix from an array of an array of FloatVolume objects. The FloatVolume values are each expressed
* in their own unit, but will be internally stored as SI values, all expressed in the displayUnit when printing.
* @param data FloatVolume[][]; the data for the matrix
* @param displayUnit VolumeUnit; the display unit of the values when printing
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
*/
public FloatVolumeMatrix(final FloatVolume[][] data, final VolumeUnit displayUnit, final StorageType storageType)
{
this(FloatMatrixData.instantiate(data, storageType), displayUnit);
}
/**
* Construct a FloatVolumeMatrix from an array of an array of FloatVolume objects. The FloatVolume 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.
* @param data FloatVolume[][]; the data for the matrix
* @param displayUnit VolumeUnit; the display unit of the values when printing
*/
public FloatVolumeMatrix(final FloatVolume[][] data, final VolumeUnit displayUnit)
{
this(data, displayUnit, StorageType.DENSE);
}
/**
* Construct a FloatVolumeMatrix from an array of an array of FloatVolume objects. The FloatVolume 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.
* @param data FloatVolume[][]; the data for the matrix
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
*/
public FloatVolumeMatrix(final FloatVolume[][] data, final StorageType storageType)
{
this(data, VolumeUnit.SI, storageType);
}
/**
* Construct a FloatVolumeMatrix from an array of an array of FloatVolume objects. The FloatVolume 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.
* @param data FloatVolume[][]; the data for the matrix
*/
public FloatVolumeMatrix(final FloatVolume[][] data)
{
this(data, StorageType.DENSE);
}
/* CONSTRUCTORS WITH Collection<FloatSparseValue> */
/**
* Construct a FloatVolumeMatrix 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.
* @param data Collection<FloatSparseValue>; the data for the matrix
* @param displayUnit VolumeUnit; the display unit of the matrix data, and the unit of the data points
* @param rows int; the number of rows of the matrix
* @param cols int; the number of columns of the matrix
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
*/
public FloatVolumeMatrix(final Collection<FloatSparseValue<VolumeUnit, FloatVolume>> data, final VolumeUnit displayUnit,
final int rows, final int cols, final StorageType storageType)
{
this(FloatMatrixData.instantiate(data, rows, cols, storageType), displayUnit);
}
/**
* Construct a FloatVolumeMatrix 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.
* @param data Collection<FloatSparseValue>; the data for the matrix
* @param displayUnit VolumeUnit; the display unit of the matrix data, and the unit of the data points
* @param rows int; the number of rows of the matrix
* @param cols int; the number of columns of the matrix
*/
public FloatVolumeMatrix(final Collection<FloatSparseValue<VolumeUnit, FloatVolume>> data, final VolumeUnit displayUnit,
final int rows, final int cols)
{
this(data, displayUnit, rows, cols, StorageType.SPARSE);
}
/**
* Construct a FloatVolumeMatrix 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.
* @param data Collection<FloatSparseValue>; the data for the matrix
* @param rows int; the number of rows of the matrix
* @param cols int; the number of columns of the matrix
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
*/
public FloatVolumeMatrix(final Collection<FloatSparseValue<VolumeUnit, FloatVolume>> data, final int rows, final int cols,
final StorageType storageType)
{
this(data, VolumeUnit.SI, rows, cols, storageType);
}
/**
* Construct a FloatVolumeMatrix 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.
* @param data Collection<FloatSparseValue>; the data for the matrix
* @param rows int; the number of rows of the matrix
* @param cols int; the number of columns of the matrix
*/
public FloatVolumeMatrix(final Collection<FloatSparseValue<VolumeUnit, FloatVolume>> data, final int rows, final int cols)
{
this(data, VolumeUnit.SI, rows, cols, StorageType.SPARSE);
}
@Override
public Class<FloatVolume> getScalarClass()
{
return FloatVolume.class;
}
@Override
public Class<FloatVolumeVector> getVectorClass()
{
return FloatVolumeVector.class;
}
@Override
public FloatVolumeMatrix instantiateMatrix(final FloatMatrixData fmd, final VolumeUnit displayUnit)
{
return new FloatVolumeMatrix(fmd, displayUnit);
}
@Override
public FloatVolumeVector instantiateVector(final FloatVectorData fvd, final VolumeUnit displayUnit)
{
return new FloatVolumeVector(fvd, displayUnit);
}
@Override
public FloatVolume instantiateScalarSI(final float valueSI, final VolumeUnit displayUnit)
{
FloatVolume result = FloatVolume.instantiateSI(valueSI);
result.setDisplayUnit(displayUnit);
return result;
}
}