Class SIVector

All Implemented Interfaces:
Serializable, Cloneable, Vector<SIUnit,​SIScalar,​SIVector>, Vector.Rel<SIUnit,​SIScalar,​SIVector>, ValueFunctions<SIUnit,​SIVector>, IndexedValue<SIUnit,​SIScalar,​SIVector>, Relative<SIUnit,​SIVector>, Value<SIUnit,​SIVector>, DoubleVectorInterface<SIUnit,​SIScalar,​SIVector>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2019-10-18T12:12:25.568Z")
public class SIVector
extends AbstractDoubleVectorRel<SIUnit,​SIScalar,​SIVector>
Easy access methods for the generic Relative SI DoubleVector.

Copyright (c) 2013-2019 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
See Also:
Serialized Form
  • Constructor Details

    • SIVector

      public SIVector​(DoubleVectorData data, SIUnit unit)
      Parameters:
      data - DoubleVectorData; an internal data object
      unit - SIUnit; the unit
  • Method Details

    • instantiate

      public static SIVector instantiate​(double[] values, SIUnit unit, StorageType storageType) throws ValueRuntimeException
      Construct a new Relative Double SIVector.
      Parameters:
      values - double[]; the values of the entries in the new Relative Double SIVector
      unit - SIUnit; the unit of the new Relative Double SIVector
      storageType - StorageType; the data type to use (e.g., DENSE or SPARSE)
      Returns:
      SIVector; the SIVector of the given unit
      Throws:
      ValueRuntimeException - when values is null
    • instantiate

      public static SIVector instantiate​(List<Double> values, SIUnit unit, StorageType storageType) throws ValueRuntimeException
      Construct a new Relative Double SIVector.
      Parameters:
      values - List<Double>; the values of the entries in the new Relative Double SIVector
      unit - SIUnit; the unit of the new Relative Double SIVector
      storageType - StorageType; the data type to use (e.g., DENSE or SPARSE)
      Returns:
      SIVector; the SIVector of the given unit
      Throws:
      ValueRuntimeException - when values is null
    • instantiate

      public static SIVector instantiate​(SortedMap<Integer,​Double> values, int length, SIUnit unit, StorageType storageType) throws ValueRuntimeException
      Construct a new Relative Double SIVector.
      Parameters:
      values - SortedMap<Integer, Double>; the map of indexes to values of the Relative Sparse Double SIVector
      length - int; the size of the vector
      unit - SIUnit; the unit of the new Relative Sparse Double SIVector
      storageType - StorageType; the data type to use (e.g., DENSE or SPARSE)
      Returns:
      SIVector; the SIVector of the given unit
      Throws:
      ValueRuntimeException - when values is null
    • getScalarClass

      public Class<SIScalar> getScalarClass()
      Return the class of the corresponding scalar.
      Returns:
      Class<S>; the class of the corresponding scalar
    • of

      public static SIVector of​(double[] value, String unitString, StorageType storageType)
      Returns an SIVector based on an array of values and the textual representation of the unit.
      Parameters:
      value - double[]; the values to use
      unitString - String; the textual representation of the unit
      storageType - StorageType; the storage type to use
      Returns:
      SIVector; the vector representation of the values in their unit
      Throws:
      IllegalArgumentException - when the unit cannot be parsed or is incorrect
      NullPointerException - when the unitString argument is null
    • of

      public static SIVector of​(List<Double> valueList, String unitString, StorageType storageType)
      Returns an SIVector based on an array of values and the textual representation of the unit.
      Parameters:
      valueList - List<Double>; the values to use
      unitString - String; the textual representation of the unit
      storageType - StorageType; the storage type to use
      Returns:
      SIVector; the vector representation of the values in their unit
      Throws:
      IllegalArgumentException - when the unit cannot be parsed or is incorrect
      NullPointerException - when the unitString argument is null
    • of

      public static SIVector of​(SortedMap<Integer,​Double> valueMap, String unitString, int length, StorageType storageType)
      Returns an SIVector based on a (sparse) map of values and the textual representation of the unit.
      Parameters:
      valueMap - SortedMap<Integer, Double>; the values to use
      unitString - String; the textual representation of the unit
      length - int; the size of the vector
      storageType - StorageType; the storage type to use
      Returns:
      SIVector; the vector representation of the values in their unit
      Throws:
      IllegalArgumentException - when the unit cannot be parsed or is incorrect
      NullPointerException - when the unitString argument is null
    • instantiateVector

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

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

      public final <U extends Unit<U>,​ S extends AbstractDoubleScalarRel<U,​ S>,​ V extends AbstractDoubleVectorRel<U,​ S,​ V>> V as​(U displayUnit)
      Return the current vector transformed to a vector in the given unit. Of course the SI dimensionality has to match, otherwise the vector cannot be transformed. The compiler will check the alignment between the return value and the unit.
      Type Parameters:
      U - the unit type
      S - the corresponding scalar type
      V - the corresponding vector type
      Parameters:
      displayUnit - KU; the unit in which the vector needs to be expressed
      Returns:
      K; the vector that has been transformed into the right vector type and unit
    • asAbsorbedDose

      public final AbsorbedDoseVector asAbsorbedDose()
      Return the current vector as a absorbeddose vector.
      Returns:
      AbsorbedDoseVector; the current vector as a absorbeddose vector
    • asAbsorbedDose

      public final AbsorbedDoseVector asAbsorbedDose​(AbsorbedDoseUnit displayUnit)
      Return the current vector as a absorbeddose vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      AbsorbedDoseVector; the current vector as a absorbeddose vector
    • asAcceleration

      public final AccelerationVector asAcceleration()
      Return the current vector as a acceleration vector.
      Returns:
      AccelerationVector; the current vector as a acceleration vector
    • asAcceleration

      public final AccelerationVector asAcceleration​(AccelerationUnit displayUnit)
      Return the current vector as a acceleration vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      AccelerationVector; the current vector as a acceleration vector
    • asAmountOfSubstance

      public final AmountOfSubstanceVector asAmountOfSubstance()
      Return the current vector as a amountofsubstance vector.
      Returns:
      AmountOfSubstanceVector; the current vector as a amountofsubstance vector
    • asAmountOfSubstance

      public final AmountOfSubstanceVector asAmountOfSubstance​(AmountOfSubstanceUnit displayUnit)
      Return the current vector as a amountofsubstance vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      AmountOfSubstanceVector; the current vector as a amountofsubstance vector
    • asArea

      public final AreaVector asArea()
      Return the current vector as a area vector.
      Returns:
      AreaVector; the current vector as a area vector
    • asArea

      public final AreaVector asArea​(AreaUnit displayUnit)
      Return the current vector as a area vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      AreaVector; the current vector as a area vector
    • asCatalyticActivity

      public final CatalyticActivityVector asCatalyticActivity()
      Return the current vector as a catalyticactivity vector.
      Returns:
      CatalyticActivityVector; the current vector as a catalyticactivity vector
    • asCatalyticActivity

      public final CatalyticActivityVector asCatalyticActivity​(CatalyticActivityUnit displayUnit)
      Return the current vector as a catalyticactivity vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      CatalyticActivityVector; the current vector as a catalyticactivity vector
    • asDensity

      public final DensityVector asDensity()
      Return the current vector as a density vector.
      Returns:
      DensityVector; the current vector as a density vector
    • asDensity

      public final DensityVector asDensity​(DensityUnit displayUnit)
      Return the current vector as a density vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      DensityVector; the current vector as a density vector
    • asDimensionless

      public final DimensionlessVector asDimensionless()
      Return the current vector as a dimensionless vector.
      Returns:
      DimensionlessVector; the current vector as a dimensionless vector
    • asDimensionless

      public final DimensionlessVector asDimensionless​(DimensionlessUnit displayUnit)
      Return the current vector as a dimensionless vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      DimensionlessVector; the current vector as a dimensionless vector
    • asElectricalCapacitance

      public final ElectricalCapacitanceVector asElectricalCapacitance()
      Return the current vector as a electricalcapacitance vector.
      Returns:
      ElectricalCapacitanceVector; the current vector as a electricalcapacitance vector
    • asElectricalCapacitance

      public final ElectricalCapacitanceVector asElectricalCapacitance​(ElectricalCapacitanceUnit displayUnit)
      Return the current vector as a electricalcapacitance vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      ElectricalCapacitanceVector; the current vector as a electricalcapacitance vector
    • asElectricalCharge

      public final ElectricalChargeVector asElectricalCharge()
      Return the current vector as a electricalcharge vector.
      Returns:
      ElectricalChargeVector; the current vector as a electricalcharge vector
    • asElectricalCharge

      public final ElectricalChargeVector asElectricalCharge​(ElectricalChargeUnit displayUnit)
      Return the current vector as a electricalcharge vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      ElectricalChargeVector; the current vector as a electricalcharge vector
    • asElectricalConductance

      public final ElectricalConductanceVector asElectricalConductance()
      Return the current vector as a electricalconductance vector.
      Returns:
      ElectricalConductanceVector; the current vector as a electricalconductance vector
    • asElectricalConductance

      public final ElectricalConductanceVector asElectricalConductance​(ElectricalConductanceUnit displayUnit)
      Return the current vector as a electricalconductance vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      ElectricalConductanceVector; the current vector as a electricalconductance vector
    • asElectricalCurrent

      public final ElectricalCurrentVector asElectricalCurrent()
      Return the current vector as a electricalcurrent vector.
      Returns:
      ElectricalCurrentVector; the current vector as a electricalcurrent vector
    • asElectricalCurrent

      public final ElectricalCurrentVector asElectricalCurrent​(ElectricalCurrentUnit displayUnit)
      Return the current vector as a electricalcurrent vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      ElectricalCurrentVector; the current vector as a electricalcurrent vector
    • asElectricalInductance

      public final ElectricalInductanceVector asElectricalInductance()
      Return the current vector as a electricalinductance vector.
      Returns:
      ElectricalInductanceVector; the current vector as a electricalinductance vector
    • asElectricalInductance

      public final ElectricalInductanceVector asElectricalInductance​(ElectricalInductanceUnit displayUnit)
      Return the current vector as a electricalinductance vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      ElectricalInductanceVector; the current vector as a electricalinductance vector
    • asElectricalPotential

      public final ElectricalPotentialVector asElectricalPotential()
      Return the current vector as a electricalpotential vector.
      Returns:
      ElectricalPotentialVector; the current vector as a electricalpotential vector
    • asElectricalPotential

      public final ElectricalPotentialVector asElectricalPotential​(ElectricalPotentialUnit displayUnit)
      Return the current vector as a electricalpotential vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      ElectricalPotentialVector; the current vector as a electricalpotential vector
    • asElectricalResistance

      public final ElectricalResistanceVector asElectricalResistance()
      Return the current vector as a electricalresistance vector.
      Returns:
      ElectricalResistanceVector; the current vector as a electricalresistance vector
    • asElectricalResistance

      public final ElectricalResistanceVector asElectricalResistance​(ElectricalResistanceUnit displayUnit)
      Return the current vector as a electricalresistance vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      ElectricalResistanceVector; the current vector as a electricalresistance vector
    • asEnergy

      public final EnergyVector asEnergy()
      Return the current vector as a energy vector.
      Returns:
      EnergyVector; the current vector as a energy vector
    • asEnergy

      public final EnergyVector asEnergy​(EnergyUnit displayUnit)
      Return the current vector as a energy vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      EnergyVector; the current vector as a energy vector
    • asEquivalentDose

      public final EquivalentDoseVector asEquivalentDose()
      Return the current vector as a equivalentdose vector.
      Returns:
      EquivalentDoseVector; the current vector as a equivalentdose vector
    • asEquivalentDose

      public final EquivalentDoseVector asEquivalentDose​(EquivalentDoseUnit displayUnit)
      Return the current vector as a equivalentdose vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      EquivalentDoseVector; the current vector as a equivalentdose vector
    • asFlowMass

      public final FlowMassVector asFlowMass()
      Return the current vector as a flowmass vector.
      Returns:
      FlowMassVector; the current vector as a flowmass vector
    • asFlowMass

      public final FlowMassVector asFlowMass​(FlowMassUnit displayUnit)
      Return the current vector as a flowmass vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      FlowMassVector; the current vector as a flowmass vector
    • asFlowVolume

      public final FlowVolumeVector asFlowVolume()
      Return the current vector as a flowvolume vector.
      Returns:
      FlowVolumeVector; the current vector as a flowvolume vector
    • asFlowVolume

      public final FlowVolumeVector asFlowVolume​(FlowVolumeUnit displayUnit)
      Return the current vector as a flowvolume vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      FlowVolumeVector; the current vector as a flowvolume vector
    • asForce

      public final ForceVector asForce()
      Return the current vector as a force vector.
      Returns:
      ForceVector; the current vector as a force vector
    • asForce

      public final ForceVector asForce​(ForceUnit displayUnit)
      Return the current vector as a force vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      ForceVector; the current vector as a force vector
    • asFrequency

      public final FrequencyVector asFrequency()
      Return the current vector as a frequency vector.
      Returns:
      FrequencyVector; the current vector as a frequency vector
    • asFrequency

      public final FrequencyVector asFrequency​(FrequencyUnit displayUnit)
      Return the current vector as a frequency vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      FrequencyVector; the current vector as a frequency vector
    • asIlluminance

      public final IlluminanceVector asIlluminance()
      Return the current vector as a illuminance vector.
      Returns:
      IlluminanceVector; the current vector as a illuminance vector
    • asIlluminance

      public final IlluminanceVector asIlluminance​(IlluminanceUnit displayUnit)
      Return the current vector as a illuminance vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      IlluminanceVector; the current vector as a illuminance vector
    • asLinearDensity

      public final LinearDensityVector asLinearDensity()
      Return the current vector as a lineardensity vector.
      Returns:
      LinearDensityVector; the current vector as a lineardensity vector
    • asLinearDensity

      public final LinearDensityVector asLinearDensity​(LinearDensityUnit displayUnit)
      Return the current vector as a lineardensity vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      LinearDensityVector; the current vector as a lineardensity vector
    • asLuminousFlux

      public final LuminousFluxVector asLuminousFlux()
      Return the current vector as a luminousflux vector.
      Returns:
      LuminousFluxVector; the current vector as a luminousflux vector
    • asLuminousFlux

      public final LuminousFluxVector asLuminousFlux​(LuminousFluxUnit displayUnit)
      Return the current vector as a luminousflux vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      LuminousFluxVector; the current vector as a luminousflux vector
    • asLuminousIntensity

      public final LuminousIntensityVector asLuminousIntensity()
      Return the current vector as a luminousintensity vector.
      Returns:
      LuminousIntensityVector; the current vector as a luminousintensity vector
    • asLuminousIntensity

      public final LuminousIntensityVector asLuminousIntensity​(LuminousIntensityUnit displayUnit)
      Return the current vector as a luminousintensity vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      LuminousIntensityVector; the current vector as a luminousintensity vector
    • asMagneticFluxDensity

      public final MagneticFluxDensityVector asMagneticFluxDensity()
      Return the current vector as a magneticfluxdensity vector.
      Returns:
      MagneticFluxDensityVector; the current vector as a magneticfluxdensity vector
    • asMagneticFluxDensity

      public final MagneticFluxDensityVector asMagneticFluxDensity​(MagneticFluxDensityUnit displayUnit)
      Return the current vector as a magneticfluxdensity vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      MagneticFluxDensityVector; the current vector as a magneticfluxdensity vector
    • asMagneticFlux

      public final MagneticFluxVector asMagneticFlux()
      Return the current vector as a magneticflux vector.
      Returns:
      MagneticFluxVector; the current vector as a magneticflux vector
    • asMagneticFlux

      public final MagneticFluxVector asMagneticFlux​(MagneticFluxUnit displayUnit)
      Return the current vector as a magneticflux vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      MagneticFluxVector; the current vector as a magneticflux vector
    • asMass

      public final MassVector asMass()
      Return the current vector as a mass vector.
      Returns:
      MassVector; the current vector as a mass vector
    • asMass

      public final MassVector asMass​(MassUnit displayUnit)
      Return the current vector as a mass vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      MassVector; the current vector as a mass vector
    • asPower

      public final PowerVector asPower()
      Return the current vector as a power vector.
      Returns:
      PowerVector; the current vector as a power vector
    • asPower

      public final PowerVector asPower​(PowerUnit displayUnit)
      Return the current vector as a power vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      PowerVector; the current vector as a power vector
    • asPressure

      public final PressureVector asPressure()
      Return the current vector as a pressure vector.
      Returns:
      PressureVector; the current vector as a pressure vector
    • asPressure

      public final PressureVector asPressure​(PressureUnit displayUnit)
      Return the current vector as a pressure vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      PressureVector; the current vector as a pressure vector
    • asRadioActivity

      public final RadioActivityVector asRadioActivity()
      Return the current vector as a radioactivity vector.
      Returns:
      RadioActivityVector; the current vector as a radioactivity vector
    • asRadioActivity

      public final RadioActivityVector asRadioActivity​(RadioActivityUnit displayUnit)
      Return the current vector as a radioactivity vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      RadioActivityVector; the current vector as a radioactivity vector
    • asSolidAngle

      public final SolidAngleVector asSolidAngle()
      Return the current vector as a solidangle vector.
      Returns:
      SolidAngleVector; the current vector as a solidangle vector
    • asSolidAngle

      public final SolidAngleVector asSolidAngle​(SolidAngleUnit displayUnit)
      Return the current vector as a solidangle vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      SolidAngleVector; the current vector as a solidangle vector
    • asSpeed

      public final SpeedVector asSpeed()
      Return the current vector as a speed vector.
      Returns:
      SpeedVector; the current vector as a speed vector
    • asSpeed

      public final SpeedVector asSpeed​(SpeedUnit displayUnit)
      Return the current vector as a speed vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      SpeedVector; the current vector as a speed vector
    • asTorque

      public final TorqueVector asTorque()
      Return the current vector as a torque vector.
      Returns:
      TorqueVector; the current vector as a torque vector
    • asTorque

      public final TorqueVector asTorque​(TorqueUnit displayUnit)
      Return the current vector as a torque vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      TorqueVector; the current vector as a torque vector
    • asVolume

      public final VolumeVector asVolume()
      Return the current vector as a volume vector.
      Returns:
      VolumeVector; the current vector as a volume vector
    • asVolume

      public final VolumeVector asVolume​(VolumeUnit displayUnit)
      Return the current vector as a volume vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      VolumeVector; the current vector as a volume vector
    • asAngle

      public final AngleVector asAngle()
      Return the current vector as a angle vector.
      Returns:
      AngleVector; the current vector as a angle vector
    • asAngle

      public final AngleVector asAngle​(AngleUnit displayUnit)
      Return the current vector as a angle vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      AngleVector; the current vector as a angle vector
    • asLength

      public final LengthVector asLength()
      Return the current vector as a length vector.
      Returns:
      LengthVector; the current vector as a length vector
    • asLength

      public final LengthVector asLength​(LengthUnit displayUnit)
      Return the current vector as a length vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      LengthVector; the current vector as a length vector
    • asTemperature

      public final TemperatureVector asTemperature()
      Return the current vector as a temperature vector.
      Returns:
      TemperatureVector; the current vector as a temperature vector
    • asTemperature

      public final TemperatureVector asTemperature​(TemperatureUnit displayUnit)
      Return the current vector as a temperature vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      TemperatureVector; the current vector as a temperature vector
    • asDuration

      public final DurationVector asDuration()
      Return the current vector as a duration vector.
      Returns:
      DurationVector; the current vector as a duration vector
    • asDuration

      public final DurationVector asDuration​(DurationUnit displayUnit)
      Return the current vector as a duration vector, and provide a display unit.
      Parameters:
      displayUnit - the unit in which the value will be displayed
      Returns:
      DurationVector; the current vector as a duration vector