BunyipsLib/org.murraybridgebunyips.bunyipslib.external.units/MutableMeasure

MutableMeasure

class MutableMeasure?> : Measure

A specialization of Measure that allows for mutability. This is intended to be used for memory use reasons (such as on the memory-restricted roboRIO 1 or 2 or SBC coprocessors) and should NOT be exposed in the public API for a class that uses it.

The advantage of using this class is to reuse one instance of a measurement object, as opposed to instantiating a new immutable instance every time an operation is performed. This will reduce memory pressure, but comes at the cost of increased code complexity and sensitivity to race conditions if misused.

Any unsafe methods are prefixed with mut_*, such as mut_plus or mut_replace. These methods will change the internal state of the measurement object, and as such can be dangerous to use. They are primarily intended for use to track internal state of things like sensors

Since

1.0.0-pre

Parameters

the type of the unit of measure

Inherited properties

EQUIVALENCE_THRESHOLD

val EQUIVALENCE_THRESHOLD: Double = 1.0E-12

The threshold for two measures to be considered equivalent if converted to the same unit.

Functions

baseUnitMagnitude

open fun baseUnitMagnitude(): Double

Gets the magnitude of this measure in terms of the base unit.

copy

open fun copy(): Measure

Returns an immutable copy of this measure.

equals

open fun equals(o: Any): Boolean

hashCode

open fun hashCode(): Int

magnitude

open fun magnitude(): Double

Gets the unitless magnitude of this measure.

mut_acc

open fun mut_acc(raw: Double): MutableMeasure

Increments the current magnitude of the measure by the given value.

open fun mut_acc(other: Measure): MutableMeasure

Increments the current magnitude of the measure by the amount of the given measure.

mut_divide

open fun mut_divide(divisor: Double): MutableMeasure

open fun mut_divide(divisor: Measure<out Dimensionless>): MutableMeasure

Divides this measurement by some constant value.

mut_minus

open fun mut_minus(other: Measure): MutableMeasure

open fun mut_minus(magnitude: Double, unit: U): MutableMeasure

Subtracts another measurement to this one.

mut_plus

open fun mut_plus(other: Measure): MutableMeasure

open fun mut_plus(magnitude: Double, unit: U): MutableMeasure

Adds another measurement to this one.

mut_replace

open fun mut_replace(other: Measure): MutableMeasure

Overwrites the state of this measure and replaces it with values from the given one.

open fun mut_replace(magnitude: Double, unit: U): MutableMeasure

Overwrites the state of this measure with new values.

mut_setBaseUnitMagnitude

open fun mut_setBaseUnitMagnitude(baseUnitMagnitude: Double)

Sets the new magnitude of the measurement.

mut_setMagnitude

open fun mut_setMagnitude(magnitude: Double)

Sets the new magnitude of the measurement.

mut_times

open fun mut_times(multiplier: Double): MutableMeasure

open fun mut_times(multiplier: Measure<out Dimensionless>): MutableMeasure

Multiplies this measurement by some constant value.

mutable

open fun ?> mutable(measure: Measure): MutableMeasure

Creates a new mutable measure that is a copy of the given one.

ofBaseUnits

open fun ?> ofBaseUnits(baseUnitMagnitude: Double, unit: U): MutableMeasure

Creates a new mutable measure in the given unit with a magnitude equal to the given one in base units.

ofRelativeUnits

open fun ?> ofRelativeUnits(relativeMagnitude: Double, unit: U): MutableMeasure

Creates a new mutable measure in the given unit with a magnitude in terms of that unit.

toString

@NonNull

open fun toString(): String

unit

open fun unit(): U

Gets the units of this measure.

zero

open fun ?> zero(unit: U): MutableMeasure

Creates a new mutable measure with a magnitude of 0 in the given unit.

Inherited functions

compareTo

abstract fun compareTo(p: T): Int

open fun compareTo(o: Measure): Int

divide

open fun divide(divisor: Double): Measure

Divides this measurement by some constant divisor and returns the result.

open fun <U2 : Unit<U2>?> divide(other: Measure<U2>): Measure<out Any>

Divides this measurement by another measure and performs some dimensional analysis to reduce the units.

open fun gt(o: Measure): Boolean

Checks if this measure is greater than another measure of the same unit.

gte

open fun gte(o: Measure): Boolean

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

open fun in(unit: Unit): Double

Converts this measure to a measure with a different unit of the same type, eg minutes to seconds.

inUnit

open fun inUnit(unit: Unit): Double

Converts this measure to a measure with a different unit of the same type, eg minutes to seconds.

isEquivalent

open fun isEquivalent(other: Measure<out Any>): Boolean

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

isNear

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

Checks if this measure is near another measure of the same unit.

open fun isNear(other: Measure, tolerance: Measure): Boolean

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

open fun lt(o: Measure): Boolean

Checks if this measure is less than another measure of the same unit.

lte

open fun lte(o: Measure): Boolean

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

max

@SafeVarargs

open fun ?> max(measures: Array<Measure>): Measure

Returns the measure with the absolute value closest to positive infinity.

min

@SafeVarargs

open fun ?> min(measures: Array<Measure>): Measure

Returns the measure with the absolute value closest to negative infinity.

minus

open fun minus(other: Measure): Measure

Subtracts another measure from this one.

mutableCopy

open fun mutableCopy(): MutableMeasure

Creates a new mutable copy of this measure.

negate

open fun negate(): Measure

Negates this measure and returns the result.

per

open fun <U2 : Unit<U2>?> per(denominator: U2): Measure<Per<U, U2>>

Creates a relational measure equivalent to this one per some other unit.

open fun per(period: Measure<Time>): Measure<Velocity>

Creates a velocity measure by dividing this one by a time period measure.

open fun per(time: Time): Measure<Velocity>

Creates a velocity measure equivalent to this one per a unit of time.

plus

open fun plus(other: Measure): Measure

Adds another measure to this one.

times

open fun times(multiplier: Double): Measure

Multiplies this measurement by some constant multiplier and returns the result.

open fun <U2 : Unit<U2>?> times(other: Measure<U2>): Measure<out Any>

Generates a new measure that is equal to this measure multiplied by another.

toLongString

open fun toLongString(): String

Returns a string representation of this measurement in a longhand form.

toScientificString

open fun toScientificString(): String

Returns a string representation of this measurement in a scientific shorthand form.

toShortString

open fun toShortString(): String

Returns a string representation of this measurement in the default form.