Fold.ShortcutNonempty

Type

data ShortcutNonemptyFold a b

Processes at least one input of type a, has the ability to halt midway through the stream, and results in a value of type b

Constructors

forall x y. ShortcutNonemptyFold

Fields

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

Instances

Applicative (ShortcutNonemptyFold a)

Defined in Fold.ShortcutNonempty.Type

Methods

pure :: a0 -> ShortcutNonemptyFold a a0

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

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

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

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

Functor (ShortcutNonemptyFold a)

Defined in Fold.ShortcutNonempty.Type

Methods

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

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

Monoid b => Monoid (ShortcutNonemptyFold a b)

Defined in Fold.ShortcutNonempty.Type

Methods

mempty :: ShortcutNonemptyFold a b

mappend :: ShortcutNonemptyFold a b -> ShortcutNonemptyFold a b -> ShortcutNonemptyFold a b

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

Semigroup b => Semigroup (ShortcutNonemptyFold a b)

Defined in Fold.ShortcutNonempty.Type

Methods

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

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

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

Run

run :: ShortcutNonemptyFold a b -> NonEmpty a -> b

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

Examples

General

magma :: (a -> a -> a) -> ShortcutNonemptyFold a a

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

semigroup :: Semigroup a => ShortcutNonemptyFold a a

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

monoid :: Monoid a => ShortcutNonemptyFold a a

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

Endpoints

first :: ShortcutNonemptyFold a a

The first input (tenacious)

last :: ShortcutNonemptyFold a a

The last input (ambivalent)

Extrema

maximum :: Ord a => ShortcutNonemptyFold a a

The greatest input (ambivalent)

minimum :: Ord a => ShortcutNonemptyFold a a

The least input (ambivalent)

maximumBy :: (a -> a -> Ordering) -> ShortcutNonemptyFold a a

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

minimumBy :: (a -> a -> Ordering) -> ShortcutNonemptyFold a a

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

Length

length :: ShortcutNonemptyFold a Natural

The number of inputs (ambivalent)

Boolean

and :: ShortcutNonemptyFold Bool Bool

True if all inputs are True (tenacious)

or :: ShortcutNonemptyFold Bool Bool

True if any input is True (tenacious)

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

True if all inputs satisfy the predicate (tenacious)

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

True if any input satisfies the predicate (tenacious)

Numeric

sum :: Num a => ShortcutNonemptyFold a a

Adds the inputs (ambivalent)

product :: Num a => ShortcutNonemptyFold a a

Multiplies the inputs (ambivalent)

mean :: Fractional a => ShortcutNonemptyFold a a

Numerically stable arithmetic mean of the inputs (ambivalent)

variance :: Fractional a => ShortcutNonemptyFold a a

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

standardDeviation :: Floating a => ShortcutNonemptyFold a a

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

Search

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

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

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

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

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

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

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

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

Index

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

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

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

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

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

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

List

list :: ShortcutNonemptyFold a [a]

All the inputs (ambivalent)

reverseList :: ShortcutNonemptyFold a [a]

All the inputs in reverse order (ambivalent)

Conversion

fold :: Fold a b -> ShortcutNonemptyFold a b

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

nonemptyFold :: NonemptyFold a b -> ShortcutNonemptyFold a b

shortcutFold :: ShortcutFold a b -> ShortcutNonemptyFold a b

Utilities

demotivate :: ShortcutNonemptyFold a b -> ShortcutNonemptyFold a b

Causes a shortcut fold to stop once it becomes ambivalent