Timeline/gov.nasa.ammos.aerie.procedural.timeline.ops/BooleanOps

BooleanOps

interface BooleanOps<THIS : BooleanOps<THIS>> : ConstantOps<Boolean, THIS>

Operations mixin for timelines of booleans.

Currently only used by gov.nasa.ammos.aerie.procedural.timeline.collections.profiles.Booleans, but could be used for parallel boolean profiles in the future.

Inheritors

Functions

Link copied to clipboard
open fun cache(): THIS

(DOC) Caches the timeline for all available time.

abstract fun cache(opts: CollectOptions): THIS

Caches the result of collecting this timeline, to be reused for future collect requests if possible.

open fun cache(bounds: Interval): THIS

(DOC) A simplified version of cache.

Link copied to clipboard
open fun collect(): List<Segment<Boolean>>

(DOC) Collects the timeline for all available time.

abstract fun collect(opts: CollectOptions): List<Segment<Boolean>>

(DOC) Evaluates the stack of operations and produces a list of timeline payload objects.

open fun collect(bounds: Interval): List<Segment<Boolean>>

(DOC) A simplified version of collect.

Link copied to clipboard
open fun <RESULT : GeneralOps<Segment<Boolean>, RESULT>> convert(ctor: (Timeline<Segment<Boolean>, RESULT>) -> RESULT): RESULT

(DOC) Safely converts to another timeline type that accepts the same payload type.

Link copied to clipboard
open fun falsifyByDuration(validInterval: Interval): THIS

(DOC) Falsifies any true segments with durations outside the given interval.

Link copied to clipboard
open fun falsifyLongerThan(dur: Duration): THIS

(DOC) Falsifies any true segments with durations longer than the given duration.

Link copied to clipboard
open fun falsifyShorterThan(dur: Duration): THIS

(DOC) Falsifies any true segments with durations shorter than the given duration.

Link copied to clipboard
open fun filter(preserveMargin: Boolean = false, f: (Segment<Boolean>) -> Boolean): THIS

(DOC) Removes or retains objects based on a predicate.

Link copied to clipboard
open fun filterByDuration(validInterval: Interval): THIS

(DOC) Removes objects whose duration is outside a given valid interval.

Link copied to clipboard
open fun filterByWindows(windows: SerialOps<Interval, *>, truncateMarginal: Boolean = true): THIS

(DOC) Filters out payload objects whose intervals are not contained in the given Windows timeline.

Link copied to clipboard
open fun filterLongerThan(dur: Duration): THIS

(DOC) Removes objects whose duration is shorter than a given duration.

Link copied to clipboard
open fun filterShorterThan(dur: Duration): THIS

(DOC) Removes objects whose duration is longer than a given duration.

Link copied to clipboard
open fun flatMap2Values(other: SegmentOps<Boolean, *>, op: (Boolean, Boolean, Interval) -> SegmentOps<Boolean, *>?): THIS

(DOC) A simpler version of flatMap2Values for operations that don't change the timeline type.

open fun <W : Any, R : Any, RESULT : SegmentOps<R, RESULT>> flatMap2Values(ctor: (Timeline<Segment<R>, RESULT>) -> RESULT, other: SegmentOps<W, *>, op: (Boolean, W, Interval) -> SegmentOps<R, *>?): RESULT

(DOC) Performs a local binary operation that produces profiles, and flattens it.

Link copied to clipboard
open fun flatMapValues(f: (Segment<Boolean>) -> SegmentOps<Boolean, *>): THIS

(DOC) A simpler version of flatMapValues for operations that don't change the timeline type.

open fun <R : Any, RESULT : SegmentOps<R, RESULT>> flatMapValues(ctor: (Timeline<Segment<R>, RESULT>) -> RESULT, f: (Segment<Boolean>) -> SegmentOps<R, *>): RESULT

(DOC) Maps segments into a collection of nested timelines and flattens them into their original intervals.

Link copied to clipboard
open fun forEach(p0: Consumer<in Segment<Boolean>>)
Link copied to clipboard
open fun highlight(f: (Segment<Boolean>) -> Boolean): Windows

(DOC) Similar to filter, but produces a coalesced Windows object that highlights everything that satisfies the predicate.

Link copied to clipboard
open fun highlightEqualTo(value: Boolean): Windows

(DOC) Highlights intervals where the value is equal to a specific value.

Link copied to clipboard
open fun highlightFalse(): Windows

(DOC) Creates an Windows object that highlights whenever this profile is false.

Link copied to clipboard
open fun highlightTrue(): Windows

(DOC) Creates an Windows object that highlights whenever this profile is true.

Link copied to clipboard
open fun inspect(f: Consumer<List<Segment<Boolean>>>): THIS

(DOC) Inserts a no-op function into the operation stack to allow side effects, such as printing.

Link copied to clipboard
open fun isolate(f: (Segment<Boolean>) -> Boolean): Universal<Segment<Boolean>>

(DOC) Similar to filter, but returns an Universal timeline.

Link copied to clipboard
open fun isolateEqualTo(value: Boolean): Universal<Segment<Boolean>>

(DOC) Isolates intervals where the value is equal to a specific value.

Link copied to clipboard
open fun isolateFalse(): Universal<Segment<Boolean>>

(DOC) Creates an Universal object with intervals whenever this profile is false.

Link copied to clipboard
open fun isolateTrue(): Universal<Segment<Boolean>>

(DOC) Creates an Universal object with intervals whenever this profile is true.

Link copied to clipboard
abstract operator fun iterator(): Iterator<Segment<Boolean>>
Link copied to clipboard
open fun map2Values(other: SegmentOps<Boolean, *>, op: (Boolean, Boolean, Interval) -> Boolean?): THIS

(DOC) A simplified version of map2Values for operations that don't change the timeline type.

open fun <W : Any, R : Any, RESULT : SegmentOps<R, RESULT>> map2Values(ctor: (Timeline<Segment<R>, RESULT>) -> RESULT, other: SegmentOps<W, *>, op: (Boolean, W, Interval) -> R?): RESULT

(DOC) Performs a local binary operation between two segment-valued timelines.

Link copied to clipboard
open fun mapValues(f: (Segment<Boolean>) -> Boolean): THIS

(DOC) Locally transforms the values of a profile without changing the intervals or profile type.

open fun <R : Any, RESULT : SegmentOps<R, RESULT>> mapValues(ctor: (Timeline<Segment<R>, RESULT>) -> RESULT, f: (Segment<Boolean>) -> R): RESULT

(DOC) Locally transforms the values of a profile without changing the intervals.

Link copied to clipboard
open operator fun not(): THIS

(DOC) Applies the unary NOT operation.

Link copied to clipboard
open fun select(interval: Interval): THIS

(DOC) Restricts the timeline to only be evaluated in the given interval.

Link copied to clipboard
open fun shift(dur: Duration): THIS

(DOC) Uniformly shifts the entire timeline in time (positive shifts toward the future).

Link copied to clipboard
open fun split(f: (Segment<Boolean>) -> Int): THIS

(DOC) Splits payload objects into a variable number of equally sized pieces.

Link copied to clipboard
open fun splitEqualTo(value: Boolean, numPieces: Int): THIS

(DOC) Splits segments where the value is equal to a specific value.

Link copied to clipboard
Link copied to clipboard
open fun splitFalse(numPieces: Int): THIS

(DOC) Splits false segments into the given number of pieces (leaving true unchanged).

Link copied to clipboard
open fun splitTrue(numPieces: Int): THIS

(DOC) Splits true segments into the given number of pieces (leaving false unchanged).

Link copied to clipboard
abstract fun <RESULT : Timeline<Segment<Boolean>, RESULT>> unsafeCast(ctor: (Timeline<Segment<Boolean>, RESULT>) -> RESULT): RESULT

(DOC) UNSAFE! Casts this timeline type to another type without changing its contents.

Link copied to clipboard
open fun <R : IntervalLike<R>, RESULT : GeneralOps<R, RESULT>> unsafeFlatMap(ctor: (Timeline<R, RESULT>) -> RESULT, boundsTransformer: BoundsTransformer, truncate: Boolean, f: (Segment<Boolean>) -> Segment<GeneralOps<R, *>>): RESULT

(DOC) UNSAFE! Maps each object to a nested timeline and flattens all the timelines into one.

Link copied to clipboard
open fun unsafeMap(boundsTransformer: BoundsTransformer, truncate: Boolean, f: (Segment<Boolean>) -> Segment<Boolean>): THIS

(DOC) UNSAFE! A simpler version of unsafeMap for operations that don't change the timeline type.

open fun <R : IntervalLike<R>, RESULT : GeneralOps<R, RESULT>> unsafeMap(ctor: (Timeline<R, RESULT>) -> RESULT, boundsTransformer: BoundsTransformer, truncate: Boolean, f: (Segment<Boolean>) -> R): RESULT

(DOC) UNSAFE! Maps each timeline object to another object, of potentially a different type, at potentially a different time.

Link copied to clipboard
open fun <W : IntervalLike<W>, R : IntervalLike<R>, RESULT : GeneralOps<R, RESULT>> unsafeMap2(ctor: (Timeline<R, RESULT>) -> RESULT, other: GeneralOps<W, *>, op: (Segment<Boolean>, W, Interval) -> R?): RESULT

Performs a generalized binary operation between this and another timeline.

Link copied to clipboard
open fun unsafeMapIntervals(boundsTransformer: BoundsTransformer, truncate: Boolean, f: (Segment<Boolean>) -> Interval): THIS

(DOC) UNSAFE! Maps the interval of each object, leaving the rest of the object unchanged.

Link copied to clipboard
open fun unsafeOperate(f: Timeline<Segment<Boolean>, THIS>.(opts: CollectOptions) -> List<Segment<Boolean>>): THIS

(DOC) UNSAFE! A simpler version of unsafeOperate for operations that don't change the timeline type.

open fun <R : IntervalLike<R>, RESULT : GeneralOps<R, RESULT>> unsafeOperate(ctor: (Timeline<R, RESULT>) -> RESULT, f: Timeline<Segment<Boolean>, THIS>.(opts: CollectOptions) -> List<R>): RESULT

(DOC) UNSAFE! The basic, most general operation method. All operations eventually delegate here.

Link copied to clipboard
open fun unset(reject: Interval): THIS

(DOC) Unsets everything in a given interval. Timeline objects whose intervals fully contain the rejected interval may be split into two objects.