diff --git a/README.md b/README.md index 82e8b8a..f5ddd8e 100644 --- a/README.md +++ b/README.md @@ -18,42 +18,42 @@ This project provides: ## Type-class hierarchy
- Setoid Semigroup Foldable Functor Contravariant -(equals) (concat) (reduce) (map) (contramap) - | | \ / | | | | \ - | | \ / | | | | \ - | | \ / | | | | \ - | | \ / | | | | \ - | | \ / | | | | \ - Ord Monoid Traversable | | | | \ - (lte) (empty) (traverse) / | | \ \ - / | | \ \ - / / \ \ \ - Profunctor / \ Bifunctor \ - (promap) / \ (bimap) \ - / \ \ - / \ \ - Alt Apply Extend - (alt) (ap) (extend) - / / \ \ - / / \ \ - / / \ \ - / / \ \ - / / \ \ - Plus Applicative Chain Comonad - (zero) (of) (chain) (extract) - \ / \ / \ - \ / \ / \ - \ / \ / \ - \ / \ / \ - \ / \ / \ - Alternative Monad ChainRec - (chainRec) + Setoid Semigroupoid Semigroup Foldable Functor Contravariant +(equals) (compose) (concat) (reduce) (map) (contramap) + | | | \ / | | | | \ + | | | \ / | | | | \ + | | | \ / | | | | \ + | | | \ / | | | | \ + | | | \ / | | | | \ + Ord Category Monoid Traversable | | | | \ + (lte) (id) (empty) (traverse) / | | \ \ + / | | \ \ + / / \ \ \ + Profunctor / \ Bifunctor \ + (promap) / \ (bimap) \ + / \ \ + / \ \ + Alt Apply Extend + (alt) (ap) (extend) + / / \ \ + / / \ \ + / / \ \ + / / \ \ + / / \ \ + Plus Applicative Chain Comonad + (zero) (of) (chain) (extract) + \ / \ / \ + \ / \ / \ + \ / \ / \ + \ / \ / \ + \ / \ / \ + Alternative Monad ChainRec + (chainRec)## API -
TypeClass :: (String, Array TypeClass, a -> Boolean) -> TypeClass
TypeClass :: (String, Array TypeClass, a -> Boolean) -> TypeClass
Setoid :: TypeClass
Setoid :: TypeClass
Ord :: TypeClass
Ord :: TypeClass
Semigroup :: TypeClass
Semigroupoid :: TypeClass
Category :: TypeClass
Semigroup :: TypeClass
Monoid :: TypeClass
Monoid :: TypeClass
Functor :: TypeClass
Functor :: TypeClass
Bifunctor :: TypeClass
Bifunctor :: TypeClass
Profunctor :: TypeClass
Profunctor :: TypeClass
Apply :: TypeClass
Apply :: TypeClass
Applicative :: TypeClass
Applicative :: TypeClass
Chain :: TypeClass
Chain :: TypeClass
ChainRec :: TypeClass
ChainRec :: TypeClass
Monad :: TypeClass
Monad :: TypeClass
Alt :: TypeClass
Alt :: TypeClass
Plus :: TypeClass
Plus :: TypeClass
Alternative :: TypeClass
Alternative :: TypeClass
Foldable :: TypeClass
Foldable :: TypeClass
Traversable :: TypeClass
Traversable :: TypeClass
Extend :: TypeClass
Extend :: TypeClass
Comonad :: TypeClass
Comonad :: TypeClass
Contravariant :: TypeClass
Contravariant :: TypeClass
toString :: a -> String
toString :: a -> String
equals :: (a, b) -> Boolean
equals :: (a, b) -> Boolean
lt :: (a, b) -> Boolean
lt :: (a, b) -> Boolean
lte :: (a, b) -> Boolean
lte :: (a, b) -> Boolean
gt :: (a, b) -> Boolean
gt :: (a, b) -> Boolean
gte :: (a, b) -> Boolean
gte :: (a, b) -> Boolean
concat :: Semigroup a => (a, a) -> a
compose :: Semigroupoid c => (c j k, c i j) -> c i k
id :: Category c => TypeRep c -> c
concat :: Semigroup a => (a, a) -> a
empty :: Monoid m => TypeRep m -> m
empty :: Monoid m => TypeRep m -> m
map :: Functor f => (a -> b, f a) -> f b
map :: Functor f => (a -> b, f a) -> f b
bimap :: Bifunctor f => (a -> b, c -> d, f a c) -> f b d
bimap :: Bifunctor f => (a -> b, c -> d, f a c) -> f b d
promap :: Profunctor p => (a -> b, c -> d, p b c) -> p a d
promap :: Profunctor p => (a -> b, c -> d, p b c) -> p a d
ap :: Apply f => (f (a -> b), f a) -> f b
ap :: Apply f => (f (a -> b), f a) -> f b
lift2 :: Apply f => (a -> b -> c, f a, f b) -> f c
lift2 :: Apply f => (a -> b -> c, f a, f b) -> f c
lift3 :: Apply f => (a -> b -> c -> d, f a, f b, f c) -> f d
lift3 :: Apply f => (a -> b -> c -> d, f a, f b, f c) -> f d
apFirst :: Apply f => (f a, f b) -> f a
apFirst :: Apply f => (f a, f b) -> f a
apSecond :: Apply f => (f a, f b) -> f b
apSecond :: Apply f => (f a, f b) -> f b
of :: Applicative f => (TypeRep f, a) -> f a
of :: Applicative f => (TypeRep f, a) -> f a
chain :: Chain m => (a -> m b, m a) -> m b
chain :: Chain m => (a -> m b, m a) -> m b
join :: Chain m => m (m a) -> m a
join :: Chain m => m (m a) -> m a
chainRec :: ChainRec m => (TypeRep m, (a -> c, b -> c, a) -> m c, a) -> m b
chainRec :: ChainRec m => (TypeRep m, (a -> c, b -> c, a) -> m c, a) -> m b
filter :: (Applicative f, Foldable f, Monoid (f a)) => (a -> Boolean, f a) -> f a
filter :: (Applicative f, Foldable f, Monoid (f a)) => (a -> Boolean, f a) -> f a
filterM :: (Alternative m, Monad m) => (a -> Boolean, m a) -> m a
filterM :: (Alternative m, Monad m) => (a -> Boolean, m a) -> m a
alt :: Alt f => (f a, f a) -> f a
alt :: Alt f => (f a, f a) -> f a
zero :: Plus f => TypeRep f -> f a
zero :: Plus f => TypeRep f -> f a
reduce :: Foldable f => ((b, a) -> b, b, f a) -> b
reduce :: Foldable f => ((b, a) -> b, b, f a) -> b
traverse :: (Applicative f, Traversable t) => (TypeRep f, a -> f b, t a) -> f (t b)
traverse :: (Applicative f, Traversable t) => (TypeRep f, a -> f b, t a) -> f (t b)
sequence :: (Applicative f, Traversable t) => (TypeRep f, t (f a)) -> f (t a)
sequence :: (Applicative f, Traversable t) => (TypeRep f, t (f a)) -> f (t a)
extend :: Extend w => (w a -> b, w a) -> w b
extend :: Extend w => (w a -> b, w a) -> w b
extract :: Comonad w => w a -> a
extract :: Comonad w => w a -> a
contramap :: Contravariant f => (b -> a, f a) -> f b
contramap :: Contravariant f => (b -> a, f a) -> f b