Timeline/gov.nasa.ammos.aerie.procedural.timeline.collections.profiles/Booleans

Booleans

data class Booleans(timeline: Timeline<Segment<Boolean>, Booleans>) : Timeline<Segment<Boolean>, Booleans> , SerialConstantOps<Boolean, Booleans> , BooleanOps<Booleans>

A profile of booleans.

Constructors

Booleans

constructor(v: Boolean)

constructor(vararg segments: Segment<Boolean>)

constructor(segments: List<Segment<Boolean>>)

constructor(timeline: Timeline<Segment<Boolean>, Booleans>)

Types

Companion

object Companion

Functions

accumulatedTrueDuration

fun accumulatedTrueDuration(unit: Duration): Real

Creates a Real profile corresponding to the running total of time that this profile has spent true.

and

infix fun and(other: Booleans): Booleans

Computes the AND operation between two boolean profiles.

assignGaps

open infix fun assignGaps(other: SerialSegmentOps<Boolean, *>): Booleans

(DOC) Fills in gaps in this profile with another profile.

open infix fun assignGaps(v: Boolean): Booleans

(DOC) Fills in gaps in this profile with a constant value.

cache

open override fun cache(): Booleans

(DOC) Caches the timeline for all available time.

open override fun cache(opts: CollectOptions): Booleans

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

open override fun cache(bounds: Interval): Booleans

(DOC) A simplified version of cache.

changes

open override fun changes(): Booleans

(DOC) Returns a Booleans that is true whenever this profile changes, and false or gap everywhere else.

collect

open override fun collect(): List<Segment<Boolean>>

(DOC) Collects the timeline for all available time.

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

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

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

(DOC) A simplified version of collect.

convert

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.

detectEdges

open fun detectEdges(edgePredicate: NullBinaryOperation<Boolean, Boolean, Boolean?>): Booleans

(DOC) Uses a NullBinaryOperation as a predicate to highlight edges between segments.

equalTo

open infix fun equalTo(other: SerialConstantOps<Boolean, *>): Booleans

(DOC) Returns a Booleans that is true when this and another profile are equal.

open infix fun equalTo(v: Boolean): Booleans

(DOC) Returns a Booleans that is true when this equals a constant value.

fallingEdges

fun fallingEdges(): Booleans

Detects when this transitions from false to true.

falsifyByDuration

open fun falsifyByDuration(validInterval: Interval): Booleans

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

falsifyLongerThan

open fun falsifyLongerThan(dur: Duration): Booleans

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

falsifyShorterThan

open fun falsifyShorterThan(dur: Duration): Booleans

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

filter

open fun filter(preserveMargin: Boolean = false, f: (Segment<Boolean>) -> Boolean): Booleans

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

filterByDuration

open fun filterByDuration(validInterval: Interval): Booleans

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

filterByWindows

open fun filterByWindows(windows: SerialOps<Interval, *>, truncateMarginal: Boolean = true): Booleans

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

filterLongerThan

open fun filterLongerThan(dur: Duration): Booleans

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

filterShorterThan

open fun filterShorterThan(dur: Duration): Booleans

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

flatMap2OptionalValues

open fun <W : Any> flatMap2OptionalValues(other: SerialSegmentOps<W, *>, op: NullBinaryOperation<Boolean, W, SerialSegmentOps<Boolean, *>?>): Booleans

(DOC) Performs a local binary operation that produces profiles, and flattens it into a profile of the same type as this.

open fun <W : Any, R : Any, RESULT : GeneralOps<Segment<R>, RESULT>> flatMap2OptionalValues(ctor: (Timeline<Segment<R>, RESULT>) -> RESULT, other: SerialSegmentOps<W, *>, op: NullBinaryOperation<Boolean, W, SerialSegmentOps<R, *>?>): RESULT

(DOC) Performs a local binary operation that produces profiles, and flattens it, with special treatment of gaps.

flatMap2Values

open fun flatMap2Values(other: SegmentOps<Boolean, *>, op: (Boolean, Boolean, Interval) -> SegmentOps<Boolean, *>?): Booleans

(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.

flatMapValues

open fun flatMapValues(f: (Segment<Boolean>) -> SegmentOps<Boolean, *>): Booleans

(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.

forEach

open fun forEach(p0: Consumer<in Segment<Boolean>>)

highlight

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.

highlightEqualTo

open fun highlightEqualTo(value: Boolean): Windows

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

highlightFalse

open fun highlightFalse(): Windows

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

highlightTrue

open fun highlightTrue(): Windows

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

inspect

open fun inspect(f: Consumer<List<Segment<Boolean>>>): Booleans

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

isolate

open fun isolate(f: (Segment<Boolean>) -> Boolean): Universal<Segment<Boolean>>

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

isolateEqualTo

open fun isolateEqualTo(value: Boolean): Universal<Segment<Boolean>>

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

isolateFalse

open fun isolateFalse(): Universal<Segment<Boolean>>

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

isolateTrue

open fun isolateTrue(): Universal<Segment<Boolean>>

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

iterator

open operator override fun iterator(): Iterator<Segment<Boolean>>

map2OptionalValues

open fun <W : Any> map2OptionalValues(other: SerialSegmentOps<W, *>, op: NullBinaryOperation<Boolean, W, Boolean?>): Booleans

(DOC) Performs a local binary operation between two profiles where the result is the same type as this profile.

open fun <W : Any, R : Any, RESULT : GeneralOps<Segment<R>, RESULT>> map2OptionalValues(ctor: (Timeline<Segment<R>, RESULT>) -> RESULT, other: SerialSegmentOps<W, *>, op: NullBinaryOperation<Boolean, W, R?>): RESULT

(DOC) Performs a local binary operation between two profiles, with special treatment of gaps.

map2Values

open fun map2Values(other: SegmentOps<Boolean, *>, op: (Boolean, Boolean, Interval) -> Boolean?): Booleans

(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.

mapValues

open fun mapValues(f: (Segment<Boolean>) -> Boolean): Booleans

(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.

nand

infix fun nand(other: Booleans): Booleans

Computes the NAND operation between two boolean profiles.

nor

infix fun nor(other: Booleans): Booleans

Computes the NOR operation between two boolean profiles.

not

open operator fun not(): Booleans

(DOC) Applies the unary NOT operation.

notEqualTo

open infix fun notEqualTo(other: SerialConstantOps<Boolean, *>): Booleans

(DOC) Returns a Booleans that is true when this and another profile are not equal.

open infix fun notEqualTo(v: Boolean): Booleans

(DOC) Returns a Booleans that is true when this is not equal to a constant value.

infix fun or(other: Booleans): Booleans

Computes the OR operation between two boolean profiles.

risingEdges

fun risingEdges(): Booleans

Detects when this transitions from false to true.

rollingTrueDuration

fun rollingTrueDuration(range: Duration, unit: Duration): Real

Calculates the sum of durations of true segments in a range leading the current time.

sample

open fun sample(time: Duration): Boolean?

(DOC) Calculates the value of the profile at the given time.

select

open fun select(interval: Interval): Booleans

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

set

open infix fun set(other: SerialSegmentOps<Boolean, *>): Booleans

(DOC) Overwrites this profile with another. Gaps in the argument profile will be filled in with this profile.

shift

open fun shift(dur: Duration): Booleans

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

shiftEdges

fun shiftEdges(shiftRising: Duration, shiftFalling: Duration): Booleans

Shifts the rising and falling edges of a boolean profile independently of each other.

split

open fun split(f: (Segment<Boolean>) -> Int): Booleans

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

splitEqualTo

open fun splitEqualTo(value: Boolean, numPieces: Int): Booleans

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

spliterator

open fun spliterator(): Spliterator<Segment<Boolean>>

splitFalse

open fun splitFalse(numPieces: Int): Booleans

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

splitTrue

open fun splitTrue(numPieces: Int): Booleans

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

transitions

open fun transitions(from: Boolean, to: Boolean): Booleans

(DOC) Returns a Booleans that is true when this profile's value changes between two specific values.

unsafeCast

open override 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.

unsafeFlatMap

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.

unsafeMap

open fun unsafeMap(boundsTransformer: BoundsTransformer, truncate: Boolean, f: (Segment<Boolean>) -> Segment<Boolean>): Booleans

(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.

unsafeMap2

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.

unsafeMapIntervals

open fun unsafeMapIntervals(boundsTransformer: BoundsTransformer, truncate: Boolean, f: (Segment<Boolean>) -> Interval): Booleans

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

unsafeOperate

open fun unsafeOperate(f: Timeline<Segment<Boolean>, Booleans>.(opts: CollectOptions) -> List<Segment<Boolean>>): Booleans

(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>, Booleans>.(opts: CollectOptions) -> List<R>): RESULT

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

unset

open fun unset(reject: Interval): Booleans

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

xor

infix fun xor(other: Booleans): Booleans

Computes the XOR operation between two boolean profiles.

zip

open infix fun zip(other: SerialSegmentOps<Boolean, *>): Booleans

Overlays two profiles on each other, asserting that they both cannot be defined at the same time.