NextControl Units/dev.nextftc.units.measuretypes/Mul

Mul

open class Mul<N : Unit<N>, D : Unit<D>>(val magnitude: Double, val unit: MulUnit<N, D>) : Measure<MulUnit<N, D>> (source)

Immutable measurement representing the product of two units.

This class represents values like torque (Newton-meters), energy (kilowatt-hours), or any other quantity that is the product of two units.

Constructors

Mul

constructor(magnitude: Double, unit: MulUnit<N, D>)

Properties

absoluteValue

open val absoluteValue: Measure<MulUnit<N, D>>

Absolute value of measure.

baseUnit

open val baseUnit: MulUnit<N, D>

A convenience method to get the base unit of the measurement. Equivalent to unit.baseUnit.

baseUnitMagnitude

open override val baseUnitMagnitude: Double

Gets the magnitude of this measure in terms of the base unit. If the unit is the base unit for its system of measure, then the value will be equivalent to magnitude.

magnitude

open override val magnitude: Double

Gets the unitless magnitude of this measure.

sign

open val sign: Double

Returns the sign of this measure.

unit

open override val unit: MulUnit<N, D>

Gets the units of this measure.

Functions

abs

open fun abs(unit: MulUnit<N, D>): Double

Absolute value of measure.

compareTo

open operator override fun compareTo(other: Measure<MulUnit<N, D>>): Int

div

open fun div(other: Measure<out MulUnit<N, D>>): Double

Divides this measure by another measure and returns the ratio as a dimensionless value.

open operator fun <V : Unit<V>> div(other: Measure<V>): Per<MulUnit<N, D>, V>

Divides this measure by another measure of a different type to create a ratio unit. For example, Distance / Time creates a velocity measurement, or Voltage / Distance creates electric field strength.

open operator fun div(divisor: Number): Measure<MulUnit<N, D>>

open operator override fun div(divisor: Double): Mul<N, D>

Divides this measure by a scalar and returns the result.

into

open fun into(unit: MulUnit<N, D>): Double

Converts this measure to a measure with a different unit of the same type, eg minutes to seconds. Converting to the same unit is equivalent to calling magnitude.

isEquivalent

open fun isEquivalent(other: Measure<*>): Boolean

Checks if this measure is equivalent to another measure of the same unit.

isNear

open fun isNear(other: Measure<*>, varianceThreshold: Double): Boolean

Checks if this measure is near another measure of the same unit. Provide a variance threshold for use for a +/- scalar, such as 0.05 for +/- 5%.

open fun isNear(other: Measure<MulUnit<N, D>>, tolerance: Measure<MulUnit<N, D>>): Boolean

Checks if this measure is near another measure of the same unit, with a specified tolerance of the same unit.

minus

open operator override fun minus(other: Measure<out MulUnit<N, D>>): Mul<N, D>

Subtracts another measure of the same unit type from this one.

negate

open fun ~~negate~~(): Measure<MulUnit<N, D>>

Returns a measure equivalent to this one equal to zero minus its current value. For non-linear unit types like temperature, the zero point is treated as the zero value of the base unit (eg Kelvin). In effect, this means code like Celsius.of(10).negate() returns a value equivalent to -10 Kelvin, and not -10° Celsius.

plus

open operator override fun plus(other: Measure<out MulUnit<N, D>>): Mul<N, D>

Adds another measure of the same unit type to this one.

times

open operator fun <V : Unit<V>> times(other: Measure<V>): Mul<MulUnit<N, D>, V>

Multiplies this measure by another measure of a different type to create a compound unit. For example, Distance * Distance creates an area measurement, or Voltage * Time creates charge.

open operator fun times(multiplier: Number): Measure<MulUnit<N, D>>

open operator override fun times(multiplier: Double): Mul<N, D>

Multiplies this measure by a scalar unitless multiplier.

toLongString

open fun toLongString(): String

Returns a string representation of this measurement in a longhand form. The name of the backing unit is used, rather than its symbol, and the magnitude is represented in a full string, not scientific notation. (Very large values may be represented in scientific notation, however)

toShortString

open fun toShortString(): String

Returns a string representation of this measurement in a shorthand form. The symbol of the backing unit is used, rather than the full name, and the magnitude is represented in scientific notation.

toString

open override fun toString(): String

unaryMinus

open operator override fun unaryMinus(): Mul<N, D>

Returns a measure equivalent to this one equal to zero minus its current value.

withSign

open fun withSign(other: Measure<MulUnit<N, D>>): Measure<MulUnit<N, D>>

Take the sign of another measure. This measure's and the provided measure's signs are considered in this measure's unit.

open fun withSign(other: Measure<MulUnit<N, D>>, unit: MulUnit<N, D>): Double

Take the sign of another measure.