New function: runUntil #1940
New function: runUntil #1940
Conversation
| -> Signal dom a | ||
| -- ^ 'Signal' we want to sample for the condition | ||
| -> IO () | ||
| runUntil check s = value `seqX` putStrLn msg |
There was a problem hiding this comment.
Perhaps sampleUntil? Given that we already have sample and sampleN.
There was a problem hiding this comment.
But sample and sampleN return samples, runUntl doesn't return them. I agree that it does sample the signal, to be able to do the testing, but if it were called sampleUntil I would think it would return the list of samples until the test was true.
There was a problem hiding this comment.
Although I guess that'd mean it'd have to return [a], so perhaps this is better after all.
There was a problem hiding this comment.
It could be worth having both? I can see a sampleUntil that returns the values also being useful
There was a problem hiding this comment.
For a single test bench, P.takeWhile not $ sample testBench is pretty okay already, it's when you have multiple test benches that runUntil becomes a prety nice shorthand. So I had always intended to steer the reader towards that kind of use, and then totally forgot to put it in once I was actually writing the doc...
There was a problem hiding this comment.
I always have Haskell's
Preludeimported qualified underPin myclashisessions
To take a harsh stance: if you need to have Prelude from base imported in clashi, Clash.Prelude isn't doing it's job well enough. For me the pattern of P.takeWhile not $ sample testBench motivates a sampleUntil function being included because that's friendlier to beginners who may not be aware there's a second prelude they can import
There was a problem hiding this comment.
We are doing enough already... I was not aware, but you can just do
> takeWhile not $ sample testBench
:-)
There was a problem hiding this comment.
Hmm okay, so the situation isn't as bad as I thought. In that case I guess it's not so bad to not have sampleUntil, although maybe it would still be a nice touch given sampleN is basically just a synonym for take after sample and sampleUntil is a synonym for takeWhile (not . p) for some p after sample
I leave it to your own preference 🙂
There was a problem hiding this comment.
I think a sampleUntil with the documentation pointers you suggested on Slack are a good addition.
DigitalBrains1
force-pushed
the
run_until
branch
2 times, most recently
from
290622b
to
ab137b3
Compare
`runUntil`, a function to sample a signal until it returns a value that satisfies the user-given test. It is a convenience function that, among others, allow easy running of a `testBench` style function in Haskell simulation, logging assertion failures to stderr.
DigitalBrains1
force-pushed
the
run_until
branch
from
ab137b3
to
727519b
Compare
runUntil, a function to sample a signal until it returns a value thatsatisfies the user-given test. It is a convenience function that, among
others, allow easy running of a
testBenchstyle function in Haskellsimulation, logging assertion failures to stderr
Still TODO: