| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Ouroboros.Consensus.Util
Description
Miscellaneous utilities
Synopsis
- data Dict ∷ Constraint → Type where
- class Empty a
- class ShowProxy (p ∷ k) where
- data Some (f ∷ k → Type) where
- data SomePair (f ∷ k → Type) (g ∷ k → Type) where
- data SomeSecond (f ∷ Type → Type → Type) a where
- SomeSecond ∷ !(f a b) → SomeSecond f a
- mustBeRight ∷ Either Void a → a
- foldlM' ∷ ∀ m a b. Monad m ⇒ (b → a → m b) → b → [a] → m b
- nTimes ∷ ∀ a. (a → a) → Word64 → a → a
- nTimesM ∷ ∀ m a. Monad m ⇒ (a → m a) → Word64 → a → m a
- repeatedly ∷ (a → b → b) → [a] → b → b
- repeatedlyM ∷ Monad m ⇒ (a → b → m b) → [a] → b → m b
- allEqual ∷ Eq a ⇒ [a] → Bool
- chunks ∷ Int → [a] → [[a]]
- dropLast ∷ Word64 → [a] → [a]
- firstJust ∷ ∀ a b f. Foldable f ⇒ (a → Maybe b) → f a → Maybe b
- groupOn ∷ ∀ a b. Eq b ⇒ (a → b) → [a] → [(b, [a])]
- groupSplit ∷ ∀ a b c. Eq b ⇒ (a → (b, c)) → [a] → [(b, [c])]
- markLast ∷ [a] → [Either a a]
- pickOne ∷ [a] → [([a], a, [a])]
- split ∷ (a → Bool) → [a] → NonEmpty [a]
- splits ∷ [a] → [([a], a, [a])]
- takeLast ∷ Word64 → [a] → [a]
- takeUntil ∷ (a → Bool) → [a] → [a]
- lastMaybe ∷ [a] → Maybe a
- safeMaximum ∷ Ord a ⇒ [a] → Maybe a
- safeMaximumBy ∷ (a → a → Ordering) → [a] → Maybe a
- safeMaximumOn ∷ Ord b ⇒ (a → b) → [a] → Maybe a
- hashFromBytesE ∷ ∀ h a. (HashAlgorithm h, HasCallStack) ⇒ ByteString → Hash h a
- hashFromBytesShortE ∷ ∀ h a. (HashAlgorithm h, HasCallStack) ⇒ ShortByteString → Hash h a
- byteStringChunks ∷ Int → ByteString → [ByteString]
- lazyByteStringChunks ∷ Int → ByteString → [ByteString]
- whenJust ∷ Applicative f ⇒ Maybe a → (a → f ()) → f ()
- checkThat ∷ (Show a, Monad m) ⇒ String → (a → Bool) → a → m ()
- allDisjoint ∷ ∀ a. Ord a ⇒ [Set a] → Bool
- (......:) ∷ (y → z) → (x0 → x1 → x2 → x3 → x4 → x5 → x6 → y) → x0 → x1 → x2 → x3 → x4 → x5 → x6 → z
- (.....:) ∷ (y → z) → (x0 → x1 → x2 → x3 → x4 → x5 → y) → x0 → x1 → x2 → x3 → x4 → x5 → z
- (....:) ∷ (y → z) → (x0 → x1 → x2 → x3 → x4 → y) → x0 → x1 → x2 → x3 → x4 → z
- (...:) ∷ (y → z) → (x0 → x1 → x2 → x3 → y) → x0 → x1 → x2 → x3 → z
- (..:) ∷ (y → z) → (x0 → x1 → x2 → y) → x0 → x1 → x2 → z
- (.:) ∷ (y → z) → (x0 → x1 → y) → x0 → x1 → z
- pairFst ∷ Product f g a → f a
- pairSnd ∷ Product f g a → g a
- eitherToMaybe ∷ Either a b → Maybe b
- fib ∷ Word64 → Word64
Type-level utility
class ShowProxy (p ∷ k) where Source #
Minimal complete definition
Nothing
Instances
data SomePair (f ∷ k → Type) (g ∷ k → Type) where Source #
Pair of functors instantiated to the same existential
data SomeSecond (f ∷ Type → Type → Type) a where Source #
Hide the second type argument of some functor
SomeSecond f a is isomorphic to Some (f a), but is more convenient in
partial applications.
Constructors
| SomeSecond ∷ !(f a b) → SomeSecond f a |
Instances
mustBeRight ∷ Either Void a → a Source #
Folding variations
nTimes ∷ ∀ a. (a → a) → Word64 → a → a Source #
Apply a function n times. The value of each application is forced.
nTimesM ∷ ∀ m a. Monad m ⇒ (a → m a) → Word64 → a → m a Source #
Apply a function n times through a monadic bind. The value of each application is forced.
repeatedly ∷ (a → b → b) → [a] → b → b Source #
repeatedlyM ∷ Monad m ⇒ (a → b → m b) → [a] → b → m b Source #
Lists
groupOn ∷ ∀ a b. Eq b ⇒ (a → b) → [a] → [(b, [a])] Source #
Variation on groupBy that records the matched element
groupOn signum [-3..3] == [ (-1, [-3, -2,-1]) , ( 0, [0]) , ( 1, [1, 2, 3]) ]
groupSplit ∷ ∀ a b c. Eq b ⇒ (a → (b, c)) → [a] → [(b, [c])] Source #
Generalization of groupOn where we specify both what to compare
and what to collect
pickOne ∷ [a] → [([a], a, [a])] Source #
All possible ways to pick on element from a list, preserving order
pickOne [1,2,3] = [ ([], 1, [2, 3])
, ([1], 2, [3])
, ([1,2], 3, [])
]split ∷ (a → Bool) → [a] → NonEmpty [a] Source #
Split a list given a delimiter predicate.
>>>split (`elem` "xy") "axbyxc""a" :| ["b","","c"]
We have the laws
concat (split p as) === filter (not . p) as length (split p as) === length (filter p as) + 1
splits ∷ [a] → [([a], a, [a])] Source #
Focus on one element in the list
E.g.
splits [1..3] == [ ([] , 1 , [2,3]) , ([1] , 2 , [3] ) , ([1,2] , 3 , [] ) ]
takeUntil ∷ (a → Bool) → [a] → [a] Source #
Take items until the condition is true. If the condition is true for an item, include that item as the last item in the returned list. If the condition was never true, the original list is returned.
takeUntil (== 3) [1,2,3,4]
- 1,2,3
- > takeUntil (== 2) [0,1,0]
- 0,1,0
- > takeUntil (== 2) [2,2,3]
- 2
Safe variants of existing base functions
safeMaximum ∷ Ord a ⇒ [a] → Maybe a Source #
safeMaximumBy ∷ (a → a → Ordering) → [a] → Maybe a Source #
safeMaximumOn ∷ Ord b ⇒ (a → b) → [a] → Maybe a Source #
Hashes
hashFromBytesE ∷ ∀ h a. (HashAlgorithm h, HasCallStack) ⇒ ByteString → Hash h a Source #
Calls hashFromBytes and throws an error if the input is of the wrong
length.
hashFromBytesShortE ∷ ∀ h a. (HashAlgorithm h, HasCallStack) ⇒ ShortByteString → Hash h a Source #
Calls hashFromBytesShort and throws an error if the input is of the
wrong length.
Bytestrings
byteStringChunks ∷ Int → ByteString → [ByteString] Source #
lazyByteStringChunks ∷ Int → ByteString → [ByteString] Source #
Monadic utilities
whenJust ∷ Applicative f ⇒ Maybe a → (a → f ()) → f () Source #
Test code
checkThat ∷ (Show a, Monad m) ⇒ String → (a → Bool) → a → m () Source #
Assertion
Variation on assert for use in testing code.
Sets
allDisjoint ∷ ∀ a. Ord a ⇒ [Set a] → Bool Source #
Check that a bunch of sets are all mutually disjoint
Composition
(......:) ∷ (y → z) → (x0 → x1 → x2 → x3 → x4 → x5 → x6 → y) → x0 → x1 → x2 → x3 → x4 → x5 → x6 → z Source #
Product
Miscellaneous
eitherToMaybe ∷ Either a b → Maybe b Source #