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

Class FloatVectorAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends FloatScalarAbs<AU,A,RU,R>,AV extends FloatVectorAbs<AU,A,AV,RU,R,RV>,RU extends Unit<RU>,R extends FloatScalarRelWithAbs<AU,A,RU,R>,RV extends FloatVectorRelWithAbs<AU,A,AV,RU,R,RV>>

java.lang.Object
org.djunits.value.IndexedValue<U,S,V,D>
org.djunits.value.base.Vector<U,S,V,FloatVectorData>
org.djunits.value.vfloat.vector.base.FloatVector<AU,A,AV>
org.djunits.value.vfloat.vector.base.FloatVectorAbs<AU,A,AV,RU,R,RV>
Type Parameters:
AU - the absolute unit belonging to the relative unit
A - the absolute scalar type belonging to the absolute vector type
AV - the (immutable or mutable) absolute vector type
RU - the relative unit belonging to the absolute unit
R - the relative scalar type belonging to the relative vector type
RV - the relative (immutable or mutable) vector type with this unit
All Implemented Interfaces:
Serializable, Cloneable, Iterable<A>, Absolute<AU,AV,RU,RV>, Value<AU,AV>
Direct Known Subclasses:
FloatAbsoluteTemperatureVector, FloatDirectionVector, FloatPositionVector, FloatTimeVector
public abstract class FloatVectorAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends FloatScalarAbs<AU,A,RU,R>,AV extends FloatVectorAbs<AU,A,AV,RU,R,RV>,RU extends Unit<RU>,R extends FloatScalarRelWithAbs<AU,A,RU,R>,RV extends FloatVectorRelWithAbs<AU,A,AV,RU,R,RV>> extends FloatVector<AU,A,AV> implements Absolute<AU,AV,RU,RV>
AbstractMutableFloatVectorRelWithAbs.java.

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

Author:
Alexander Verbraeck
See Also:

  • Constructor Details

    • FloatVectorAbs

      protected FloatVectorAbs(FloatVectorData data, AU unit)
      Construct a new Relative Mutable FloatVector.
      Parameters:
      data - FloatVectorData; an internal data object
      unit - AU; the unit

  • Method Details

    • plus

      public AV plus(RV increment) throws ValueRuntimeException
      Add a Relative value to this Absolute value. A new value is returned due to immutability.
      Specified by:
      plus in interface Absolute<AU extends AbsoluteLinearUnit<AU,RU>,A extends FloatScalarAbs<AU,A,RU,R>,AV extends FloatVectorAbs<AU,A,AV,RU,R,RV>,RU extends Unit<RU>>
      Parameters:
      increment - R; R the right operand
      Returns:
      A; the sum of this value and the operand
      Throws:
      ValueRuntimeException

    • minus

      public AV minus(RV decrement) throws ValueRuntimeException
      Subtract a Relative value from this Absolute value. A new value is returned due to immutability.
      Specified by:
      minus in interface Absolute<AU extends AbsoluteLinearUnit<AU,RU>,A extends FloatScalarAbs<AU,A,RU,R>,AV extends FloatVectorAbs<AU,A,AV,RU,R,RV>,RU extends Unit<RU>>
      Parameters:
      decrement - R; R the right operand
      Returns:
      A; the subtraction of this value and the operand
      Throws:
      ValueRuntimeException

    • minus

      public RV minus(AV decrement) throws ValueRuntimeException
      Subtract an Absolute value from this Absolute value, resulting in a Relative value. A new value is returned due to immutability.
      Specified by:
      minus in interface Absolute<AU extends AbsoluteLinearUnit<AU,RU>,A extends FloatScalarAbs<AU,A,RU,R>,AV extends FloatVectorAbs<AU,A,AV,RU,R,RV>,RU extends Unit<RU>>
      Parameters:
      decrement - A; A the right operand
      Returns:
      R; the subtraction of this value and the operand
      Throws:
      ValueRuntimeException

    • decrementBy

      public AV decrementBy(R decrement)
      Decrement all values of this vector by the decrement. This only works if the vector is mutable.
      Parameters:
      decrement - R; the scalar by which to decrement all values
      Returns:
      AV; this modified vector
      Throws:
      ValueRuntimeException - in case this vector is immutable

    • decrementBy

      public AV decrementBy(RV decrement)
      Decrement all values of this vector by the decrement on a value by value basis. This only works if this vector is mutable.
      Parameters:
      decrement - RV; the vector that contains the values by which to decrement the corresponding values
      Returns:
      AV; this modified vector
      Throws:
      ValueRuntimeException - in case this vector is immutable or when the sizes of the vectors differ

    • instantiateVectorRel

      public abstract RV instantiateVectorRel(FloatVectorData dvd, RU displayUnit)
      Instantiate a new relative vector of the class of this absolute vector. This can be used instead of the FloatVector.instiantiate() methods in case another vector of this absolute vector class is known. The method is faster than FloatVector.instantiate, and it will also work if the vector is user-defined.
      Parameters:
      dvd - FloatVectorData; the data used to instantiate the vector
      displayUnit - RU; the display unit of the relative vector
      Returns:
      RV; a relative vector of the correct type, belonging to this absolute vector type

    • instantiateScalarRelSI

      public abstract R instantiateScalarRelSI(float valueSI, RU displayUnit)
      Instantiate a new relative scalar for the class of this absolute 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 relative scalar
      displayUnit - RU; the unit in which the relative value will be displayed
      Returns:
      R; a relative scalar of the correct type, belonging to this absolute vector type