tick.interval — henryw374/tick 0.4.0-alpha1

am clj/s

(am date)

basic-relation clj/s

A function to determine the (basic) relation between two intervals.

basic-relations clj/s

bounds clj/s

(bounds & args)

complement clj/s

(complement coll)

complement-r clj/s

(complement-r r)

Return the complement of the general relation. The complement ~r of a relation r is the relation consisting of all basic relations not in r.

compose-r clj/s

(compose-r r s)

Return the composition of r and s

concur clj/s

(concur x y)

Return the interval representing the interval, if there is one, representing the interval of time the given intervals are concurrent.

concur? clj/s

concurrencies clj/s

(concurrencies & intervals)

Return a sequence of occurances where intervals coincide (having non-nil concur intervals).

conj clj/s

(conj coll interval)

contains? clj/s

(contains? x y)

conv clj/s

(conv f)

The converse of a basic relation.

converse-r clj/s

(converse-r r)

Return the converse of the given general relation. The converse !r of a relation r is the relation consisting of the converses of all basic relations in r.

difference clj/s

(difference s1)

(difference s1 s2)

(difference s1 s2 & sets)

Return an interval set that is the first set without elements of the remaining sets.

disjoin clj/s

(disjoin s1)

(disjoin s1 s2)

(disjoin s1 s2 & sets)

Split s1 across the grating defined by s2

disjoint? clj/s

divide-by-divisor clj/s

(divide-by-divisor ival divisor)

divide-by-duration clj/s

(divide-by-duration ival dur)

Divide an interval by a duration, returning a sequence of intervals. If the interval cannot be wholly sub-divided by the duration divisor, the last interval will represent the 'remainder' of the division and not be as long as the other preceeding intervals.

divide-by-period clj/s

(divide-by-period ival period)

during? clj/s

(during? x y)

equals? clj/s

(equals? x y)

extend clj/s

(extend ival dur)

finished-by? clj/s

(finished-by? x y)

finishes? clj/s

(finishes? x y)

flatten clj/s

(flatten s)

GeneralRelation cljs

group-by-intervals clj/s

(group-by-intervals intervals-to-group-by ivals)

Divide intervals in s1 by (disjoint ordered) intervals in s2, splitting if necessary, grouping by s2. Complexity is O(n) rather than O(n^2)

IDivisibleInterval clj/s≠ protocol

divide-interval clj/s

(divide-interval divisor ival)

Divide an interval by a given divisor

IGroupable clj/s≠ protocol

group-by clj/s

(group-by grouping ivals)

IIntervalOps clj/s≠ protocol

splice clj/s

(splice this ival)

Splice another interval on to this one

split clj/s

(split this t)

Split ival into 2 intervals at t, returned as a 2-element vector

slice clj/s

(slice this beginning end)

Fit the interval between beginning and end, slicing off one or both ends as necessary

intersection clj/s

(intersection s1)

(intersection s1 s2)

(intersection s1 s2 & sets)

Return a time-ordered sequence of disjoint intervals where two or more intervals of the given sequences are concurrent. Arguments must be time-ordered sequences of disjoint intervals.

intersection-r clj/s

(intersection-r r s)

Return the intersection of the r with s

intersects? clj/s

(intersects? ivals interval)

interval clj/s

(interval t)

ITimeSpanable clj/s≠ protocol

temporal-value clj/s

(temporal-value _)

Return a value of a type that satisfies t/ITimeSpan

meets? clj/s

(meets? x y)

met-by? clj/s

(met-by? x y)

new-interval clj/s

(new-interval v1 v2)

new-interval-group clj/s

(new-interval-group x)

Return an interval group. Interval groups are maps with a :tick/intervals entry that contain a time-ordered sequence of disjoint intervals.

new-relation clj/s

(new-relation & basic-relations)

normalize clj/s

(normalize intervals)

Within a time-ordered sequence of disjoint intervals, return a sequence of interval groups, splicing together meeting intervals.

not-yet-implemented clj/s

(not-yet-implemented)

ordered-disjoint-intervals? clj/s

(ordered-disjoint-intervals? s)

Are all the intervals in the given set time-ordered and disjoint? This is a useful property of a collection of intervals. The given collection must contain proper intervals (that is, intervals that have finite greater-than-zero durations).

overlapped-by? clj/s

(overlapped-by? x y)

overlaps? clj/s

(overlaps? x y)

pm clj/s

(pm date)

preceded-by? clj/s

(preceded-by? x y)

precedes-or-meets? clj/s

precedes? clj/s

(precedes? x y)

relation clj/s

(relation x y)

relation->kw clj/s

scale clj/s

(scale ival factor)

slice-interval clj/s

(slice-interval ival beginning end)

split-interval clj/s

(split-interval ival t)

split-with-assert clj/s

(split-with-assert ival t)

started-by? clj/s

(started-by? x y)

starts? clj/s

(starts? x y)

temporal-amount? clj/s

(temporal-amount? o)

temporal? clj/s

(temporal? o)

union clj/s

(union & colls)

Merge multiple time-ordered sequences of disjoint intervals into a single sequence of time-ordered disjoint intervals.

unite clj/s

(unite intervals)

Unite concurrent intervals. Intervals must be ordered by beginning but not necessarily disjoint (the purpose of this function is to splice together intervals that are concurrent resulting in a time-ordered sequence of disjoint intervals that is returned.