PositionVector.java
package org.djunits.value.vdouble.vector;
import java.util.List;
import java.util.Map;
import org.djunits.unit.LengthUnit;
import org.djunits.unit.PositionUnit;
import org.djunits.unit.scale.IdentityScale;
import org.djunits.value.storage.StorageType;
import org.djunits.value.vdouble.scalar.Length;
import org.djunits.value.vdouble.scalar.Position;
import org.djunits.value.vdouble.vector.base.DoubleVectorAbs;
import org.djunits.value.vdouble.vector.data.DoubleVectorData;
import jakarta.annotation.Generated;
/**
* Double PositionVector, a vector of values with a PositionUnit.
* <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 PositionVector extends DoubleVectorAbs<PositionUnit, Position, PositionVector, LengthUnit, Length, LengthVector>
{
/** */
private static final long serialVersionUID = 20190905L;
/**
* Construct an PositionVector from an internal data object.
* @param data DoubleVectorData; the internal data object for the vector
* @param displayUnit PositionUnit; the display unit of the vector data
*/
public PositionVector(final DoubleVectorData data, final PositionUnit displayUnit)
{
super(data, displayUnit);
}
/* CONSTRUCTORS WITH double[] */
/**
* Construct an PositionVector 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 vector, 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 Vector
*/
public PositionVector(final double[] data, final PositionUnit displayUnit, final StorageType storageType)
{
this(DoubleVectorData.instantiate(data, displayUnit.getScale(), storageType), displayUnit);
}
/**
* Construct an PositionVector 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.
* @param data double[]; the data for the vector
* @param displayUnit PositionUnit; the unit of the values in the data array, and display unit when printing
*/
public PositionVector(final double[] data, final PositionUnit displayUnit)
{
this(data, displayUnit, StorageType.DENSE);
}
/**
* Construct an PositionVector from a double[] object with SI-unit values.
* @param data double[]; the data for the vector, in SI units
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
*/
public PositionVector(final double[] data, final StorageType storageType)
{
this(data, PositionUnit.DEFAULT, storageType);
}
/**
* Construct an PositionVector from a double[] object with SI-unit values. Assume that the StorageType is DENSE since we
* offer the data as an array.
* @param data double[]; the data for the vector, in SI units
*/
public PositionVector(final double[] data)
{
this(data, StorageType.DENSE);
}
/* CONSTRUCTORS WITH Position[] */
/**
* Construct an PositionVector from 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 vector
* @param displayUnit PositionUnit; the display unit of the values when printing
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
*/
public PositionVector(final Position[] data, final PositionUnit displayUnit, final StorageType storageType)
{
this(DoubleVectorData.instantiate(data, storageType), displayUnit);
}
/**
* Construct an PositionVector from 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.
* @param data Position[]; the data for the vector
* @param displayUnit PositionUnit; the display unit of the values when printing
*/
public PositionVector(final Position[] data, final PositionUnit displayUnit)
{
this(data, displayUnit, StorageType.DENSE);
}
/**
* Construct an PositionVector from 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.
* @param data Position[]; the data for the vector
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
*/
public PositionVector(final Position[] data, final StorageType storageType)
{
this(data, PositionUnit.DEFAULT, storageType);
}
/**
* Construct an PositionVector from 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.
* @param data Position[]; the data for the vector
*/
public PositionVector(final Position[] data)
{
this(data, StorageType.DENSE);
}
/* CONSTRUCTORS WITH List<Double> or List<Position> */
/**
* Construct an PositionVector from a list of Number objects or a list of Position objects. Note that the displayUnit has a
* different meaning depending on whether the list contains Number objects (e.g., Double objects) or Position objects. In
* case the list contains Number objects, the displayUnit indicates the unit in which the values in the list are expressed,
* as well as the unit in which they will be printed. In case the list contains Position objects, each Position has its own
* unit, and the displayUnit is just used for printing. The values but will always be internally stored as SI values or base
* values, and expressed using the display unit or base unit when printing.
* @param data List<Double> or List<Position>; the data for the vector
* @param displayUnit PositionUnit; the display unit of the vector data, and the unit of the data points when the data is
* expressed as List<Double> or List<Number> in general
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
*/
public PositionVector(final List<? extends Number> data, final PositionUnit displayUnit, final StorageType storageType)
{
this(data.size() == 0 ? DoubleVectorData.instantiate(new double[] {}, IdentityScale.SCALE, storageType)
: data.get(0) instanceof Position ? DoubleVectorData.instantiate(data, IdentityScale.SCALE, storageType)
: DoubleVectorData.instantiate(data, displayUnit.getScale(), storageType),
displayUnit);
}
/**
* Construct an PositionVector from a list of Number objects or a list of Position objects. Note that the displayUnit has a
* different meaning depending on whether the list contains Number objects (e.g., Double objects) or Position objects. In
* case the list contains Number objects, the displayUnit indicates the unit in which the values in the list are expressed,
* as well as the unit in which they will be printed. In case the list contains Position objects, each Position has its own
* unit, and the displayUnit is just used for printing. The values but will always be internally stored as SI values or base
* values, and expressed using the display unit or base unit when printing. Assume the storage type is DENSE since we offer
* the data as a List.
* @param data List<Double> or List<Position>; the data for the vector
* @param displayUnit PositionUnit; the display unit of the vector data, and the unit of the data points when the data is
* expressed as List<Double> or List<Number> in general
*/
public PositionVector(final List<? extends Number> data, final PositionUnit displayUnit)
{
this(data, displayUnit, StorageType.DENSE);
}
/**
* Construct an PositionVector from a list of Number objects or a list of Position objects. When data contains numbers such
* as Double, assume that they are expressed using SI units. When the data consists of Position objects, they each have
* their own unit, but will be printed using SI units or base units. The values but will always be internally stored as SI
* values or base values, and expressed using the display unit or base unit when printing.
* @param data List<Double> or List<Position>; the data for the vector
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
*/
public PositionVector(final List<? extends Number> data, final StorageType storageType)
{
this(data, PositionUnit.DEFAULT, storageType);
}
/**
* Construct an PositionVector from a list of Number objects or a list of Position objects. When data contains numbers such
* as Double, assume that they are expressed using SI units. When the data consists of Position objects, they each have
* their own unit, but will be printed using SI units or base units. The values but will always be internally stored as SI
* values or base values, and expressed using the display unit or base unit when printing. Assume the storage type is DENSE
* since we offer the data as a List.
* @param data List<Double> or List<Position>; the data for the vector
*/
public PositionVector(final List<? extends Number> data)
{
this(data, StorageType.DENSE);
}
/* CONSTRUCTORS WITH Map<Integer, Double> or Map<Integer, Position> */
/**
* Construct an PositionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of
* Position objects. Using index values is particularly useful for sparse vectors. The size parameter indicates the size of
* the vector, since the largest index does not have to be part of the map. Note that the displayUnit has a different
* meaning depending on whether the map contains Number objects (e.g., Double objects) or Position objects. In case the map
* contains Number objects, the displayUnit indicates the unit in which the values in the map are expressed, as well as the
* unit in which they will be printed. In case the map contains Position objects, each Position has its own unit, and the
* displayUnit is just used for printing. The values but will always be internally stored as SI values or base values, and
* expressed using the display unit or base unit when printing.
* @param data Map<Integer, Double> or Map<Integer, Position>; the data for the vector
* @param size int; the size off the vector, i.e., the highest index
* @param displayUnit PositionUnit; the display unit of the vector data, and the unit of the data points when the data is
* expressed as List<Double> or List<Number> in general
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
*/
public PositionVector(final Map<Integer, ? extends Number> data, final int size, final PositionUnit displayUnit,
final StorageType storageType)
{
this(data.size() == 0 ? DoubleVectorData.instantiate(data, size, IdentityScale.SCALE, storageType)
: data.values().iterator().next() instanceof Position
? DoubleVectorData.instantiate(data, size, IdentityScale.SCALE, storageType)
: DoubleVectorData.instantiate(data, size, displayUnit.getScale(), storageType),
displayUnit);
}
/**
* Construct an PositionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of
* Position objects. Using index values is particularly useful for sparse vectors. The size parameter indicates the size of
* the vector, since the largest index does not have to be part of the map. Note that the displayUnit has a different
* meaning depending on whether the map contains Number objects (e.g., Double objects) or Position objects. In case the map
* contains Number objects, the displayUnit indicates the unit in which the values in the map are expressed, as well as the
* unit in which they will be printed. In case the map contains Position objects, each Position has its own unit, and the
* displayUnit is just used for printing. The values but will always be internally stored as SI values or base values, and
* expressed using the display unit or base unit when printing. Assume the storage type is SPARSE since we offer the data as
* a Map.
* @param data Map<Integer, Double> or Map<Integer, Position>; the data for the vector
* @param size int; the size off the vector, i.e., the highest index
* @param displayUnit PositionUnit; the display unit of the vector data, and the unit of the data points when the data is
* expressed as List<Double> or List<Number> in general
*/
public PositionVector(final Map<Integer, ? extends Number> data, final int size, final PositionUnit displayUnit)
{
this(data, size, displayUnit, StorageType.SPARSE);
}
/**
* Construct an PositionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of
* Position objects. Using index values is particularly useful for sparse vectors. The size parameter indicates the size of
* the vector, since the largest index does not have to be part of the map. When data contains numbers such as Double,
* assume that they are expressed using SI units. When the data consists of Position objects, they each have their own unit,
* but will be printed using SI units or base units. The values but will always be internally stored as SI values or base
* values, and expressed using the display unit or base unit when printing.
* @param data Map<Integer, Double> or Map<Integer, Position>; the data for the vector
* @param size int; the size off the vector, i.e., the highest index
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
*/
public PositionVector(final Map<Integer, ? extends Number> data, final int size, final StorageType storageType)
{
this(data, size, PositionUnit.DEFAULT, storageType);
}
/**
* Construct an PositionVector from a (sparse) map of index values to Number objects or a (sparse) map of index values to of
* Position objects. Using index values is particularly useful for sparse vectors. The size parameter indicates the size of
* the vector, since the largest index does not have to be part of the map. When data contains numbers such as Double,
* assume that they are expressed using SI units. When the data consists of Position objects, they each have their own unit,
* but will be printed using SI units or base units. The values but will always be internally stored as SI values or base
* values, and expressed using the display unit or base unit when printing. Assume the storage type is SPARSE since we offer
* the data as a Map.
* @param data Map<Integer, Double> or Map<Integer, Position>; the data for the vector
* @param size int; the size off the vector, i.e., the highest index
*/
public PositionVector(final Map<Integer, ? extends Number> data, final int size)
{
this(data, size, StorageType.SPARSE);
}
/* ****************************** Other methods ****************************** */
/** {@inheritDoc} */
@Override
public Class<Position> getScalarClass()
{
return Position.class;
}
/** {@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 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;
}
}