AbsoluteTemperatureVector.java

package org.djunits.value.vdouble.vector;

import java.util.List;
import java.util.Map;

import org.djunits.unit.AbsoluteTemperatureUnit;
import org.djunits.unit.TemperatureUnit;
import org.djunits.unit.scale.IdentityScale;
import org.djunits.value.storage.StorageType;
import org.djunits.value.vdouble.scalar.AbsoluteTemperature;
import org.djunits.value.vdouble.scalar.Temperature;
import org.djunits.value.vdouble.vector.base.DoubleVectorAbs;
import org.djunits.value.vdouble.vector.data.DoubleVectorData;

import jakarta.annotation.Generated;

/**
 * Double AbsoluteTemperatureVector, a vector of values with a AbsoluteTemperatureUnit.
 * <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 AbsoluteTemperatureVector extends DoubleVectorAbs<AbsoluteTemperatureUnit, AbsoluteTemperature,
        AbsoluteTemperatureVector, TemperatureUnit, Temperature, TemperatureVector>
{
    /** */
    private static final long serialVersionUID = 20190905L;

    /**
     * Construct an AbsoluteTemperatureVector from an internal data object.
     * @param data DoubleVectorData; the internal data object for the vector
     * @param displayUnit AbsoluteTemperatureUnit; the display unit of the vector data
     */
    public AbsoluteTemperatureVector(final DoubleVectorData data, final AbsoluteTemperatureUnit displayUnit)
    {
        super(data, displayUnit);
    }

    /* CONSTRUCTORS WITH double[] */

    /**
     * Construct an AbsoluteTemperatureVector 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 AbsoluteTemperatureUnit; 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 AbsoluteTemperatureVector(final double[] data, final AbsoluteTemperatureUnit displayUnit,
            final StorageType storageType)
    {
        this(DoubleVectorData.instantiate(data, displayUnit.getScale(), storageType), displayUnit);
    }

    /**
     * Construct an AbsoluteTemperatureVector 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 AbsoluteTemperatureUnit; the unit of the values in the data array, and display unit when printing
     */
    public AbsoluteTemperatureVector(final double[] data, final AbsoluteTemperatureUnit displayUnit)
    {
        this(data, displayUnit, StorageType.DENSE);
    }

    /**
     * Construct an AbsoluteTemperatureVector 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 AbsoluteTemperatureVector(final double[] data, final StorageType storageType)
    {
        this(data, AbsoluteTemperatureUnit.DEFAULT, storageType);
    }

    /**
     * Construct an AbsoluteTemperatureVector 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 AbsoluteTemperatureVector(final double[] data)
    {
        this(data, StorageType.DENSE);
    }

    /* CONSTRUCTORS WITH AbsoluteTemperature[] */

    /**
     * Construct an AbsoluteTemperatureVector from an array of AbsoluteTemperature objects. The AbsoluteTemperature 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 AbsoluteTemperature[]; the data for the vector
     * @param displayUnit AbsoluteTemperatureUnit; the display unit of the values when printing
     * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
     */
    public AbsoluteTemperatureVector(final AbsoluteTemperature[] data, final AbsoluteTemperatureUnit displayUnit,
            final StorageType storageType)
    {
        this(DoubleVectorData.instantiate(data, storageType), displayUnit);
    }

    /**
     * Construct an AbsoluteTemperatureVector from an array of AbsoluteTemperature objects. The AbsoluteTemperature 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 AbsoluteTemperature[]; the data for the vector
     * @param displayUnit AbsoluteTemperatureUnit; the display unit of the values when printing
     */
    public AbsoluteTemperatureVector(final AbsoluteTemperature[] data, final AbsoluteTemperatureUnit displayUnit)
    {
        this(data, displayUnit, StorageType.DENSE);
    }

    /**
     * Construct an AbsoluteTemperatureVector from an array of AbsoluteTemperature objects. The AbsoluteTemperature 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 AbsoluteTemperature[]; the data for the vector
     * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
     */
    public AbsoluteTemperatureVector(final AbsoluteTemperature[] data, final StorageType storageType)
    {
        this(data, AbsoluteTemperatureUnit.DEFAULT, storageType);
    }

    /**
     * Construct an AbsoluteTemperatureVector from an array of AbsoluteTemperature objects. The AbsoluteTemperature 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 AbsoluteTemperature[]; the data for the vector
     */
    public AbsoluteTemperatureVector(final AbsoluteTemperature[] data)
    {
        this(data, StorageType.DENSE);
    }

    /* CONSTRUCTORS WITH List<Double> or List<AbsoluteTemperature> */

    /**
     * Construct an AbsoluteTemperatureVector from a list of Number objects or a list of AbsoluteTemperature objects. Note that
     * the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Double objects) or
     * AbsoluteTemperature 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
     * AbsoluteTemperature objects, each AbsoluteTemperature 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&lt;Double&gt; or List&lt;AbsoluteTemperature&gt;; the data for the vector
     * @param displayUnit AbsoluteTemperatureUnit; the display unit of the vector data, and the unit of the data points when the
     *            data is expressed as List&lt;Double&gt; or List&lt;Number&gt; in general
     * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
     */
    public AbsoluteTemperatureVector(final List<? extends Number> data, final AbsoluteTemperatureUnit displayUnit,
            final StorageType storageType)
    {
        this(data.size() == 0 ? DoubleVectorData.instantiate(new double[] {}, IdentityScale.SCALE, storageType)
                : data.get(0) instanceof AbsoluteTemperature
                        ? DoubleVectorData.instantiate(data, IdentityScale.SCALE, storageType)
                        : DoubleVectorData.instantiate(data, displayUnit.getScale(), storageType),
                displayUnit);
    }

    /**
     * Construct an AbsoluteTemperatureVector from a list of Number objects or a list of AbsoluteTemperature objects. Note that
     * the displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Double objects) or
     * AbsoluteTemperature 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
     * AbsoluteTemperature objects, each AbsoluteTemperature 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&lt;Double&gt; or List&lt;AbsoluteTemperature&gt;; the data for the vector
     * @param displayUnit AbsoluteTemperatureUnit; the display unit of the vector data, and the unit of the data points when the
     *            data is expressed as List&lt;Double&gt; or List&lt;Number&gt; in general
     */
    public AbsoluteTemperatureVector(final List<? extends Number> data, final AbsoluteTemperatureUnit displayUnit)
    {
        this(data, displayUnit, StorageType.DENSE);
    }

    /**
     * Construct an AbsoluteTemperatureVector from a list of Number objects or a list of AbsoluteTemperature objects. When data
     * contains numbers such as Double, assume that they are expressed using SI units. When the data consists of
     * AbsoluteTemperature 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&lt;Double&gt; or List&lt;AbsoluteTemperature&gt;; the data for the vector
     * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
     */
    public AbsoluteTemperatureVector(final List<? extends Number> data, final StorageType storageType)
    {
        this(data, AbsoluteTemperatureUnit.DEFAULT, storageType);
    }

    /**
     * Construct an AbsoluteTemperatureVector from a list of Number objects or a list of AbsoluteTemperature objects. When data
     * contains numbers such as Double, assume that they are expressed using SI units. When the data consists of
     * AbsoluteTemperature 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&lt;Double&gt; or List&lt;AbsoluteTemperature&gt;; the data for the vector
     */
    public AbsoluteTemperatureVector(final List<? extends Number> data)
    {
        this(data, StorageType.DENSE);
    }

    /* CONSTRUCTORS WITH Map<Integer, Double> or Map<Integer, AbsoluteTemperature> */

    /**
     * Construct an AbsoluteTemperatureVector from a (sparse) map of index values to Number objects or a (sparse) map of index
     * values to of AbsoluteTemperature 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
     * AbsoluteTemperature 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
     * AbsoluteTemperature objects, each AbsoluteTemperature 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&lt;Integer, Double&gt; or Map&lt;Integer, AbsoluteTemperature&gt;; the data for the vector
     * @param size int; the size off the vector, i.e., the highest index
     * @param displayUnit AbsoluteTemperatureUnit; the display unit of the vector data, and the unit of the data points when the
     *            data is expressed as List&lt;Double&gt; or List&lt;Number&gt; in general
     * @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
     */
    public AbsoluteTemperatureVector(final Map<Integer, ? extends Number> data, final int size,
            final AbsoluteTemperatureUnit displayUnit, final StorageType storageType)
    {
        this(data.size() == 0 ? DoubleVectorData.instantiate(data, size, IdentityScale.SCALE, storageType)
                : data.values().iterator().next() instanceof AbsoluteTemperature
                        ? DoubleVectorData.instantiate(data, size, IdentityScale.SCALE, storageType)
                        : DoubleVectorData.instantiate(data, size, displayUnit.getScale(), storageType),
                displayUnit);
    }

    /**
     * Construct an AbsoluteTemperatureVector from a (sparse) map of index values to Number objects or a (sparse) map of index
     * values to of AbsoluteTemperature 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
     * AbsoluteTemperature 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
     * AbsoluteTemperature objects, each AbsoluteTemperature 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&lt;Integer, Double&gt; or Map&lt;Integer, AbsoluteTemperature&gt;; the data for the vector
     * @param size int; the size off the vector, i.e., the highest index
     * @param displayUnit AbsoluteTemperatureUnit; the display unit of the vector data, and the unit of the data points when the
     *            data is expressed as List&lt;Double&gt; or List&lt;Number&gt; in general
     */
    public AbsoluteTemperatureVector(final Map<Integer, ? extends Number> data, final int size,
            final AbsoluteTemperatureUnit displayUnit)
    {
        this(data, size, displayUnit, StorageType.SPARSE);
    }

    /**
     * Construct an AbsoluteTemperatureVector from a (sparse) map of index values to Number objects or a (sparse) map of index
     * values to of AbsoluteTemperature 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
     * AbsoluteTemperature 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&lt;Integer, Double&gt; or Map&lt;Integer, AbsoluteTemperature&gt;; 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 AbsoluteTemperatureVector(final Map<Integer, ? extends Number> data, final int size, final StorageType storageType)
    {
        this(data, size, AbsoluteTemperatureUnit.DEFAULT, storageType);
    }

    /**
     * Construct an AbsoluteTemperatureVector from a (sparse) map of index values to Number objects or a (sparse) map of index
     * values to of AbsoluteTemperature 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
     * AbsoluteTemperature 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&lt;Integer, Double&gt; or Map&lt;Integer, AbsoluteTemperature&gt;; the data for the vector
     * @param size int; the size off the vector, i.e., the highest index
     */
    public AbsoluteTemperatureVector(final Map<Integer, ? extends Number> data, final int size)
    {
        this(data, size, StorageType.SPARSE);
    }

    /* ****************************** Other methods ****************************** */

    @Override
    public Class<AbsoluteTemperature> getScalarClass()
    {
        return AbsoluteTemperature.class;
    }

    @Override
    public AbsoluteTemperatureVector instantiateVector(final DoubleVectorData dvd, final AbsoluteTemperatureUnit displayUnit)
    {
        return new AbsoluteTemperatureVector(dvd, displayUnit);
    }

    @Override
    public AbsoluteTemperature instantiateScalarSI(final double valueSI, final AbsoluteTemperatureUnit displayUnit)
    {
        AbsoluteTemperature result = AbsoluteTemperature.instantiateSI(valueSI);
        result.setDisplayUnit(displayUnit);
        return result;
    }

    @Override
    public TemperatureVector instantiateVectorRel(final DoubleVectorData dvd, final TemperatureUnit displayUnit)
    {
        return new TemperatureVector(dvd, displayUnit);
    }

    @Override
    public Temperature instantiateScalarRelSI(final double valueSI, final TemperatureUnit displayUnit)
    {
        Temperature result = Temperature.instantiateSI(valueSI);
        result.setDisplayUnit(displayUnit);
        return result;
    }

}