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

UnaryFunction

@FunctionalInterface

interface UnaryFunction

A function that accepts a single double and returns a double result. This is used to represent arbitrary mapping functions for converting units to and from a base unit representation. Temperature units, in particular, typically have an offset from a value in Kelvin and may have a multiplication factor added in, which means that units cannot always be represented as simple ratios of their base units.

Since

1.0.0-pre

Inheritors

Properties

val CUBE: UnaryFunction

A function that cubes the input value.

val CUBE_KEEP_SIGN: UnaryFunction

A function that cubes the input value and keeps the sign.

val IDENTITY: UnaryFunction

The identity function that simply returns the input value.

val NEGATE: UnaryFunction

A function that negates the input value.

val SQUARE: UnaryFunction

A function that squares the input value.

SQUARE_KEEP_SIGN

val SQUARE_KEEP_SIGN: UnaryFunction

A function that squares the input value and keeps the sign.

Functions

abstract fun apply(input: Double): Double

Applies this function to the input value and returns the result.

open fun div(@NonNull divisor: UnaryFunction): UnaryFunction

Creates a composite function h(x) such that h(x) = f(x) / g(x).

open fun div(divisor: Double): UnaryFunction

Creates a composite function h(x) such that h(x) = 1/k * f(x).

open fun exp(@NonNull exponent: UnaryFunction): UnaryFunction

Creates a composite function h(x) such that h(x) = f(x) ^ g(x).

open fun exp(exponent: Double): UnaryFunction

Creates a composite function h(x) such that h(x) = f(x) ^ k.

open fun mult(@NonNull multiplier: UnaryFunction): UnaryFunction

Creates a composite function h(x) such that h(x) = f(x) * g(x).

open fun mult(multiplier: Double): UnaryFunction

Creates a composite function h(x) such that h(x) = k * f(x).

open fun pipeTo(@NonNull next: UnaryFunction): UnaryFunction

Constructs a new function that first calls this function, then passes the result to another as input.