Class FloatDimensionless

All Implemented Interfaces:
Serializable, Cloneable, Comparable<FloatDimensionless>, Scalar<DimensionlessUnit,​FloatDimensionless>, Scalar.Rel<DimensionlessUnit,​FloatDimensionless>, DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>, ValueFunctions<DimensionlessUnit,​FloatDimensionless>, Relative<DimensionlessUnit,​FloatDimensionless>, Value<DimensionlessUnit,​FloatDimensionless>, FloatScalarInterface<DimensionlessUnit,​FloatDimensionless>, FloatScalarInterface.Rel<DimensionlessUnit,​FloatDimensionless>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2019-10-18T12:12:25.568Z")
public class FloatDimensionless
extends AbstractFloatScalarRel<DimensionlessUnit,​FloatDimensionless>
implements DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
Easy access methods for the FloatDimensionless FloatScalar, which is relative by definition.

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

  • Constructor Details

    • FloatDimensionless

      public FloatDimensionless​(float value, DimensionlessUnit unit)
      Construct FloatDimensionless scalar.
      Parameters:
      value - float; the float value
      unit - unit for the float value
    • FloatDimensionless

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

      public FloatDimensionless​(double value, DimensionlessUnit unit)
      Construct FloatDimensionless scalar using a double value.
      Parameters:
      value - double; the double value
      unit - unit for the resulting float value
  • Method Details

    • instantiateRel

      public final FloatDimensionless instantiateRel​(float value, DimensionlessUnit unit)
      Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.
      Specified by:
      instantiateRel in interface FloatScalarInterface.Rel<DimensionlessUnit,​FloatDimensionless>
      Parameters:
      value - float; the float value
      unit - U; the unit
      Returns:
      R a new relative instance of the FloatScalar of the right type
    • instantiateSI

      public static final FloatDimensionless instantiateSI​(float value)
      Construct FloatDimensionless scalar.
      Parameters:
      value - float; the float value in SI units
      Returns:
      the new scalar with the SI value
    • interpolate

      public static FloatDimensionless interpolate​(FloatDimensionless zero, FloatDimensionless one, float ratio)
      Interpolate between two values.
      Parameters:
      zero - the low value
      one - the high value
      ratio - double; the ratio between 0 and 1, inclusive
      Returns:
      a Scalar at the ratio between
    • max

      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

      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

      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

      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 FloatDimensionless valueOf​(String text)
      Returns a FloatDimensionless 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 the official abbreviation of the unit. Spaces are allowed, but not required, between the value and the unit.
      Parameters:
      text - String; the textual representation to parse into a FloatDimensionless
      Returns:
      FloatDimensionless; 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 FloatDimensionless of​(float value, String unitString)
      Returns a FloatDimensionless based on a value and the textual representation of the unit.
      Parameters:
      value - double; the value to use
      unitString - String; the textual representation of the unit
      Returns:
      FloatDimensionless; 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
    • acos

      public final FloatDimensionless acos()
      Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.
      Specified by:
      acos in interface DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
      Returns:
      T; the modified T
    • asin

      public final FloatDimensionless asin()
      Set the value(s) to the arc sine of the value(s); the resulting angle is in the range -pi/2 through pi/2.
      Specified by:
      asin in interface DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
      Returns:
      T; the modified T
    • atan

      public final FloatDimensionless atan()
      Set the value(s) to the arc tangent of the value(s); the resulting angle is in the range -pi/2 through pi/2.
      Specified by:
      atan in interface DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
      Returns:
      T; the modified T
    • cbrt

      public final FloatDimensionless cbrt()
      Set the value(s) to the(ir) cube root.
      Specified by:
      cbrt in interface DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
      Returns:
      T; the modified T
    • cos

      public final FloatDimensionless cos()
      Set the value(s) to the trigonometric cosine of the value(s).
      Specified by:
      cos in interface DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
      Returns:
      T; the modified T
    • cosh

      public final FloatDimensionless cosh()
      Set the value(s) to the hyperbolic cosine of the value(s).
      Specified by:
      cosh in interface DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
      Returns:
      T; the modified T
    • exp

      public final FloatDimensionless exp()
      Set the value(s) to Euler's number e raised to the power of the value(s).
      Specified by:
      exp in interface DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
      Returns:
      T; the modified T
    • expm1

      public final FloatDimensionless expm1()
      Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
      Specified by:
      expm1 in interface DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
      Returns:
      T; the modified T
    • log

      public final FloatDimensionless log()
      Set the value(s) to the natural logarithm (base e) of the value(s).
      Specified by:
      log in interface DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
      Returns:
      T; the modified T
    • log10

      public final FloatDimensionless log10()
      Set the value(s) to the base 10 logarithm of the value(s).
      Specified by:
      log10 in interface DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
      Returns:
      T; the modified T
    • log1p

      public final FloatDimensionless log1p()
      Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
      Specified by:
      log1p in interface DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
      Returns:
      T; the modified T
    • pow

      public final FloatDimensionless pow​(double x)
      Set the value(s) to the value(s) raised to the power of the argument.
      Specified by:
      pow in interface DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
      Parameters:
      x - double; the value to use as the power
      Returns:
      T; the modified T
    • signum

      public final FloatDimensionless signum()
      Set the value(s) to the signum function of the value(s); zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.
      Specified by:
      signum in interface DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
      Returns:
      T; the modified T
    • sin

      public final FloatDimensionless sin()
      Set the value(s) to the trigonometric sine of the value(s).
      Specified by:
      sin in interface DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
      Returns:
      T; the modified T
    • sinh

      public final FloatDimensionless sinh()
      Set the value(s) to the hyperbolic sine of the value(s).
      Specified by:
      sinh in interface DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
      Returns:
      T; the modified T
    • sqrt

      public final FloatDimensionless sqrt()
      Set the value(s) to the correctly rounded positive square root of the value(s).
      Specified by:
      sqrt in interface DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
      Returns:
      T; the modified T
    • tan

      public final FloatDimensionless tan()
      Set the value(s) to the trigonometric tangent of the value(s).
      Specified by:
      tan in interface DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
      Returns:
      T; the modified T
    • tanh

      public final FloatDimensionless tanh()
      Set the value(s) to the hyperbolic tangent of the value(s).
      Specified by:
      tanh in interface DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
      Returns:
      T; the modified T
    • inv

      public final FloatDimensionless inv()
      Set the value(s) to the complement (1.0/x) of the value(s).
      Specified by:
      inv in interface DimensionlessFunctions<DimensionlessUnit,​FloatDimensionless>
      Returns:
      T; the modified T
    • divide

      public final FloatDimensionless divide​(FloatDimensionless v)
      Calculate the division of FloatDimensionless and FloatDimensionless, which results in a FloatDimensionless scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatDimensionless scalar as a division of FloatDimensionless and FloatDimensionless
    • times

      public final FloatAbsorbedDose times​(FloatAbsorbedDose v)
      Calculate the multiplication of FloatDimensionless and FloatAbsorbedDose, which results in a FloatAbsorbedDose scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatAbsorbedDose scalar as a multiplication of FloatDimensionless and FloatAbsorbedDose
    • times

      public final FloatAcceleration times​(FloatAcceleration v)
      Calculate the multiplication of FloatDimensionless and FloatAcceleration, which results in a FloatAcceleration scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatAcceleration scalar as a multiplication of FloatDimensionless and FloatAcceleration
    • times

      Calculate the multiplication of FloatDimensionless and FloatAmountOfSubstance, which results in a FloatAmountOfSubstance scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatAmountOfSubstance scalar as a multiplication of FloatDimensionless and FloatAmountOfSubstance
    • times

      public final FloatAngle times​(FloatAngle v)
      Calculate the multiplication of FloatDimensionless and FloatAngle, which results in a FloatAngle scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatAngle scalar as a multiplication of FloatDimensionless and FloatAngle
    • times

      public final FloatSolidAngle times​(FloatSolidAngle v)
      Calculate the multiplication of FloatDimensionless and FloatSolidAngle, which results in a FloatSolidAngle scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatSolidAngle scalar as a multiplication of FloatDimensionless and FloatSolidAngle
    • times

      public final FloatArea times​(FloatArea v)
      Calculate the multiplication of FloatDimensionless and FloatArea, which results in a FloatArea scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatArea scalar as a multiplication of FloatDimensionless and FloatArea
    • times

      Calculate the multiplication of FloatDimensionless and FloatCatalyticActivity, which results in a FloatCatalyticActivity scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatCatalyticActivity scalar as a multiplication of FloatDimensionless and FloatCatalyticActivity
    • times

      public final FloatDensity times​(FloatDensity v)
      Calculate the multiplication of FloatDimensionless and FloatDensity, which results in a FloatDensity scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatDensity scalar as a multiplication of FloatDimensionless and FloatDensity
    • times

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

      Calculate the multiplication of FloatDimensionless and FloatElectricalCapacitance, which results in a FloatElectricalCapacitance scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatElectricalCapacitance scalar as a multiplication of FloatDimensionless and FloatElectricalCapacitance
    • times

      public final FloatElectricalCharge times​(FloatElectricalCharge v)
      Calculate the multiplication of FloatDimensionless and FloatElectricalCharge, which results in a FloatElectricalCharge scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatElectricalCharge scalar as a multiplication of FloatDimensionless and FloatElectricalCharge
    • times

      Calculate the multiplication of FloatDimensionless and FloatElectricalConductance, which results in a FloatElectricalConductance scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatElectricalConductance scalar as a multiplication of FloatDimensionless and FloatElectricalConductance
    • times

      Calculate the multiplication of FloatDimensionless and FloatElectricalCurrent, which results in a FloatElectricalCurrent scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatElectricalCurrent scalar as a multiplication of FloatDimensionless and FloatElectricalCurrent
    • times

      Calculate the multiplication of FloatDimensionless and FloatElectricalInductance, which results in a FloatElectricalInductance scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatElectricalInductance scalar as a multiplication of FloatDimensionless and FloatElectricalInductance
    • times

      Calculate the multiplication of FloatDimensionless and FloatElectricalPotential, which results in a FloatElectricalPotential scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatElectricalPotential scalar as a multiplication of FloatDimensionless and FloatElectricalPotential
    • times

      Calculate the multiplication of FloatDimensionless and FloatElectricalResistance, which results in a FloatElectricalResistance scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatElectricalResistance scalar as a multiplication of FloatDimensionless and FloatElectricalResistance
    • times

      public final FloatEnergy times​(FloatEnergy v)
      Calculate the multiplication of FloatDimensionless and FloatEnergy, which results in a FloatEnergy scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatEnergy scalar as a multiplication of FloatDimensionless and FloatEnergy
    • times

      public final FloatEquivalentDose times​(FloatEquivalentDose v)
      Calculate the multiplication of FloatDimensionless and FloatEquivalentDose, which results in a FloatEquivalentDose scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatEquivalentDose scalar as a multiplication of FloatDimensionless and FloatEquivalentDose
    • times

      public final FloatFlowMass times​(FloatFlowMass v)
      Calculate the multiplication of FloatDimensionless and FloatFlowMass, which results in a FloatFlowMass scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatFlowMass scalar as a multiplication of FloatDimensionless and FloatFlowMass
    • times

      public final FloatFlowVolume times​(FloatFlowVolume v)
      Calculate the multiplication of FloatDimensionless and FloatFlowVolume, which results in a FloatFlowVolume scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatFlowVolume scalar as a multiplication of FloatDimensionless and FloatFlowVolume
    • times

      public final FloatForce times​(FloatForce v)
      Calculate the multiplication of FloatDimensionless and FloatForce, which results in a FloatForce scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatForce scalar as a multiplication of FloatDimensionless and FloatForce
    • times

      public final FloatFrequency times​(FloatFrequency v)
      Calculate the multiplication of FloatDimensionless and FloatFrequency, which results in a FloatFrequency scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatFrequency scalar as a multiplication of FloatDimensionless and FloatFrequency
    • times

      public final FloatIlluminance times​(FloatIlluminance v)
      Calculate the multiplication of FloatDimensionless and FloatIlluminance, which results in a FloatIlluminance scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatIlluminance scalar as a multiplication of FloatDimensionless and FloatIlluminance
    • times

      public final FloatLength times​(FloatLength v)
      Calculate the multiplication of FloatDimensionless and FloatLength, which results in a FloatLength scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatLength scalar as a multiplication of FloatDimensionless and FloatLength
    • times

      public final FloatLinearDensity times​(FloatLinearDensity v)
      Calculate the multiplication of FloatDimensionless and FloatLinearDensity, which results in a FloatLinearDensity scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatLinearDensity scalar as a multiplication of FloatDimensionless and FloatLinearDensity
    • times

      public final FloatLuminousFlux times​(FloatLuminousFlux v)
      Calculate the multiplication of FloatDimensionless and FloatLuminousFlux, which results in a FloatLuminousFlux scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatLuminousFlux scalar as a multiplication of FloatDimensionless and FloatLuminousFlux
    • times

      Calculate the multiplication of FloatDimensionless and FloatLuminousIntensity, which results in a FloatLuminousIntensity scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatLuminousIntensity scalar as a multiplication of FloatDimensionless and FloatLuminousIntensity
    • times

      Calculate the multiplication of FloatDimensionless and FloatMagneticFluxDensity, which results in a FloatMagneticFluxDensity scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatMagneticFluxDensity scalar as a multiplication of FloatDimensionless and FloatMagneticFluxDensity
    • times

      public final FloatMagneticFlux times​(FloatMagneticFlux v)
      Calculate the multiplication of FloatDimensionless and FloatMagneticFlux, which results in a FloatMagneticFlux scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatMagneticFlux scalar as a multiplication of FloatDimensionless and FloatMagneticFlux
    • times

      public final FloatMass times​(FloatMass v)
      Calculate the multiplication of FloatDimensionless and FloatMass, which results in a FloatMass scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatMass scalar as a multiplication of FloatDimensionless and FloatMass
    • times

      public final FloatPower times​(FloatPower v)
      Calculate the multiplication of FloatDimensionless and FloatPower, which results in a FloatPower scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatPower scalar as a multiplication of FloatDimensionless and FloatPower
    • times

      public final FloatPressure times​(FloatPressure v)
      Calculate the multiplication of FloatDimensionless and FloatPressure, which results in a FloatPressure scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatPressure scalar as a multiplication of FloatDimensionless and FloatPressure
    • times

      public final FloatRadioActivity times​(FloatRadioActivity v)
      Calculate the multiplication of FloatDimensionless and FloatRadioActivity, which results in a FloatRadioActivity scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatRadioActivity scalar as a multiplication of FloatDimensionless and FloatRadioActivity
    • times

      public final FloatSpeed times​(FloatSpeed v)
      Calculate the multiplication of FloatDimensionless and FloatSpeed, which results in a FloatSpeed scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatSpeed scalar as a multiplication of FloatDimensionless and FloatSpeed
    • times

      public final FloatTemperature times​(FloatTemperature v)
      Calculate the multiplication of FloatDimensionless and FloatTemperature, which results in a FloatTemperature scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatTemperature scalar as a multiplication of FloatDimensionless and FloatTemperature
    • times

      public final FloatDuration times​(FloatDuration v)
      Calculate the multiplication of FloatDimensionless and FloatDuration, which results in a FloatDuration scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatDuration scalar as a multiplication of FloatDimensionless and FloatDuration
    • times

      public final FloatTorque times​(FloatTorque v)
      Calculate the multiplication of FloatDimensionless and FloatTorque, which results in a FloatTorque scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatTorque scalar as a multiplication of FloatDimensionless and FloatTorque
    • times

      public final FloatVolume times​(FloatVolume v)
      Calculate the multiplication of FloatDimensionless and FloatVolume, which results in a FloatVolume scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatVolume scalar as a multiplication of FloatDimensionless and FloatVolume
    • divide

      public final FloatLinearDensity divide​(FloatLength v)
      Calculate the division of FloatDimensionless and FloatLength, which results in a FloatLinearDensity scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatLinearDensity scalar as a division of FloatDimensionless and FloatLength
    • divide

      public final FloatLength divide​(FloatLinearDensity v)
      Calculate the division of FloatDimensionless and FloatLinearDensity, which results in a FloatLength scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatLength scalar as a division of FloatDimensionless and FloatLinearDensity
    • divide

      public final FloatFrequency divide​(FloatDuration v)
      Calculate the division of FloatDimensionless and FloatDuration, which results in a FloatFrequency scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatFrequency scalar as a division of FloatDimensionless and FloatDuration
    • divide

      public final FloatDuration divide​(FloatFrequency v)
      Calculate the division of FloatDimensionless and FloatFrequency, which results in a FloatDuration scalar.
      Parameters:
      v - FloatDimensionless scalar
      Returns:
      FloatDuration scalar as a division of FloatDimensionless and FloatFrequency