Package org.djunits.value.vdouble.scalar

Class Length

java.lang.Object
java.lang.Number
org.djunits.value.base.Scalar<U,S>
org.djunits.value.vdouble.scalar.base.DoubleScalar<U,R>
org.djunits.value.vdouble.scalar.base.DoubleScalarRel<RU,R>
org.djunits.value.vdouble.scalar.base.DoubleScalarRelWithAbs<PositionUnit,Position,LengthUnit,Length>
org.djunits.value.vdouble.scalar.Length
All Implemented Interfaces:
Serializable, Cloneable, Comparable<Length>, Relative<LengthUnit,Length>, RelWithAbs<PositionUnit,Position,LengthUnit,Length>, Value<LengthUnit,Length>
@Generated(value="org.djunits.generator.GenerateDJUNIT", date="2025-09-06T15:16:28.380798Z") public class Length extends DoubleScalarRelWithAbs<PositionUnit,Position,LengthUnit,Length>
Easy access methods for the Relative Length DoubleScalar.

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

Author:
Alexander Verbraeck, Peter Knoppers
See Also:

  • Field Details

    • ZERO

      public static final Length ZERO
      Constant with value zero.

    • ONE

      public static final Length ONE
      Constant with value one.

    • NaN

      public static final Length NaN
      Constant with value NaN.

    • POSITIVE_INFINITY

      public static final Length POSITIVE_INFINITY
      Constant with value POSITIVE_INFINITY.

    • NEGATIVE_INFINITY

      public static final Length NEGATIVE_INFINITY
      Constant with value NEGATIVE_INFINITY.

    • POS_MAXVALUE

      public static final Length POS_MAXVALUE
      Constant with value MAX_VALUE.

    • NEG_MAXVALUE

      public static final Length NEG_MAXVALUE
      Constant with value -MAX_VALUE.

  • Constructor Details

    • Length

      public Length(double value, LengthUnit unit)
      Construct Length scalar with a unit.
      Parameters:
      value - the double value, expressed in the given unit
      unit - unit for the double value

    • Length

      public Length(Length value)
      Construct Length scalar.
      Parameters:
      value - Scalar from which to construct this instance

  • Method Details

    • instantiateRel

      public final Length instantiateRel(double value, LengthUnit unit)
      Description copied from class: DoubleScalarRel
      Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.
      Specified by:
      instantiateRel in class DoubleScalarRel<LengthUnit,Length>
      Parameters:
      value - the double value
      unit - the unit
      Returns:
      R a new relative instance of the DoubleScalar of the right type

    • instantiateAbs

      public final Position instantiateAbs(double value, PositionUnit unit)
      Description copied from class: DoubleScalarRelWithAbs
      Construct a new Absolute Immutable DoubleScalar of the right type. Each extending class must implement this method.
      Specified by:
      instantiateAbs in class DoubleScalarRelWithAbs<PositionUnit,Position,LengthUnit,Length>
      Parameters:
      value - the double value
      unit - the absolute unit
      Returns:
      A a new absolute instance of the DoubleScalar of the right type

    • ofSI

      public static final Length ofSI(double value)
      Construct Length scalar based on an SI value.
      Parameters:
      value - the double value in SI units
      Returns:
      the new scalar with the SI value

    • interpolate

      public static Length interpolate(Length zero, Length one, double ratio)
      Interpolate between two values. Note that the first value does not have to be smaller than the second.
      Parameters:
      zero - the value at a ratio of zero
      one - the value at a ratio of one
      ratio - the ratio between 0 and 1, inclusive
      Returns:
      a Length at the given ratio between 0 and 1

    • max

      public static Length max(Length r1, Length r2)
      Return the maximum value of two relative scalars.
      Parameters:
      r1 - the first scalar
      r2 - the second scalar
      Returns:
      the maximum value of two relative scalars

    • max

      public static Length max(Length r1, Length r2, Length... rn)
      Return the maximum value of more than two relative scalars.
      Parameters:
      r1 - the first scalar
      r2 - the second scalar
      rn - the other scalars
      Returns:
      the maximum value of more than two relative scalars

    • min

      public static Length min(Length r1, Length r2)
      Return the minimum value of two relative scalars.
      Parameters:
      r1 - the first scalar
      r2 - the second scalar
      Returns:
      the minimum value of two relative scalars

    • min

      public static Length min(Length r1, Length r2, Length... rn)
      Return the minimum value of more than two relative scalars.
      Parameters:
      r1 - the first scalar
      r2 - the second scalar
      rn - the other scalars
      Returns:
      the minimum value of more than two relative scalars

    • valueOf

      public static Length valueOf(String text)
      Returns a Length representation of a textual representation of a value with a unit. The String representation that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces are allowed, but not required, between the value and the unit.
      Parameters:
      text - the textual representation to parse into a Length
      Returns:
      the Scalar representation of the value in its unit
      Throws:
      IllegalArgumentException - when the text cannot be parsed
      NullPointerException - when the text argument is null

    • of

      public static Length of(double value, String unitString)
      Returns a Length based on a value and the textual representation of the unit, which can be localized.
      Parameters:
      value - the value to use
      unitString - the textual representation of the unit
      Returns:
      the Scalar representation of the value in its unit
      Throws:
      IllegalArgumentException - when the unit cannot be parsed or is incorrect
      NullPointerException - when the unitString argument is null

    • divide

      public final Dimensionless divide(Length v)
      Calculate the division of Length and Length, which results in a Dimensionless scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of Length and Length

    • times

      public final Dimensionless times(LinearDensity v)
      Calculate the multiplication of Length and LinearDensity, which results in a Dimensionless scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Length and LinearDensity

    • times

      public final Area times(Length v)
      Calculate the multiplication of Length and Length, which results in a Area scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Length and Length

    • divide

      public final Area divide(LinearDensity v)
      Calculate the division of Length and LinearDensity, which results in a Area scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of Length and LinearDensity

    • divide

      public final LinearDensity divide(Area v)
      Calculate the division of Length and Area, which results in a LinearDensity scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of Length and Area

    • times

      public final Volume times(Area v)
      Calculate the multiplication of Length and Area, which results in a Volume scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Length and Area

    • times

      public final Energy times(Force v)
      Calculate the multiplication of Length and Force, which results in a Energy scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Length and Force

    • times

      public final Speed times(Frequency v)
      Calculate the multiplication of Length and Frequency, which results in a Speed scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Length and Frequency

    • divide

      public final Speed divide(Duration v)
      Calculate the division of Length and Duration, which results in a Speed scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of Length and Duration

    • divide

      public final Duration divide(Speed v)
      Calculate the division of Length and Speed, which results in a Duration scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of Length and Speed

    • times

      public final Momentum times(FlowMass v)
      Calculate the multiplication of Length and FlowMass, which results in a Momentum scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Length and FlowMass

    • reciprocal

      public LinearDensity reciprocal()
      Description copied from class: DoubleScalarRel
      Create the reciprocal of this scalar with the correct dimensions.
      Overrides:
      reciprocal in class DoubleScalarRel<LengthUnit,Length>
      Returns:
      a new scalar instance with correct SI dimensions

    • multiply

      public static Length multiply(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)
      Multiply two scalars that result in a scalar of type Length.
      Parameters:
      scalar1 - the first scalar
      scalar2 - the second scalar
      Returns:
      the multiplication of both scalars as an instance of Length

    • divide

      public static Length divide(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)
      Divide two scalars that result in a scalar of type Length.
      Parameters:
      scalar1 - the first scalar
      scalar2 - the second scalar
      Returns:
      the division of scalar1 by scalar2 as an instance of Length