BunyipsLib/org.murraybridgebunyips.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

Link copied to clipboard
protected constructor(numerator: N, denominator: D)
Creates a new proportional unit derived from the ratio of one unit to another.

Inherited properties

Link copied to clipboard
val baseUnit: U

Functions

Link copied to clipboard
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.
Link copied to clipboard
open fun denominator(): D
Gets the denominator unit.
Link copied to clipboard
open fun equals(o: Any): Boolean
Link copied to clipboard
open fun hashCode(): Int
Link copied to clipboard
open fun numerator(): N
Gets the numerator unit.
Link copied to clipboard
open fun reciprocal(): Per<D, N>
Returns the reciprocal of this Per.

Inherited functions

Link copied to clipboard
open 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.
Link copied to clipboard
open fun equivalent(other: Unit<out Any>): Boolean
Checks if this unit is equivalent to another one.
Link copied to clipboard
open fun fromBaseUnits(valueInBaseUnits: Double): Double
Converts a value in terms of base units to a value in terms of this unit.
Link copied to clipboard
open fun getConverterFromBase(): UnaryFunction
Gets the conversion function used to convert values to terms of this unit.
Link copied to clipboard
open fun getConverterToBase(): UnaryFunction
Gets the conversion function used to convert values to base unit terms.
Link copied to clipboard
open fun isBaseUnit(): Boolean
Checks if this unit is the base unit for its own system of measurement.
Link copied to clipboard
open 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.
Link copied to clipboard
open fun name(): String
Gets the name of this unit.
Link copied to clipboard
open fun of(magnitude: Double): Measure<U>
Creates a new measure of this unit with the given value.
Link copied to clipboard
open 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.
Link copied to clipboard
open fun one(): Measure<U>
Gets a measure with a magnitude of 1 in terms of this unit.
Link copied to clipboard
open 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.
open fun per(period: Time): Velocity<U>
Creates a velocity unit derived from this one.
Link copied to clipboard
open fun symbol(): String
Gets the symbol of this unit.
Link copied to clipboard
open fun toBaseUnits(valueInNativeUnits: Double): Double
Converts a value in terms of this unit to a value in terms of the base unit.
Link copied to clipboard
@NonNull
open fun toString(): String
Link copied to clipboard
open fun zero(): Measure<U>
Gets a measure with a magnitude of 0 in terms of this unit.