cyclops.typeclasses.instances

Class General.GeneralMonadZero<CRE,A,B>

java.lang.Object

cyclops.typeclasses.instances.General.GeneralMonadZero<CRE,A,B>

All Implemented Interfaces:

Filterable<CRE>, Functor<CRE>, Applicative<CRE>, Monad<CRE>, MonadZero<CRE>, Pure<CRE>

Enclosing interface:

General

public static class General.GeneralMonadZero<CRE,A,B>
extends java.lang.Object
implements MonadZero<CRE>

Constructor Summary

Constructors

Constructor and Description
GeneralMonadZero()

Method Summary

Modifier and Type	Method and Description
<T,R> Higher<CRE,R>	ap(Higher<CRE,? extends java.util.function.Function<T,R>> fn, Higher<CRE,T> apply)
<T,R> Higher<CRE,R>	flatMap(java.util.function.Function<? super T,? extends Higher<CRE,R>> fn, Higher<CRE,T> ds)
<T,R> Higher<CRE,R>	map(java.util.function.Function<? super T,? extends R> fn, Higher<CRE,T> ds) Transform the supplied data structure using the supplied transformation function
<T> Higher<CRE,T>	unit(T value) Create a new instance of the core type (e.g.
Higher<CRE,?>	zero() e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface cyclops.typeclasses.monad.MonadZero

filter, narrowZero

Methods inherited from interface cyclops.typeclasses.monad.Monad

flatten, mapM, replicate, sequence, traverse

Methods inherited from interface cyclops.typeclasses.monad.Applicative

ap2, ap3, apBiFn, curry2, narrow, narrow2, narrow3, narrowBiFn

Methods inherited from interface cyclops.typeclasses.functor.Functor

lift, mapRev, peek

Constructor Detail

GeneralMonadZero

public GeneralMonadZero()

Method Detail

zero

public Higher<CRE,?> zero()

Description copied from interface: MonadZero

e.g. for Optional we can use Optional.empty()

Specified by:

zero in interface MonadZero<CRE>

Returns:

Identity value or zero value for the HKT type, the generic type is unknown

flatMap

public <T,R> Higher<CRE,R> flatMap(java.util.function.Function<? super T,? extends Higher<CRE,R>> fn,
                                   Higher<CRE,T> ds)

Specified by:

flatMap in interface Monad<CRE>

ap

public <T,R> Higher<CRE,R> ap(Higher<CRE,? extends java.util.function.Function<T,R>> fn,
                              Higher<CRE,T> apply)

Specified by:

ap in interface Applicative<CRE>

map

public <T,R> Higher<CRE,R> map(java.util.function.Function<? super T,? extends R> fn,
                               Higher<CRE,T> ds)

Description copied from interface: Functor

Transform the supplied data structure using the supplied transformation function

  
  ListX<Integer> listx = ListX.of(1,2,3);
        ListType<Integer> mapped1 =Lists.functor().map(a->a+1, ListType.widen(listx));
        mapped1.add(1);
        ListX<Integer> listxMapped = mapped1.list();
 
 

Specified by:

map in interface Functor<CRE>

Parameters:

fn - Transformation function

ds - Datastructure to transform

Returns:

unit

public <T> Higher<CRE,T> unit(T value)

Description copied from interface: Pure

Create a new instance of the core type (e.g. a List or CompletableFuture) that is HKT encoded

Specified by:

unit in interface Pure<CRE>

Parameters:

value - To populate new instance of

Returns:

HKT encoded new instance with supplied value