BunyipsLib/au.edu.sa.mbhs.studentrobotics.bunyipslib.external.units/Per

Per

open class Per<N : Unit<N>?, D : Unit<D>?> : Unit<U>

Generic combinatory unit type that represents the proportion of one unit to another, such as Meters per Second or Radians per Celsius.

Note: Velocity is used to represent the velocity dimension, rather than Per<Distance, Time>.

Since

1.0.0-pre

Parameters

<N>

the type of the numerator unit

<D>

the type of the denominator unit

Constructors

protected constructor(numerator: N, denominator: D)

Creates a new proportional unit derived from the ratio of one unit to another.

Inherited properties

val baseUnit: U

Gets the base unit of measurement that this unit is derived from. If the unit is the base unit, the unit will be returned.

val Companion: Unit.Companion

converterFromBase

val converterFromBase: UnaryFunction

Gets the conversion function used to convert values to terms of this unit. This generally shouldn't need to be used directly; prefer fromBaseUnits instead.

converterToBase

val converterToBase: UnaryFunction

Gets the conversion function used to convert values to base unit terms. This generally shouldn't need to be used directly; prefer toBaseUnits instead.

Functions

open fun <N : Unit<N>?, D : Unit<D>?> combine(numerator: N, denominator: D): Per<N, D>

Creates a new Per unit derived from an arbitrary numerator and time denominator units.

open fun denominator(): D

Gets the denominator unit.

open fun equals(other: Any): Boolean

open fun hashCode(): Int

open fun numerator(): N

Gets the numerator unit.

open fun reciprocal(): Per<D, N>

Returns the reciprocal of this Per.

Inherited functions

fun convertFrom(magnitude: Double, otherUnit: Unit<U>): Double

Converts a magnitude in terms of another unit of the same dimension to a magnitude in terms of this unit.

fun equivalent(other: Unit<out Any>): Boolean

Checks if this unit is equivalent to another one. Equivalence is determined by both units having the same base type and treat the same base unit magnitude as the same magnitude in their own units, to within Measure.EQUIVALENCE_THRESHOLD.

infix fun <U : Unit<U>> Unit<U>.from(conversion: Pair<Double, Unit<U>>): Double

Converts a magnitude in terms of this unit to a magnitude in terms of another unit of the same dimension.

fun fromBaseUnits(valueInBaseUnits: Double): Double

Converts a value in terms of base units to a value in terms of this unit.

fun isBaseUnit(): Boolean

Checks if this unit is the base unit for its own system of measurement.

fun <U2 : Unit<U2>?> mult(other: U2): Mult<U, U2>

Takes this unit and creates a new combinatory unit equivalent to this unit multiplied by another.

fun name(): String

Gets the name of this unit.

fun of(magnitude: Double): Measure<U>

Creates a new measure of this unit with the given value. The resulting measure is immutable and cannot have its value modified.

fun ofBaseUnits(baseUnitMagnitude: Double): Measure<U>

Creates a new measure with a magnitude equal to the given base unit magnitude, converted to be in terms of this unit.

fun one(): Measure<U>

Gets a measure with a magnitude of 1 in terms of this unit.

fun <D : Unit<D>?> per(denominator: D): Per<U, D>

Takes this unit and creates a new proportional unit where this unit is the numerator and the given denominator is the denominator.

fun per(period: Time): Velocity<U>

Creates a velocity unit derived from this one. Can be chained to denote velocity, acceleration, jerk, etc.

fun symbol(): String

Gets the symbol of this unit.

fun toBaseUnits(valueInNativeUnits: Double): Double

Converts a value in terms of this unit to a value in terms of the base unit.

open fun toString(): String

fun zero(): Measure<U>

Gets a measure with a magnitude of 0 in terms of this unit.