Safe Haskell	Safe-Inferred
Language	Haskell2010

PlutusCore.StdLib.Data.List

Description

Built-in list and related functions.

Synopsis

list ∷ uni `HasTypeLevel` List ⇒ Type tyname uni ()
data MatchOption
- = UseChoose
- | UseCase
matchList ∷ TermLike term TyName Name DefaultUni DefaultFun ⇒ MatchOption → term ()
foldrList ∷ TermLike term TyName Name DefaultUni DefaultFun ⇒ MatchOption → term ()
foldList ∷ TermLike term TyName Name DefaultUni DefaultFun ⇒ MatchOption → term ()
sum ∷ TermLike term TyName Name DefaultUni DefaultFun ⇒ MatchOption → term ()
sumr ∷ TermLike term TyName Name DefaultUni DefaultFun ⇒ MatchOption → term ()
product ∷ TermLike term TyName Name DefaultUni DefaultFun ⇒ MatchOption → term ()

Documentation

list ∷ uni `HasTypeLevel` List ⇒ Type tyname uni () Source #

[] as a built-in PLC type.

data MatchOption Source #

Allows one to choose which way of doing pattern matching on built-in types to use: either via ChooseList-like builtins or via CaseList-like ones.

Constructors

UseChoose
UseCase

Instances

Instances details

Bounded MatchOption Source #
Instance details Defined in PlutusCore.StdLib.Data.MatchOption Methods minBound ∷ MatchOption Source # maxBound ∷ MatchOption Source #
Enum MatchOption Source #
Instance details Defined in PlutusCore.StdLib.Data.MatchOption Methods succ ∷ MatchOption → MatchOption Source # pred ∷ MatchOption → MatchOption Source # toEnum ∷ Int → MatchOption Source # fromEnum ∷ MatchOption → Int Source # enumFrom ∷ MatchOption → [MatchOption] Source # enumFromThen ∷ MatchOption → MatchOption → [MatchOption] Source # enumFromTo ∷ MatchOption → MatchOption → [MatchOption] Source # enumFromThenTo ∷ MatchOption → MatchOption → MatchOption → [MatchOption] Source #
Show MatchOption Source #
Instance details Defined in PlutusCore.StdLib.Data.MatchOption Methods showsPrec ∷ Int → MatchOption → ShowS Source # show ∷ MatchOption → String Source # showList ∷ [MatchOption] → ShowS Source #
Eq MatchOption Source #
Instance details Defined in PlutusCore.StdLib.Data.MatchOption Methods (==) ∷ MatchOption → MatchOption → Bool Source # (/=) ∷ MatchOption → MatchOption → Bool Source #

matchList ∷ TermLike term TyName Name DefaultUni DefaultFun ⇒ MatchOption → term () Source #

Pattern matching on built-in lists. matchList {a} xs on built-in lists is equivalent to unwrap xs on lists defined in PLC itself (hence why we bind r after xs).

Either

/\(a :: *) -> \(xs : list a) -> /\(r :: *) -> (z : r) (f : a -> list a -> r) ->
    matchList
        {a}
        {r}
        z
        f
        xs

or

/\(a :: *) -> \(xs : list a) -> /\(r :: *) -> (z : r) (f : a -> list a -> r) ->
    chooseList
        {a}
        {() -> r}
        xs
        (\(u : ()) -> z)
        (\(u : ()) -> f (head {a} xs) (tail {a} xs))
        ()

depending on the MatchOption argument.

foldrList ∷ TermLike term TyName Name DefaultUni DefaultFun ⇒ MatchOption → term () Source #

foldr over built-in lists.

/\(a :: *) (r :: *) -> \(f : a -> r -> r) (z : r) ->
    fix {list a} {r} \(rec : list a -> r) (xs : list a) ->
        matchList {a} xs {r} z \(x : a) (xs' : list a) -> f x (rec xs')

foldList ∷ TermLike term TyName Name DefaultUni DefaultFun ⇒ MatchOption → term () Source #

'foldl'' as a PLC term.

/\(a :: *) (r :: *) -> \(f : r -> a -> r) ->
    fix {r} {list a -> r} \(rec : r -> list a -> r) (z : r) (xs : list a) ->
        matchList {a} xs {r} z \(x : a) (xs' : list a) -> rec (f z x) xs'

sum ∷ TermLike term TyName Name DefaultUni DefaultFun ⇒ MatchOption → term () Source #

sumr ∷ TermLike term TyName Name DefaultUni DefaultFun ⇒ MatchOption → term () Source #

product ∷ TermLike term TyName Name DefaultUni DefaultFun ⇒ MatchOption → term () Source #

product as a PLC term.

foldList {integer} {integer} multiplyInteger 1