Timeline/gov.nasa.ammos.aerie.procedural.timeline.payloads/LinearEquation

LinearEquation

data class LinearEquation(val initialTime: Duration, val initialValue: Double, val rate: Double)

A linear equation in point-slope form.

Constructors

LinearEquation

constructor(constant: Number)

Creates a constant linear equation at a given value.

constructor(initialTime: Duration, initialValue: Double, rate: Double)

Properties

initialTime

@JvmField

val initialTime: Duration

The time of the start point.

initialValue

@JvmField

val initialValue: Double

The value of the start point.

rate

@JvmField

val rate: Double

The rate of change, in units per second.

Functions

abs

fun abs(): Real

Calculates the absolute value of this equation, as a real profile.

equals

open operator override fun equals(other: Any?): Boolean

findRoot

fun findRoot(): Duration?

Finds the time that this equation is zero, or null if it does not cross the axis.

hashCode

open override fun hashCode(): Int

intervalsEqualTo

fun intervalsEqualTo(other: LinearEquation): Booleans

Calculates when this is equal to another linear equation, as a Booleans object.

intervalsGreaterThan

infix fun intervalsGreaterThan(other: LinearEquation): Booleans

Calculates when this is greater than another linear equation, as a Booleans object.

intervalsGreaterThanOrEqualTo

infix fun intervalsGreaterThanOrEqualTo(other: LinearEquation): Booleans

Calculates when this is greater than or equal to another linear equation, as a Booleans object.

intervalsLessThan

infix fun intervalsLessThan(other: LinearEquation): Booleans

Calculates when this is less than another linear equation, as a Booleans object.

intervalsLessThanOrEqualTo

infix fun intervalsLessThanOrEqualTo(other: LinearEquation): Booleans

Calculates when this is less than or equal to another linear equation, as a Booleans object.

intervalsNotEqualTo

fun intervalsNotEqualTo(other: LinearEquation): Booleans

Calculates when this is not equal to another linear equation, as a Booleans object.

isConstant

fun isConstant(): Boolean

shiftInitialTime

fun shiftInitialTime(newInitialTime: Duration): LinearEquation

Returns an equivalent equation that is represented at a different start time.

toString

open override fun toString(): String

valueAt

fun valueAt(time: Duration): Double

Calculates the value at a given time.