FloatFrequencyVector.java
package org.djunits.value.vfloat.vector;
import java.util.List;
import java.util.Map;
import org.djunits.unit.FrequencyUnit;
import org.djunits.unit.scale.IdentityScale;
import org.djunits.value.storage.StorageType;
import org.djunits.value.vfloat.scalar.FloatFrequency;
import org.djunits.value.vfloat.vector.base.FloatVectorRel;
import org.djunits.value.vfloat.vector.data.FloatVectorData;
import jakarta.annotation.Generated;
/**
* Immutable Float FloatFrequencyVector, a vector 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 FloatFrequencyVector extends FloatVectorRel<FrequencyUnit, FloatFrequency, FloatFrequencyVector>
{
/** */
private static final long serialVersionUID = 20190905L;
/**
* Construct a FloatFrequencyVector from an internal data object.
* @param data FloatVectorData; the internal data object for the vector
* @param displayUnit FrequencyUnit; the display unit of the vector data
*/
public FloatFrequencyVector(final FloatVectorData data, final FrequencyUnit displayUnit)
{
super(data, displayUnit);
}
/* CONSTRUCTORS WITH float[] */
/**
* Construct a FloatFrequencyVector 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 vector, 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 Vector
*/
public FloatFrequencyVector(final float[] data, final FrequencyUnit displayUnit, final StorageType storageType)
{
this(FloatVectorData.instantiate(data, displayUnit.getScale(), storageType), displayUnit);
}
/**
* Construct a FloatFrequencyVector 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.
* @param data float[]; the data for the vector
* @param displayUnit FrequencyUnit; the unit of the values in the data array, and display unit when printing
*/
public FloatFrequencyVector(final float[] data, final FrequencyUnit displayUnit)
{
this(data, displayUnit, StorageType.DENSE);
}
/**
* Construct a FloatFrequencyVector from a float[] object with SI-unit values.
* @param data float[]; the data for the vector, in SI units
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
*/
public FloatFrequencyVector(final float[] data, final StorageType storageType)
{
this(data, FrequencyUnit.SI, storageType);
}
/**
* Construct a FloatFrequencyVector from a float[] object with SI-unit values. Assume that the StorageType is DENSE since we
* offer the data as an array.
* @param data float[]; the data for the vector, in SI units
*/
public FloatFrequencyVector(final float[] data)
{
this(data, StorageType.DENSE);
}
/* CONSTRUCTORS WITH FloatFrequency[] */
/**
* Construct a FloatFrequencyVector from an array of FloatFrequency objects. The FloatFrequency 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 FloatFrequency[]; the data for the vector
* @param displayUnit FrequencyUnit; the display unit of the values when printing
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
*/
public FloatFrequencyVector(final FloatFrequency[] data, final FrequencyUnit displayUnit, final StorageType storageType)
{
this(FloatVectorData.instantiate(data, storageType), displayUnit);
}
/**
* Construct a FloatFrequencyVector from an array of FloatFrequency objects. The FloatFrequency 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 FloatFrequency[]; the data for the vector
* @param displayUnit FrequencyUnit; the display unit of the values when printing
*/
public FloatFrequencyVector(final FloatFrequency[] data, final FrequencyUnit displayUnit)
{
this(data, displayUnit, StorageType.DENSE);
}
/**
* Construct a FloatFrequencyVector from an array of FloatFrequency objects. The FloatFrequency 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 FloatFrequency[]; the data for the vector
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
*/
public FloatFrequencyVector(final FloatFrequency[] data, final StorageType storageType)
{
this(data, FrequencyUnit.SI, storageType);
}
/**
* Construct a FloatFrequencyVector from an array of FloatFrequency objects. The FloatFrequency 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 FloatFrequency[]; the data for the vector
*/
public FloatFrequencyVector(final FloatFrequency[] data)
{
this(data, StorageType.DENSE);
}
/* CONSTRUCTORS WITH List<Float> or List<Frequency> */
/**
* Construct a FloatFrequencyVector from a list of Number objects or a list of FloatFrequency objects. Note that the
* displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Float objects) or
* FloatFrequency 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 FloatFrequency
* objects, each FloatFrequency 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<Float> or List<Frequency>; the data for the vector
* @param displayUnit FrequencyUnit; the display unit of the vector data, and the unit of the data points when the data is
* expressed as List<Float> or List<Number> in general
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
*/
public FloatFrequencyVector(final List<? extends Number> data, final FrequencyUnit displayUnit,
final StorageType storageType)
{
this(data.size() == 0 ? FloatVectorData.instantiate(new float[] {}, IdentityScale.SCALE, storageType)
: data.get(0) instanceof FloatFrequency ? FloatVectorData.instantiate(data, IdentityScale.SCALE, storageType)
: FloatVectorData.instantiate(data, displayUnit.getScale(), storageType),
displayUnit);
}
/**
* Construct a FloatFrequencyVector from a list of Number objects or a list of FloatFrequency objects. Note that the
* displayUnit has a different meaning depending on whether the list contains Number objects (e.g., Float objects) or
* FloatFrequency 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 FloatFrequency
* objects, each FloatFrequency 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<Float> or List<Frequency>; the data for the vector
* @param displayUnit FrequencyUnit; the display unit of the vector data, and the unit of the data points when the data is
* expressed as List<Float> or List<Number> in general
*/
public FloatFrequencyVector(final List<? extends Number> data, final FrequencyUnit displayUnit)
{
this(data, displayUnit, StorageType.DENSE);
}
/**
* Construct a FloatFrequencyVector from a list of Number objects or a list of FloatFrequency objects. When data contains
* numbers such as Float, assume that they are expressed using SI units. When the data consists of FloatFrequency 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<Float> or List<Frequency>; the data for the vector
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
*/
public FloatFrequencyVector(final List<? extends Number> data, final StorageType storageType)
{
this(data, FrequencyUnit.SI, storageType);
}
/**
* Construct a FloatFrequencyVector from a list of Number objects or a list of FloatFrequency objects. When data contains
* numbers such as Float, assume that they are expressed using SI units. When the data consists of FloatFrequency 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<Float> or List<Frequency>; the data for the vector
*/
public FloatFrequencyVector(final List<? extends Number> data)
{
this(data, StorageType.DENSE);
}
/* CONSTRUCTORS WITH Map<Integer, Float> or Map<Integer, FloatFrequency> */
/**
* Construct a FloatFrequencyVector from a (sparse) map of index values to Number objects or a (sparse) map of index values
* to of FloatFrequency 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., Float objects) or FloatFrequency 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 FloatFrequency objects, each FloatFrequency
* 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, Float> or Map<Integer, FloatFrequency>; the data for the vector
* @param size int; the size off the vector, i.e., the highest index
* @param displayUnit FrequencyUnit; the display unit of the vector data, and the unit of the data points when the data is
* expressed as List<Float> or List<Number> in general
* @param storageType StorageType; the StorageType (SPARSE or DENSE) to use for constructing the Vector
*/
public FloatFrequencyVector(final Map<Integer, ? extends Number> data, final int size, final FrequencyUnit displayUnit,
final StorageType storageType)
{
this(data.size() == 0 ? FloatVectorData.instantiate(data, size, IdentityScale.SCALE, storageType)
: data.values().iterator().next() instanceof FloatFrequency
? FloatVectorData.instantiate(data, size, IdentityScale.SCALE, storageType)
: FloatVectorData.instantiate(data, size, displayUnit.getScale(), storageType),
displayUnit);
}
/**
* Construct a FloatFrequencyVector from a (sparse) map of index values to Number objects or a (sparse) map of index values
* to of FloatFrequency 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., Float objects) or FloatFrequency 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 FloatFrequency objects, each FloatFrequency
* 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, Float> or Map<Integer, FloatFrequency>; the data for the vector
* @param size int; the size off the vector, i.e., the highest index
* @param displayUnit FrequencyUnit; the display unit of the vector data, and the unit of the data points when the data is
* expressed as List<Float> or List<Number> in general
*/
public FloatFrequencyVector(final Map<Integer, ? extends Number> data, final int size, final FrequencyUnit displayUnit)
{
this(data, size, displayUnit, StorageType.SPARSE);
}
/**
* Construct a FloatFrequencyVector from a (sparse) map of index values to Number objects or a (sparse) map of index values
* to of FloatFrequency 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
* Float, assume that they are expressed using SI units. When the data consists of FloatFrequency 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, Float> or Map<Integer, FloatFrequency>; 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 FloatFrequencyVector(final Map<Integer, ? extends Number> data, final int size, final StorageType storageType)
{
this(data, size, FrequencyUnit.SI, storageType);
}
/**
* Construct a FloatFrequencyVector from a (sparse) map of index values to Number objects or a (sparse) map of index values
* to of FloatFrequency 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
* Float, assume that they are expressed using SI units. When the data consists of FloatFrequency 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, Float> or Map<Integer, FloatFrequency>; the data for the vector
* @param size int; the size off the vector, i.e., the highest index
*/
public FloatFrequencyVector(final Map<Integer, ? extends Number> data, final int size)
{
this(data, size, StorageType.SPARSE);
}
/* ****************************** Other methods ****************************** */
/** {@inheritDoc} */
@Override
public Class<FloatFrequency> getScalarClass()
{
return FloatFrequency.class;
}
/** {@inheritDoc} */
@Override
public FloatFrequencyVector instantiateVector(final FloatVectorData fvd, final FrequencyUnit displayUnit)
{
return new FloatFrequencyVector(fvd, displayUnit);
}
/** {@inheritDoc} */
@Override
public FloatFrequency instantiateScalarSI(final float valueSI, final FrequencyUnit displayUnit)
{
FloatFrequency result = FloatFrequency.instantiateSI(valueSI);
result.setDisplayUnit(displayUnit);
return result;
}
}