FrequencyMatrix.java
package org.djunits.value.vdouble.matrix;
import java.util.Collection;
import org.djunits.unit.FrequencyUnit;
import org.djunits.value.storage.StorageType;
import org.djunits.value.vdouble.matrix.base.DoubleMatrixRel;
import org.djunits.value.vdouble.matrix.base.DoubleSparseValue;
import org.djunits.value.vdouble.matrix.data.DoubleMatrixData;
import org.djunits.value.vdouble.scalar.Frequency;
import org.djunits.value.vdouble.vector.FrequencyVector;
import org.djunits.value.vdouble.vector.data.DoubleVectorData;
import jakarta.annotation.Generated;
/**
* Immutable Double FrequencyMatrix, a matrix of values with a FrequencyUnit.
* <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 FrequencyMatrix extends DoubleMatrixRel<FrequencyUnit, Frequency, FrequencyVector, FrequencyMatrix>
{
/** */
private static final long serialVersionUID = 20151109L;
/**
* Construct a FrequencyMatrix from an internal data object.
* @param data DoubleMatrixData; the internal data object for the matrix
* @param displayUnit FrequencyUnit; the display unit of the matrix data
*/
public FrequencyMatrix(final DoubleMatrixData data, final FrequencyUnit displayUnit)
{
super(data, displayUnit);
}
/* CONSTRUCTORS WITH double[][] */
/**
* Construct a FrequencyMatrix from a double[][] object. The double values are expressed in the displayUnit, and will be
* printed using the displayUnit.
* @param data double[][]; the data for the matrix, expressed in the displayUnit
* @param displayUnit FrequencyUnit; 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 FrequencyMatrix(final double[][] data, final FrequencyUnit displayUnit, final StorageType storageType)
{
this(DoubleMatrixData.instantiate(data, displayUnit.getScale(), storageType), displayUnit);
}
/**
* Construct a FrequencyMatrix from a double[][] object. The double 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 double[][]; the data for the matrix
* @param displayUnit FrequencyUnit; the unit of the values in the data array, and display unit when printing
*/
public FrequencyMatrix(final double[][] data, final FrequencyUnit displayUnit)
{
this(data, displayUnit, StorageType.DENSE);
}
/**
* Construct a FrequencyMatrix from a double[][] object with SI-unit values.
* @param data double[][]; the data for the matrix, in SI units
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
*/
public FrequencyMatrix(final double[][] data, final StorageType storageType)
{
this(data, FrequencyUnit.SI, storageType);
}
/**
* Construct a FrequencyMatrix from a double[][] object with SI-unit values. Assume that the StorageType is DENSE since we
* offer the data as an array of an array.
* @param data double[][]; the data for the matrix, in SI units
*/
public FrequencyMatrix(final double[][] data)
{
this(data, StorageType.DENSE);
}
/* CONSTRUCTORS WITH Frequency[][] */
/**
* Construct a FrequencyMatrix from an array of an array of Frequency objects. The Frequency 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 Frequency[][]; the data for the matrix
* @param displayUnit FrequencyUnit; the display unit of the values when printing
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
*/
public FrequencyMatrix(final Frequency[][] data, final FrequencyUnit displayUnit, final StorageType storageType)
{
this(DoubleMatrixData.instantiate(data, storageType), displayUnit);
}
/**
* Construct a FrequencyMatrix from an array of an array of Frequency objects. The Frequency 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 Frequency[][]; the data for the matrix
* @param displayUnit FrequencyUnit; the display unit of the values when printing
*/
public FrequencyMatrix(final Frequency[][] data, final FrequencyUnit displayUnit)
{
this(data, displayUnit, StorageType.DENSE);
}
/**
* Construct a FrequencyMatrix from an array of an array of Frequency objects. The Frequency 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 Frequency[][]; the data for the matrix
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
*/
public FrequencyMatrix(final Frequency[][] data, final StorageType storageType)
{
this(data, FrequencyUnit.SI, storageType);
}
/**
* Construct a FrequencyMatrix from an array of an array of Frequency objects. The Frequency 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 Frequency[][]; the data for the matrix
*/
public FrequencyMatrix(final Frequency[][] data)
{
this(data, StorageType.DENSE);
}
/* CONSTRUCTORS WITH Collection<DoubleSparseValue> */
/**
* Construct a FrequencyMatrix from a (sparse) collection of DoubleSparseValue 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<DoubleSparseValue>; the data for the matrix
* @param displayUnit FrequencyUnit; 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 FrequencyMatrix(final Collection<DoubleSparseValue<FrequencyUnit, Frequency>> data, final FrequencyUnit displayUnit,
final int rows, final int cols, final StorageType storageType)
{
this(DoubleMatrixData.instantiate(data, rows, cols, storageType), displayUnit);
}
/**
* Construct a FrequencyMatrix from a (sparse) collection of DoubleSparseValue 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<DoubleSparseValue>; the data for the matrix
* @param displayUnit FrequencyUnit; 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 FrequencyMatrix(final Collection<DoubleSparseValue<FrequencyUnit, Frequency>> data, final FrequencyUnit displayUnit,
final int rows, final int cols)
{
this(data, displayUnit, rows, cols, StorageType.SPARSE);
}
/**
* Construct a FrequencyMatrix from a (sparse) collection of DoubleSparseValue 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<DoubleSparseValue>; 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 FrequencyMatrix(final Collection<DoubleSparseValue<FrequencyUnit, Frequency>> data, final int rows, final int cols,
final StorageType storageType)
{
this(data, FrequencyUnit.SI, rows, cols, storageType);
}
/**
* Construct a FrequencyMatrix from a (sparse) collection of DoubleSparseValue 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<DoubleSparseValue>; 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 FrequencyMatrix(final Collection<DoubleSparseValue<FrequencyUnit, Frequency>> data, final int rows, final int cols)
{
this(data, FrequencyUnit.SI, rows, cols, StorageType.SPARSE);
}
@Override
public Class<Frequency> getScalarClass()
{
return Frequency.class;
}
@Override
public Class<FrequencyVector> getVectorClass()
{
return FrequencyVector.class;
}
@Override
public FrequencyMatrix instantiateMatrix(final DoubleMatrixData dmd, final FrequencyUnit displayUnit)
{
return new FrequencyMatrix(dmd, displayUnit);
}
@Override
public FrequencyVector instantiateVector(final DoubleVectorData dvd, final FrequencyUnit displayUnit)
{
return new FrequencyVector(dvd, displayUnit);
}
@Override
public Frequency instantiateScalarSI(final double valueSI, final FrequencyUnit displayUnit)
{
Frequency result = Frequency.instantiateSI(valueSI);
result.setDisplayUnit(displayUnit);
return result;
}
}