Liking cljdoc? Tell your friends :D

cats.protocols

A collection of protocols upon which the cats abstractions are built.

NOTE: Functions of this namespace are not intended to be used directly. It is considered internal api.

A collection of protocols upon which the cats abstractions are built.

NOTE: Functions of this namespace are not intended to be used directly.
It is considered internal api.
raw docstring

Applicativeclj/s≠protocol

The Applicative abstraction.

The Applicative abstraction.

-fapplyclj/s

(-fapply app af av)

Applies the function(s) inside af's context to the value(s) inside av's context while preserving the context.

Applies the function(s) inside af's context to the value(s)
inside av's context while preserving the context.

-pureclj/s

(-pure app v)

Takes any context or monadic value app and any value v, and puts the value v in the most minimal context (normally mempty) of same type of app

Takes any context or monadic value `app` and any value `v`, and puts
the value `v` in the most minimal context (normally `mempty`) of same type of `app`
sourceraw docstring

Bifunctorclj/s≠protocol

A 'Functor' of two arguments.

A 'Functor' of two arguments.

-bimapclj/s

(-bimap btor f g bv)

Map over both arguments at the same time.

Map over both arguments at the same time.
sourceraw docstring

Contextclj/sprotocol

A marker protocol for identifying the valid context types.

A marker protocol for identifying the valid context types.
sourceraw docstring

Contextualclj/s≠protocol

Abstraction that establishes a concrete type as a member of a context.

A great example is the Maybe monad type Just. It implements this abstraction to establish that Just is part of the Maybe monad.

Abstraction that establishes a concrete type as a member of a context.

A great example is the Maybe monad type Just. It implements
this abstraction to establish that Just is part of
the Maybe monad.

-get-contextclj/s

(-get-context _)

Get the context associated with the type.

Get the context associated with the type.
sourceraw docstring

Extractclj/s≠protocol

A type class to extract the value from a monad context.

A type class to extract the
value from a monad context.

-extractclj/s

(-extract mv)

Extract the value from monad context.

Extract the value from monad context.
sourceraw docstring

Foldableclj/s≠protocol

Abstraction of data structures that can be folded to a summary value.

Abstraction of data structures that can be folded to a summary value.

-foldlclj/s

(-foldl fctx f z xs)

Left-associative fold of a structure.

Left-associative fold of a structure.

-foldrclj/s

(-foldr fctx f z xs)

Right-associative fold of a structure.

Right-associative fold of a structure.
sourceraw docstring

Functorclj/s≠protocol

A data type that can be mapped over without altering its context.

A data type that can be mapped over without altering its context.

-fmapclj/s

(-fmap ftor f fv)

Applies function f to the value(s) inside the context of the functor fv.

Applies function f to the value(s) inside the context of the functor fv.
sourceraw docstring

Monadclj/s≠protocol

The Monad abstraction.

The Monad abstraction.

-mbindclj/s

(-mbind m mv f)

-mreturnclj/s

(-mreturn m v)
sourceraw docstring

MonadPlusclj/s≠protocol

A complement abstraction for Monad that supports the notion of addition.

A complement abstraction for Monad that
supports the notion of addition.

-mplusclj/s

(-mplus m mv mv')

An associative addition operation.

An associative addition operation.
sourceraw docstring

MonadZeroclj/s≠protocol

A complement abstraction for monad that supports the notion of an identity element.

A complement abstraction for monad that
supports the notion of an identity element.

-mzeroclj/s

(-mzero m)

The identity element for the given monadzero.

The identity element for the given monadzero.
sourceraw docstring

Monoidclj/s≠protocol

A Semigroup which has an identity element with respect to an associative binary operation.

A Semigroup which has an identity element with respect to an associative binary operation.

-memptyclj/s

(-mempty s)

The identity element for the given monoid.

The identity element for the given monoid.
sourceraw docstring

Printableclj/s≠protocol

An abstraction to make a type printable in a platform independent manner.

An abstraction to make a type printable in a platform
independent manner.

-reprclj/s

(-repr _)

Get the repl ready representation of the object.

Get the repl ready representation of the object.
sourceraw docstring

Semigroupclj/s≠protocol

A structure with an associative binary operation.

A structure with an associative binary operation.

-mappendclj/s

(-mappend s sv sv')

An associative addition operation.

An associative addition operation.
sourceraw docstring

Traversableclj/s≠protocol

Abstraction of data structures that can be traversed from left to right performing an action on every element.

Abstraction of data structures that can be traversed from left to right
performing an action on every element.

-traverseclj/s

(-traverse tctx f tv)

Map each element to an Applicative, evaluate the applicatives from left to right and collect the results.

Map each element to an Applicative, evaluate the applicatives from left
to right and collect the results.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close