Simplify initClock?

[turion]

Since long, I wanted to simplify the type signature of initClock from

  initClock ::
    cl ->
    m (MSF m () (Time cl, Tag cl), Time cl)

to

  initClock ::
    cl -> MSF m () (Time cl, Tag cl)

There are several reasons for the more complicated type signature:

• The extra m action can be used to initialise a resource. (Although this is usually the least concern, the initialization could also happen upon the first tick, or be done with a ReaderT newtype.)
• The m action is used to generate an initial time. This has several advantages:
  • It is simpler to refer to the time since clock initialization.
  • If the initial time was the first timestamp, then the first time difference would always be 0. With a dedicated initial time, we can often have an interval > 0 (although not always, e.g. in pure clocks).
  • Sometimes we have no good tag value at the initialization, and one would have to artificially add one (or wrap the tag in a Maybe)

But there are also downsides to this complicated type signature:

• It's complicated to explain and understand. It's extra boiler plate when writing a new clock, you now have to measure the time in the running clock and also at initialization. Overall, it's not conceptually nice.
• We always have to throw away one initial time when scheduling several clocks. This is an arbitrary choice which can lead to imprecision. If initClock directly returns a running clock, we could simply merge the timestamp streams.

With #299 (automata) there would be a new downside: The state of the running clock is typically not known statically (because it is hidden behind a monadic action), therefore GHC cannot optimize the whole Rhine further after clock erasure. This causes a performance degradation that is not easily justifiable.

Overall I believe that after #299, a serious attempt at simplification should be made.

[turion]

The extra m action can be used to initialise a resource.

That's actually the wrong approach: The clock value should already contain the initialised resource! So if anything, there should be an action m cl that initialises the resource, and then the clock value can be used. Although that will still have the same problem: The Rhine is then not statically known.

[turion]

There is a big semantic change that I'm unsure about. On master the first tick is always a certain time after the initial time. Also, the duration sinceLast on the first tick is the time from the initial time the first tick. With this change here, we would have the awkward situation that sinceLast on the first tick is always 0! This is especially awkward for a fixed rate clock where we expect sinceLast to be largely constant. Instead, it is now 0 and then afterwards largely constant.

I'm not sure how to proceed then. I see several different stances:

1. There should be some initialisation step that measures the initial time, and there shouldn't be any data processing on that step yet. This could be implemented in the original way, but there are a few other ways:

class Clock m cl where
  initialTime :: cl -> m (Time cl)
  initClock :: cl -> Automaton m () (Time cl, Tag cl)

or even

class Clock m cl where
  initialTime :: cl -> m (Time cl)
  initClock :: Automaton m cl (Time cl, Tag cl)

In latter case, the running clock is completely known statically, which is great.
2. On the first tick, sinceInit and sinceLast have no meaning and could have any values, e.g. 0 or 'Nothing'. This may be right, but is unhelpful in many cases and breaks with the established semantics. On the other hand, for CSV clocks (#226) and similar batch processing scenarios, there is no sensible start time other than a manually supplied one or the first timestamp.

[turion]

In latter case, the running clock is completely known statically, which is great.

But this also means that many clocks like RescaledClock or SelectClock cannot be implemented anymore.

[turion]

In latter case, the running clock is completely known statically, which is great.

But this also means that many clocks like RescaledClock or SelectClock cannot be implemented anymore.

But that's not such a problem if initClock is sufficiently inlined.

[ners]

How about

initClockM :: m cl -> MSF m () (Time cl, Tag cl)

initClock :: cl -> MSF m () (Time cl, Tag cl)
initClock = initClockM . pure