Package org.djunits.value.vfloat.vector.base

Interface FloatVectorInterface<U extends Unit<U>,​S extends FloatScalarInterface<U,​S>,​V extends FloatVectorInterface<U,​S,​V>>

Type Parameters:
U - the unit
S - the generic scalar type belonging to U
V - the generic vector type
All Superinterfaces:
Cloneable, IndexedValue<U,​S,​V>, Iterable<S>, Serializable, Value<U,​V>, ValueFunctions<U,​V>, Vector<U,​S,​V>
All Known Implementing Classes:
AbstractFloatVector, AbstractFloatVectorAbs, AbstractFloatVectorRel, AbstractFloatVectorRelWithAbs, FloatAbsoluteTemperatureVector, FloatAbsorbedDoseVector, FloatAccelerationVector, FloatAmountOfSubstanceVector, FloatAngleVector, FloatAngularAccelerationVector, FloatAngularVelocityVector, FloatAreaVector, FloatCatalyticActivityVector, FloatDensityVector, FloatDimensionlessVector, FloatDirectionVector, FloatDurationVector, FloatElectricalCapacitanceVector, FloatElectricalChargeVector, FloatElectricalConductanceVector, FloatElectricalCurrentVector, FloatElectricalInductanceVector, FloatElectricalPotentialVector, FloatElectricalResistanceVector, FloatEnergyVector, FloatEquivalentDoseVector, FloatFlowMassVector, FloatFlowVolumeVector, FloatForceVector, FloatFrequencyVector, FloatIlluminanceVector, FloatLengthVector, FloatLinearDensityVector, FloatLuminousFluxVector, FloatLuminousIntensityVector, FloatMagneticFluxDensityVector, FloatMagneticFluxVector, FloatMassVector, FloatMomentumVector, FloatPositionVector, FloatPowerVector, FloatPressureVector, FloatRadioActivityVector, FloatSIVector, FloatSolidAngleVector, FloatSpeedVector, FloatTemperatureVector, FloatTimeVector, FloatTorqueVector, FloatVolumeVector
public interface FloatVectorInterface<U extends Unit<U>,​S extends FloatScalarInterface<U,​S>,​V extends FloatVectorInterface<U,​S,​V>>
extends Vector<U,​S,​V>
Interface for the FloatVector classes, specifically defining the methods that deal with float values.

Copyright (c) 2013-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Author:
Alexander Verbraeck, Peter Knoppers

  • Method Details

    • getSI

      float getSI​(int index) throws ValueRuntimeException
      Retrieve the value stored at a specified position in the standard SI unit.
      Parameters:
      index - int; index of the value to retrieve
      Returns:
      float; value at position index in the standard SI unit
      Throws:
      ValueRuntimeException - when index out of range (index < 0 or index >= size())

    • getInUnit

      float getInUnit​(int index) throws ValueRuntimeException
      Retrieve the value stored at a specified position in the original unit.
      Parameters:
      index - int; index of the value to retrieve
      Returns:
      float; value at position index in the original unit
      Throws:
      ValueRuntimeException - when index out of range (index < 0 or index >= size())

    • getInUnit

      float getInUnit​(int index, U targetUnit) throws ValueRuntimeException
      Retrieve the value stored at a specified position converted into a specified unit.
      Parameters:
      index - int; index of the value to retrieve
      targetUnit - U; the unit for the result
      Returns:
      float; value at position index converted into the specified unit
      Throws:
      ValueRuntimeException - when index out of range (index < 0 or index >= size())

    • getValuesSI

      float[] getValuesSI()
      Create a float[] array filled with the values in the standard SI unit.
      Returns:
      float[]; array of values in the standard SI unit

    • getValuesInUnit

      float[] getValuesInUnit()
      Create a float[] array filled with the values in the original unit.
      Returns:
      float[]; the values in the original unit

    • getValuesInUnit

      float[] getValuesInUnit​(U targetUnit)
      Create a float[] array filled with the values converted into a specified unit.
      Parameters:
      targetUnit - U; the unit into which the values are converted for use
      Returns:
      float[]; the values converted into the specified unit

    • setSI

      void setSI​(int index, float valueSI) throws ValueRuntimeException
      Set the value, specified in the standard SI unit, at the specified position.
      Parameters:
      index - int; the index of the value to set
      valueSI - float; the value, specified in the standard SI unit
      Throws:
      ValueRuntimeException - when index out of range (index < 0 or index >= size())

    • setInUnit

      void setInUnit​(int index, float valueInUnit) throws ValueRuntimeException
      Set the value, specified in the (current) display unit, at the specified position.
      Parameters:
      index - int; the index of the value to set
      valueInUnit - float; the value, specified in the (current) display unit
      Throws:
      ValueRuntimeException - when index out of range (index < 0 or index >= size())

    • setInUnit

      void setInUnit​(int index, float valueInUnit, U valueUnit) throws ValueRuntimeException
      Set the value, specified in the valueUnit, at the specified position.
      Parameters:
      index - int; the index of the value to set
      valueInUnit - float; the value, specified in the (current) display unit
      valueUnit - U; the unit in which the valueInUnit is expressed
      Throws:
      ValueRuntimeException - when index out of range (index < 0 or index >= size())

    • set

      void set​(int index, S value) throws ValueRuntimeException
      Set the scalar value at the specified position.
      Parameters:
      index - int; the index of the value to set
      value - S; the value to set
      Throws:
      ValueRuntimeException - when index out of range (index < 0 or index >= size())

    • assign

      V assign​(FloatFunction floatFunction)
      Execute a function on a cell by cell basis. Note: May be expensive when used on sparse data.
      Parameters:
      floatFunction - FloatFunction; the function to apply
      Returns:
      V; this updated vector

    • instantiateVector

      V instantiateVector​(FloatVectorData fvd, U displayUnit)
      Instantiate a new vector of the class of this vector. This can be used instead of the FloatVector.instiantiate() methods in case another vector of this class is known. The method is faster than FloatVector.instantiate, and it will also work if the vector is user-defined.
      Parameters:
      fvd - FloatVectorData; the data used to instantiate the vector
      displayUnit - U; the display unit of the vector
      Returns:
      V; a vector of the correct type

    • instantiateScalarSI

      S instantiateScalarSI​(float valueSI, U displayUnit)
      Instantiate a new scalar for the class of this vector. This can be used instead of the FloatScalar.instiantiate() methods in case a vector of this class is known. The method is faster than FloatScalar.instantiate, and it will also work if the vector and/or scalar are user-defined.
      Parameters:
      valueSI - float; the SI value of the scalar
      displayUnit - U; the unit in which the value will be displayed
      Returns:
      S; a scalar of the correct type, belonging to the vector type