FloatTimeMatrix.java
package org.djunits.value.vfloat.matrix;
import java.util.Collection;
import org.djunits.unit.DurationUnit;
import org.djunits.unit.TimeUnit;
import org.djunits.value.storage.StorageType;
import org.djunits.value.vfloat.matrix.base.FloatMatrixAbs;
import org.djunits.value.vfloat.matrix.base.FloatSparseValue;
import org.djunits.value.vfloat.matrix.data.FloatMatrixData;
import org.djunits.value.vfloat.scalar.FloatDuration;
import org.djunits.value.vfloat.scalar.FloatTime;
import org.djunits.value.vfloat.vector.FloatDurationVector;
import org.djunits.value.vfloat.vector.FloatTimeVector;
import org.djunits.value.vfloat.vector.data.FloatVectorData;
import jakarta.annotation.Generated;
/**
* Immutable FloatTime Matrix.
* <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 FloatTimeMatrix extends FloatMatrixAbs<TimeUnit, FloatTime, FloatTimeVector, FloatTimeMatrix, DurationUnit,
FloatDuration, FloatDurationVector, FloatDurationMatrix>
{
/** */
private static final long serialVersionUID = 20151006L;
/**
* Construct a TimeMatrix from an internal data object.
* @param data FloatMatrixData; the internal data object for the matrix
* @param displayUnit TimeUnit; the display unit of the matrix data
*/
public FloatTimeMatrix(final FloatMatrixData data, final TimeUnit displayUnit)
{
super(data, displayUnit);
}
/* CONSTRUCTORS WITH float[][] */
/**
* Construct a FloatTimeMatrix 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 TimeUnit; 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 FloatTimeMatrix(final float[][] data, final TimeUnit displayUnit, final StorageType storageType)
{
this(FloatMatrixData.instantiate(data, displayUnit.getScale(), storageType), displayUnit);
}
/**
* Construct a FloatTimeMatrix 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 TimeUnit; the unit of the values in the data array, and display unit when printing
*/
public FloatTimeMatrix(final float[][] data, final TimeUnit displayUnit)
{
this(data, displayUnit, StorageType.DENSE);
}
/**
* Construct a FloatTimeMatrix 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 FloatTimeMatrix(final float[][] data, final StorageType storageType)
{
this(data, TimeUnit.BASE.getStandardUnit(), storageType);
}
/**
* Construct a FloatTimeMatrix 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 FloatTimeMatrix(final float[][] data)
{
this(data, StorageType.DENSE);
}
/* CONSTRUCTORS WITH FloatTime[][] */
/**
* Construct a FloatTimeMatrix from an array of an array of FloatTime objects. The FloatTime 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 FloatTime[][]; the data for the matrix
* @param displayUnit TimeUnit; the display unit of the values when printing
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
*/
public FloatTimeMatrix(final FloatTime[][] data, final TimeUnit displayUnit, final StorageType storageType)
{
this(FloatMatrixData.instantiate(data, storageType), displayUnit);
}
/**
* Construct a FloatTimeMatrix from an array of an array of FloatTime objects. The FloatTime 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 FloatTime[][]; the data for the matrix
* @param displayUnit TimeUnit; the display unit of the values when printing
*/
public FloatTimeMatrix(final FloatTime[][] data, final TimeUnit displayUnit)
{
this(data, displayUnit, StorageType.DENSE);
}
/**
* Construct a FloatTimeMatrix from an array of an array of FloatTime objects. The FloatTime 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 FloatTime[][]; the data for the matrix
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
*/
public FloatTimeMatrix(final FloatTime[][] data, final StorageType storageType)
{
this(data, TimeUnit.BASE.getStandardUnit(), storageType);
}
/**
* Construct a FloatTimeMatrix from an array of an array of FloatTime objects. The FloatTime 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 FloatTime[][]; the data for the matrix
*/
public FloatTimeMatrix(final FloatTime[][] data)
{
this(data, StorageType.DENSE);
}
/* CONSTRUCTORS WITH Collection<FloatSparseValue> */
/**
* Construct a FloatTimeMatrix 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 TimeUnit; 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 FloatTimeMatrix(final Collection<FloatSparseValue<TimeUnit, FloatTime>> data, final TimeUnit displayUnit,
final int rows, final int cols, final StorageType storageType)
{
this(FloatMatrixData.instantiate(data, rows, cols, storageType), displayUnit);
}
/**
* Construct a FloatTimeMatrix 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 TimeUnit; 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 FloatTimeMatrix(final Collection<FloatSparseValue<TimeUnit, FloatTime>> data, final TimeUnit displayUnit,
final int rows, final int cols)
{
this(data, displayUnit, rows, cols, StorageType.SPARSE);
}
/**
* Construct a FloatTimeMatrix 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 FloatTimeMatrix(final Collection<FloatSparseValue<TimeUnit, FloatTime>> data, final int rows, final int cols,
final StorageType storageType)
{
this(data, TimeUnit.BASE.getStandardUnit(), rows, cols, storageType);
}
/**
* Construct a FloatTimeMatrix 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 FloatTimeMatrix(final Collection<FloatSparseValue<TimeUnit, FloatTime>> data, final int rows, final int cols)
{
this(data, TimeUnit.BASE.getStandardUnit(), rows, cols, StorageType.SPARSE);
}
/** {@inheritDoc} */
@Override
public Class<FloatTime> getScalarClass()
{
return FloatTime.class;
}
/** {@inheritDoc} */
@Override
public Class<FloatTimeVector> getVectorClass()
{
return FloatTimeVector.class;
}
/** {@inheritDoc} */
@Override
public FloatTimeMatrix instantiateMatrix(final FloatMatrixData fmd, final TimeUnit displayUnit)
{
return new FloatTimeMatrix(fmd, displayUnit);
}
/** {@inheritDoc} */
@Override
public FloatTimeVector instantiateVector(final FloatVectorData fvd, final TimeUnit displayUnit)
{
return new FloatTimeVector(fvd, displayUnit);
}
/** {@inheritDoc} */
@Override
public FloatTime instantiateScalarSI(final float valueSI, final TimeUnit displayUnit)
{
FloatTime result = FloatTime.instantiateSI(valueSI);
result.setDisplayUnit(displayUnit);
return result;
}
/** {@inheritDoc} */
@Override
public FloatDurationMatrix instantiateMatrixRel(final FloatMatrixData fmd, final DurationUnit displayUnit)
{
return new FloatDurationMatrix(fmd, displayUnit);
}
/** {@inheritDoc} */
@Override
public FloatDurationVector instantiateVectorRel(final FloatVectorData fvd, final DurationUnit displayUnit)
{
return new FloatDurationVector(fvd, displayUnit);
}
/** {@inheritDoc} */
@Override
public FloatDuration instantiateScalarRelSI(final float valueSI, final DurationUnit displayUnit)
{
FloatDuration result = FloatDuration.instantiateSI(valueSI);
result.setDisplayUnit(displayUnit);
return result;
}
}