PositionMatrix.java
package org.djunits.value.vdouble.matrix;
import java.util.Collection;
import org.djunits.unit.LengthUnit;
import org.djunits.unit.PositionUnit;
import org.djunits.value.storage.StorageType;
import org.djunits.value.vdouble.matrix.base.DoubleMatrixAbs;
import org.djunits.value.vdouble.matrix.base.DoubleSparseValue;
import org.djunits.value.vdouble.matrix.data.DoubleMatrixData;
import org.djunits.value.vdouble.scalar.Length;
import org.djunits.value.vdouble.scalar.Position;
import org.djunits.value.vdouble.vector.LengthVector;
import org.djunits.value.vdouble.vector.PositionVector;
import org.djunits.value.vdouble.vector.data.DoubleVectorData;
import jakarta.annotation.Generated;
/**
* Immutable Position 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 PositionMatrix extends
DoubleMatrixAbs<PositionUnit, Position, PositionVector, PositionMatrix, LengthUnit, Length, LengthVector, LengthMatrix>
{
/** */
private static final long serialVersionUID = 20151006L;
/**
* Construct a PositionMatrix from an internal data object.
* @param data DoubleMatrixData; the internal data object for the matrix
* @param displayUnit PositionUnit; the display unit of the matrix data
*/
public PositionMatrix(final DoubleMatrixData data, final PositionUnit displayUnit)
{
super(data, displayUnit);
}
/* CONSTRUCTORS WITH double[][] */
/**
* Construct a PositionMatrix 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 PositionUnit; 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 PositionMatrix(final double[][] data, final PositionUnit displayUnit, final StorageType storageType)
{
this(DoubleMatrixData.instantiate(data, displayUnit.getScale(), storageType), displayUnit);
}
/**
* Construct a PositionMatrix 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 PositionUnit; the unit of the values in the data array, and display unit when printing
*/
public PositionMatrix(final double[][] data, final PositionUnit displayUnit)
{
this(data, displayUnit, StorageType.DENSE);
}
/**
* Construct a PositionMatrix 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 PositionMatrix(final double[][] data, final StorageType storageType)
{
this(data, PositionUnit.BASE.getStandardUnit(), storageType);
}
/**
* Construct a PositionMatrix 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 PositionMatrix(final double[][] data)
{
this(data, StorageType.DENSE);
}
/* CONSTRUCTORS WITH Position[][] */
/**
* Construct a PositionMatrix from an array of an array of Position objects. The Position 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 Position[][]; the data for the matrix
* @param displayUnit PositionUnit; the display unit of the values when printing
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
*/
public PositionMatrix(final Position[][] data, final PositionUnit displayUnit, final StorageType storageType)
{
this(DoubleMatrixData.instantiate(data, storageType), displayUnit);
}
/**
* Construct a PositionMatrix from an array of an array of Position objects. The Position 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 Position[][]; the data for the matrix
* @param displayUnit PositionUnit; the display unit of the values when printing
*/
public PositionMatrix(final Position[][] data, final PositionUnit displayUnit)
{
this(data, displayUnit, StorageType.DENSE);
}
/**
* Construct a PositionMatrix from an array of an array of Position objects. The Position 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 Position[][]; the data for the matrix
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Matrix
*/
public PositionMatrix(final Position[][] data, final StorageType storageType)
{
this(data, PositionUnit.BASE.getStandardUnit(), storageType);
}
/**
* Construct a PositionMatrix from an array of an array of Position objects. The Position 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 Position[][]; the data for the matrix
*/
public PositionMatrix(final Position[][] data)
{
this(data, StorageType.DENSE);
}
/* CONSTRUCTORS WITH Collection<DoubleSparseValue> */
/**
* Construct a PositionMatrix 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 PositionUnit; 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 PositionMatrix(final Collection<DoubleSparseValue<PositionUnit, Position>> data, final PositionUnit displayUnit,
final int rows, final int cols, final StorageType storageType)
{
this(DoubleMatrixData.instantiate(data, rows, cols, storageType), displayUnit);
}
/**
* Construct a PositionMatrix 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 PositionUnit; 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 PositionMatrix(final Collection<DoubleSparseValue<PositionUnit, Position>> data, final PositionUnit displayUnit,
final int rows, final int cols)
{
this(data, displayUnit, rows, cols, StorageType.SPARSE);
}
/**
* Construct a PositionMatrix 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 PositionMatrix(final Collection<DoubleSparseValue<PositionUnit, Position>> data, final int rows, final int cols,
final StorageType storageType)
{
this(data, PositionUnit.BASE.getStandardUnit(), rows, cols, storageType);
}
/**
* Construct a PositionMatrix 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 PositionMatrix(final Collection<DoubleSparseValue<PositionUnit, Position>> data, final int rows, final int cols)
{
this(data, PositionUnit.BASE.getStandardUnit(), rows, cols, StorageType.SPARSE);
}
/** {@inheritDoc} */
@Override
public Class<Position> getScalarClass()
{
return Position.class;
}
/** {@inheritDoc} */
@Override
public Class<PositionVector> getVectorClass()
{
return PositionVector.class;
}
/** {@inheritDoc} */
@Override
public PositionMatrix instantiateMatrix(final DoubleMatrixData dmd, final PositionUnit displayUnit)
{
return new PositionMatrix(dmd, displayUnit);
}
/** {@inheritDoc} */
@Override
public PositionVector instantiateVector(final DoubleVectorData dvd, final PositionUnit displayUnit)
{
return new PositionVector(dvd, displayUnit);
}
/** {@inheritDoc} */
@Override
public Position instantiateScalarSI(final double valueSI, final PositionUnit displayUnit)
{
Position result = Position.instantiateSI(valueSI);
result.setDisplayUnit(displayUnit);
return result;
}
/** {@inheritDoc} */
@Override
public LengthMatrix instantiateMatrixRel(final DoubleMatrixData dmd, final LengthUnit displayUnit)
{
return new LengthMatrix(dmd, displayUnit);
}
/** {@inheritDoc} */
@Override
public LengthVector instantiateVectorRel(final DoubleVectorData dvd, final LengthUnit displayUnit)
{
return new LengthVector(dvd, displayUnit);
}
/** {@inheritDoc} */
@Override
public Length instantiateScalarRelSI(final double valueSI, final LengthUnit displayUnit)
{
Length result = Length.instantiateSI(valueSI);
result.setDisplayUnit(displayUnit);
return result;
}
}