Squants/squants.space/Length

Length

final class Length extends Quantity[Length] with TimeIntegral[Velocity] with SecondTimeIntegral[Acceleration]

Represents a quantity of length

Represents a quantity of length

Value Params
value

value in squants.space.Meters

Authors

garyKeorkunian

Since

0.1

Companion
object
trait Ordered[Length]
trait Comparable[Length]
trait Serializable
class Object
trait Matchable
class Any

Value members

Concrete methods

def *(that: Length): Area
def *(that: Area): Volume
def *(that: Force): Energy
def *(that: SpectralPower): Power
def toAngstroms: Double
def toAstronomicalUnits: Double
def toCentimeters: Double
def toDecameters: Double
def toDecimeters: Double
def toEeV: Double
def toFeet: Double
def toGeV: Double
def toGigaParsecs: Double
def toHectometers: Double
def toInches: Double
def toKiloParsecs: Double
def toKilometers: Double
def toLightYears: Double
def toMeV: Double
def toMegaParsecs: Double
def toMeters: Double
def toMicrons: Double
def toMillimeters: Double
def toNanometers: Double
def toNauticalMiles: Double
def toNominalSolarRadii: Double
def toParsecs: Double
def toPeV: Double
def toSolarRadii: Double
def toTeV: Double
def toUsMiles: Double
def toYards: Double
def toeV: Double
def tokeV: Double
def tomeV: Double

Inherited methods

def %(that: Length): Double
Inherited from
Quantity
def %(that: Double): Length
Inherited from
Quantity
def *(that: Frequency): Velocity

Returns the Time Derivative of this Quantity based on the Frequency this Quantity occurs

Returns the Time Derivative of this Quantity based on the Frequency this Quantity occurs

Value Params
that

Frequency - the rate at which this Quantity occurs

Inherited from
TimeIntegral
def *(that: Price[Length]): Money
Inherited from
Quantity
def *(that: Double): Length
Inherited from
Quantity
def +(that: Length): Length
Inherited from
Quantity
def +-(that: Length): QuantityRange[Length]
Inherited from
Quantity
def -(that: Length): Length
Inherited from
Quantity
def /(that: Velocity): Time

Returns the amount time required to achieve the given change in the Derivative

Returns the amount time required to achieve the given change in the Derivative

Value Params
that

Derivative

Inherited from
TimeIntegral
def /(that: Time): Velocity

Returns the Time Derivative which represents a change of the underlying quantity equal to this quantity over the given time.

Returns the Time Derivative which represents a change of the underlying quantity equal to this quantity over the given time.

Value Params
that

Time

Inherited from
TimeIntegral
def /(that: Length): Double
Inherited from
Quantity
def /(that: Double): Length
Inherited from
Quantity
def /%(that: Length): (Double, Length)
Inherited from
Quantity
def /%(that: Double): (Length, Length)
Inherited from
Quantity
def <(that: Length): Boolean
Inherited from
Ordered
def <=(that: Length): Boolean
Inherited from
Ordered
def =~(that: Length)(tolerance: Length): Boolean

approx

approx

Inherited from
Quantity
def >(that: Length): Boolean
Inherited from
Ordered
def >=(that: Length): Boolean
Inherited from
Ordered
def abs: Length

Returns the absolute value of this Quantity

Returns the absolute value of this Quantity

Returns

Quantity

Inherited from
Quantity
def approx(that: Length)(tolerance: Length): Boolean

Returns boolean result of approximate equality comparison

Returns boolean result of approximate equality comparison

Value Params
that

Quantity

tolerance

Quantity

Inherited from
Quantity
def ceil: Length

Returns the smallest (closest to negative infinity) Quantity value that is greater than or equal to the argument and is equal to a mathematical integer.

Returns the smallest (closest to negative infinity) Quantity value that is greater than or equal to the argument and is equal to a mathematical integer.

Returns

Quantity

See also

java.lang.Math#ceil(double)

Inherited from
Quantity
def compare(that: Length): Int

Implements Ordered.compare

Implements Ordered.compare

Value Params
that

Quantity

Returns

Int

Inherited from
Quantity
def compareTo(that: Length): Int
Inherited from
Ordered
def divide(that: Length): Double

Divide this quantity by a like quantity

Divide this quantity by a like quantity

Value Params
that

Quantity

Returns

Double

Inherited from
Quantity
def divide(that: Double): Length

Divide this quantity by some number

Divide this quantity by some number

Value Params
that

Double

Returns

Quantity

Inherited from
Quantity
def divideAndRemainder(that: Length): (Double, Length)

Returns a Pair that includes the result of divideToInteger and remainder

Returns a Pair that includes the result of divideToInteger and remainder

Value Params
that

Quantity

Returns

(Double, Quantity)

Inherited from
Quantity
def divideAndRemainder(that: Double): (Length, Length)

Returns a Pair that includes the result of divideToInteger and remainder

Returns a Pair that includes the result of divideToInteger and remainder

Value Params
that

Double

Returns

(Quantity, Quantity)

Inherited from
Quantity
override def equals(that: Any): Boolean

Override of equals method

Override of equals method

Value Params
that

must be of matching value and unit

Definition Classes
Quantity -> Any
Inherited from
Quantity
def floor: Length

Returns the largest (closest to positive infinity) Quantity value that is less than or equal to the argument and is equal to a mathematical integer

Returns the largest (closest to positive infinity) Quantity value that is less than or equal to the argument and is equal to a mathematical integer

Returns

Quantity

See also

java.lang.Math#floor(double)

Inherited from
Quantity
override def hashCode(): Int

Override of hashCode

Override of hashCode

Definition Classes
Quantity -> Any
Inherited from
Quantity
def in(uom: UnitOfMeasure[Length]): Length

Returns an equivalent Quantity boxed with the supplied Unit

Returns an equivalent Quantity boxed with the supplied Unit

Value Params
uom

UnitOfMeasure[A]

Returns

Quantity

Inherited from
Quantity
def map(f: Double => Double): Length

Applies a function to the underlying value of the Quantity, returning a new Quantity in the same unit

Applies a function to the underlying value of the Quantity, returning a new Quantity in the same unit

Value Params
f

Double => Double function

Inherited from
Quantity
def max(that: Length): Length

Returns the max of this and that Quantity

Returns the max of this and that Quantity

Value Params
that

Quantity

Returns

Quantity

Inherited from
Quantity
def min(that: Length): Length

Returns the min of this and that Quantity

Returns the min of this and that Quantity

Value Params
that

Quantity

Returns

Quantity

Inherited from
Quantity
def minus(that: Length): Length

Subtract two like quantities

Subtract two like quantities

Value Params
that

Quantity

Returns

Quantity

Inherited from
Quantity
def negate: Length

Returns the negative value of this Quantity

Returns the negative value of this Quantity

Returns

Quantity

Inherited from
Quantity
def notWithin(range: QuantityRange[Length]): Boolean

Returns true if this value is not within (contains) the range

Returns true if this value is not within (contains) the range

Value Params
range

QuantityRange

Returns

Boolean

Inherited from
Quantity
def per(that: Time): Velocity
Inherited from
TimeIntegral
def plus(that: Length): Length

Add two like quantities

Add two like quantities

Value Params
that

Quantity

Returns

Quantity

Inherited from
Quantity
def plusOrMinus(that: Length): QuantityRange[Length]

Returns a QuantityRange representing the range for this value +- that

Returns a QuantityRange representing the range for this value +- that

Value Params
that

Quantity

Returns

QuantityRange

Inherited from
Quantity
def remainder(that: Length): Double

Returns the remainder of a division by a like quantity

Returns the remainder of a division by a like quantity

Value Params
that

Quantity

Returns

Double

Inherited from
Quantity
def remainder(that: Double): Length

Returns the remainder of a division by a number

Returns the remainder of a division by a number

Value Params
that

Quantity

Returns

Quantity

Inherited from
Quantity
def rint: Length

Returns the Quantity value that is closest in value to the argument and is equal to a mathematical integer.

Returns the Quantity value that is closest in value to the argument and is equal to a mathematical integer.

Returns

Quantity

See also

java.lang.Math#rint(double)

Inherited from
Quantity
def rounded(scale: Int, mode: RoundingMode): Length

Returns the Quantity with its coefficient value rounded using scale and mode. The unit is maintained.

Returns the Quantity with its coefficient value rounded using scale and mode. The unit is maintained.

Value Params
mode

RoundingMode - defaults to HALF_EVEN

scale

Int - scale of the value to be returned

Returns

Quantity

Inherited from
Quantity
def times(that: Double): Length

Multiply this quantity by some number

Multiply this quantity by some number

Value Params
that

Double

Returns

Quantity

Inherited from
Quantity
def to(uom: UnitOfMeasure[Length]): Double

Returns a Double representing the quantity in terms of the supplied unit

Returns a Double representing the quantity in terms of the supplied unit

 val d = Feet(3)
 (d to Inches) should be(36)
Value Params
uom

UnitOfMeasure[A]

Returns

Double

Inherited from
Quantity
def to(that: Length): QuantityRange[Length]

Returns a QuantityRange that goes from this to that

Returns a QuantityRange that goes from this to that

Value Params
that

Quantity

Returns

QuantityRange

Inherited from
Quantity
override def toString: String

Returns a string representing the quantity's value in unit

Returns a string representing the quantity's value in unit

Returns

String

Definition Classes
Quantity -> Any
Inherited from
Quantity
def toString(uom: UnitOfMeasure[Length], format: String): String

Returns a string representing the quantity's value in the given unit in the given format

Returns a string representing the quantity's value in the given unit in the given format

Value Params
format

String containing the format for the value (ie "%.3f")

uom

UnitOfMeasure[A] with UnitConverter

Returns

String

Inherited from
Quantity
def toString(uom: UnitOfMeasure[Length]): String

Returns a string representing the quantity's value in the given unit

Returns a string representing the quantity's value in the given unit

Value Params
uom

UnitOfMeasure[A] with UnitConverter

Returns

String

Inherited from
Quantity
def toTuple(uom: UnitOfMeasure[Length]): (Double, String)

Returns a pair representing the numeric value and the uom's symbol

Returns a pair representing the numeric value and the uom's symbol

Value Params
uom

UnitOfMeasure[A]

Inherited from
Quantity
def toTuple: (Double, String)

Returns a tuple representing the numeric value and the unit's symbol

Returns a tuple representing the numeric value and the unit's symbol

Inherited from
Quantity
def unary_-: Length
Inherited from
Quantity
def within(range: QuantityRange[Length]): Boolean

Returns true if this value is within (contains) the range

Returns true if this value is within (contains) the range

Value Params
range

QuantityRange

Returns

Boolean

Inherited from
Quantity
def ~=(that: Length)(tolerance: Length): Boolean

approx

approx

Inherited from
Quantity
def ≈(that: Length)(tolerance: Length): Boolean

approx

approx

Inherited from
Quantity

Concrete fields

val value: Double