Fold.Shortcut

Type

data ShortcutFold a b

Processes inputs of type a, has the ability to halt midway through the stream, and results in a value of type b

Constructors

forall x y. ShortcutFold

Fields

• initial :: Vitality x y
• step :: y -> a -> Vitality x y
• extractDead :: x -> b
• extractLive :: y -> b

Instances

Applicative (ShortcutFold a)

Defined in Fold.Shortcut.Type

Methods

pure :: a0 -> ShortcutFold a a0

(<*>) :: ShortcutFold a (a0 -> b) -> ShortcutFold a a0 -> ShortcutFold a b

liftA2 :: (a0 -> b -> c) -> ShortcutFold a a0 -> ShortcutFold a b -> ShortcutFold a c

(*>) :: ShortcutFold a a0 -> ShortcutFold a b -> ShortcutFold a b

(<*) :: ShortcutFold a a0 -> ShortcutFold a b -> ShortcutFold a a0

Functor (ShortcutFold a)

Defined in Fold.Shortcut.Type

Methods

fmap :: (a0 -> b) -> ShortcutFold a a0 -> ShortcutFold a b

(<$) :: a0 -> ShortcutFold a b -> ShortcutFold a a0

Monoid b => Monoid (ShortcutFold a b)

Defined in Fold.Shortcut.Type

Methods

mempty :: ShortcutFold a b

mappend :: ShortcutFold a b -> ShortcutFold a b -> ShortcutFold a b

mconcat :: [ShortcutFold a b] -> ShortcutFold a b

Semigroup b => Semigroup (ShortcutFold a b)

Defined in Fold.Shortcut.Type

Methods

(<>) :: ShortcutFold a b -> ShortcutFold a b -> ShortcutFold a b

sconcat :: NonEmpty (ShortcutFold a b) -> ShortcutFold a b

stimes :: Integral b0 => b0 -> ShortcutFold a b -> ShortcutFold a b

Run

run :: ShortcutFold a b -> [a] -> b

Fold a listlike container to a single summary result, forcing only enough input to satisfy the short-cutting fold

Examples

General

magma :: (a -> a -> a) -> ShortcutFold a (Maybe a)

Start with the first input, append each new input on the right with the given function (ambivalent)

semigroup :: Semigroup a => ShortcutFold a (Maybe a)

Append each new input on the right with <> (ambivalent)

monoid :: Monoid a => ShortcutFold a a

Start with mempty, append each input on the right with <> (ambivalent)

Endpoints

first :: ShortcutFold a (Maybe a)

The first input (tenacious)

last :: ShortcutFold a (Maybe a)

The last input (ambivalent)

Extrema

maximum :: Ord a => ShortcutFold a (Maybe a)

The greatest input (ambivalent)

minimum :: Ord a => ShortcutFold a (Maybe a)

The least input (ambivalent)

maximumBy :: (a -> a -> Ordering) -> ShortcutFold a (Maybe a)

The greatest input with respect to the given comparison function (ambivalent)

minimumBy :: (a -> a -> Ordering) -> ShortcutFold a (Maybe a)

The least input with respect to the given comparison function (ambivalent)

Length

null :: ShortcutFold a Bool

True if the input contains no inputs (tenacious)

length :: ShortcutFold a Natural

The number of inputs (ambivalent)

Boolean

and :: ShortcutFold Bool Bool

True if all inputs are True (tenacious)

or :: ShortcutFold Bool Bool

True if any input is True (tenacious)

all :: (a -> Bool) -> ShortcutFold a Bool

True if all inputs satisfy the predicate (tenacious)

any :: (a -> Bool) -> ShortcutFold a Bool

True if any input satisfies the predicate (tenacious)

Numeric

sum :: Num a => ShortcutFold a a

Adds the inputs (ambivalent)

product :: Num a => ShortcutFold a a

Multiplies the inputs (ambivalent)

mean :: Fractional a => ShortcutFold a a

Numerically stable arithmetic mean of the inputs (ambivalent)

variance :: Fractional a => ShortcutFold a a

Numerically stable (population) variance over the inputs (ambivalent)

standardDeviation :: Floating a => ShortcutFold a a

Numerically stable (population) standard deviation over the inputs (ambivalent)

Search

element :: Eq a => a -> ShortcutFold a Bool

True if any input is equal to the given value (tenacious)

notElement :: Eq a => a -> ShortcutFold a Bool

False if any input is equal to the given value (tenacious)

find :: (a -> Bool) -> ShortcutFold a (Maybe a)

The first input that satisfies the predicate, if any (tenacious)

lookup :: Eq a => a -> ShortcutFold (a, b) (Maybe b)

The b from the first tuple where a equals the given value, if any (tenacious)

Index

index :: Natural -> ShortcutFold a (Maybe a)

The nth input, where n=0 is the first input, if the index is in bounds (tenacious)

findIndex :: (a -> Bool) -> ShortcutFold a (Maybe Natural)

The index of the first input that satisfies the predicate, if any (tenacious)

elementIndex :: Eq a => a -> ShortcutFold a (Maybe Natural)

The index of the first input that matches the given value, if any (tenacious)

List

list :: ShortcutFold a [a]

All the inputs (ambivalent)

reverseList :: ShortcutFold a [a]

All the inputs in reverse order (ambivalent)

Conversion

fold :: Fold a b -> ShortcutFold a b

effectfulFold :: EffectfulFold Identity a b -> ShortcutFold a b

nonemptyFold :: NonemptyFold a b -> ShortcutFold a (Maybe b)

shortcutNonemptyFold :: ShortcutNonemptyFold a b -> ShortcutFold a (Maybe b)

Utilities

demotivate :: ShortcutFold a b -> ShortcutFold a b

Causes a shortcut fold to stop once it becomes ambivalent