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

Mult

open class Mult<A : Unit<A>?, B : Unit?> : Unit

A combinatory unit type that is equivalent to the product of two other others. Note that algebraic reduction is not possible in Java's generic type system, so Mult<A, B> is not type-compatible with Mult<B, A>!

Since

1.0.0-pre

Parameters

<A>

the type of the first unit in the result

the type of the second unit in the result

Constructors

Mult

protected constructor(a: A, b: B)

Creates a new product unit.

Inherited properties

baseUnit

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.

Companion

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

combine

@NonNull

open fun <A : Unit<A>?, B : Unit?> combine(a: A, b: B): Mult<A, B>

Creates a new Mult unit derived from two arbitrary units multiplied together.

equals

open fun equals(other: Any): Boolean

hashCode

open fun hashCode(): Int

toString

@NonNull

open fun toString(): String

unitA

open fun unitA(): A

Gets the first unit of the product.

unitB

open fun unitB(): B

Gets the second unit of the product.

Inherited functions

convertFrom

fun convertFrom(magnitude: Double, otherUnit: Unit): Double

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

equivalent

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.

from

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

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

fromBaseUnits

fun fromBaseUnits(valueInBaseUnits: Double): Double

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

isBaseUnit

fun isBaseUnit(): Boolean

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

mult

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.

name

fun name(): String

Gets the name of this unit.

fun of(magnitude: Double): Measure

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

ofBaseUnits

fun ofBaseUnits(baseUnitMagnitude: Double): Measure

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

one

fun one(): Measure

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

per

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

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

symbol

fun symbol(): String

Gets the symbol of this unit.

toBaseUnits

fun toBaseUnits(valueInNativeUnits: Double): Double

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

zero

fun zero(): Measure

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