cyclops

Class Optionals.Instances

java.lang.Object

cyclops.Optionals.Instances

Enclosing class:

Optionals

public static class Optionals.Instances
extends java.lang.Object

Companion class for creating Type Class instances for working with Optionals

Constructor Summary

Constructors

Constructor and Description
Instances()

Method Summary

Modifier and Type	Method and Description
static <T,R> Applicative<OptionalKind.µ>	applicative() import static com.aol.cyclops.hkt.jdk.OptionalKind.widen; import static com.aol.cyclops.util.function.Lambda.l1; import static java.util.Arrays.asOptional; Optionals.zippingApplicative() .ap(widen(asOptional(l1(this::multiplyByTwo))),widen(asOptional(1,2,3))); //[2,4,6]
static <T> Comonad<OptionalKind.µ>	comonad()
static <T> Foldable<OptionalKind.µ>	foldable() int sum = Optionals.foldable() .foldLeft(0, (a,b)->a+b, OptionalKind.widen(Arrays.asOptional(1,2,3,4))); //10
static <T,R> Functor<OptionalKind.µ>	functor() Transform a list, mulitplying every element by 2
static <T,R> Monad<OptionalKind.µ>	monad() import static com.aol.cyclops.hkt.jdk.OptionalKind.widen; OptionalKind<Integer> list = Optionals.monad() .flatMap(i->widen(OptionalX.range(0,i)), widen(Arrays.asOptional(1,2,3))) .convert(OptionalKind::narrowK);
static <T> MonadPlus<OptionalKind.µ>	monadPlus() OptionalKind<Integer> list = Optionals.<Integer>monadPlus() .plus(OptionalKind.widen(Arrays.asOptional()), OptionalKind.widen(Arrays.asOptional(10))) .convert(OptionalKind::narrowK); //Arrays.asOptional(10))
static <T> MonadPlus<OptionalKind.µ>	monadPlus(Monoid<OptionalKind<T>> m) Monoid<OptionalKind<Integer>> m = Monoid.of(OptionalKind.widen(Arrays.asOptional()), (a,b)->a.isEmpty() ? b : a); OptionalKind<Integer> list = Optionals.<Integer>monadPlus(m) .plus(OptionalKind.widen(Arrays.asOptional(5)), OptionalKind.widen(Arrays.asOptional(10))) .convert(OptionalKind::narrowK); //Arrays.asOptional(5))
static <T,R> MonadZero<OptionalKind.µ>	monadZero() OptionalKind<String> list = Optionals.unit() .unit("hello") .transform(h->Optionals.monadZero().filter((String t)->t.startsWith("he"), h)) .convert(OptionalKind::narrowK); //Arrays.asOptional("hello"));
static <C2,T> Traverse<OptionalKind.µ>	traverse()
static <T> Pure<OptionalKind.µ>	unit() OptionalKind<String> list = Optionals.unit() .unit("hello") .convert(OptionalKind::narrowK); //Arrays.asOptional("hello"))

Methods inherited from class java.lang.Object

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

Constructor Detail

Instances

public Instances()

Method Detail

functor

public static <T,R> Functor<OptionalKind.µ> functor()

Transform a list, mulitplying every element by 2

 
  OptionalKind<Integer> list = Optionals.functor().map(i->i*2, OptionalKind.widen(Arrays.asOptional(1,2,3));

  //[2,4,6]


 
 

An example fluent api working with Optionals

 
   OptionalKind<Integer> list = Optionals.unit()
        .unit("hello")
        .transform(h->Optionals.functor().map((String v) ->v.length(), h))
        .convert(OptionalKind::narrowK);

 
 

Returns:

A functor for Optionals

unit

public static <T> Pure<OptionalKind.µ> unit()

 
 OptionalKind<String> list = Optionals.unit()
        .unit("hello")
        .convert(OptionalKind::narrowK);

        //Arrays.asOptional("hello"))

 
 

Returns:

A factory for Optionals

applicative

public static <T,R> Applicative<OptionalKind.µ> applicative()

 
 import static com.aol.cyclops.hkt.jdk.OptionalKind.widen;
 import static com.aol.cyclops.util.function.Lambda.l1;
 import static java.util.Arrays.asOptional;

        Optionals.zippingApplicative()
        .ap(widen(asOptional(l1(this::multiplyByTwo))),widen(asOptional(1,2,3)));

 //[2,4,6]
 
 

Example fluent API

 
 OptionalKind<Function<Integer,Integer>> listFn =Optionals.unit()
                                                  .unit(Lambda.l1((Integer i) ->i*2))
                                                  .convert(OptionalKind::narrowK);

        OptionalKind<Integer> list = Optionals.unit()
        .unit("hello")
        .transform(h->Optionals.functor().map((String v) ->v.length(), h))
        .transform(h->Optionals.applicative().ap(listFn, h))
        .convert(OptionalKind::narrowK);

        //Arrays.asOptional("hello".length()*2))

 
 

Returns:

A zipper for Optionals

monad

public static <T,R> Monad<OptionalKind.µ> monad()

 
 import static com.aol.cyclops.hkt.jdk.OptionalKind.widen;
 OptionalKind<Integer> list  = Optionals.monad()
        .flatMap(i->widen(OptionalX.range(0,i)), widen(Arrays.asOptional(1,2,3)))
        .convert(OptionalKind::narrowK);
 
 

Example fluent API

 
    OptionalKind<Integer> list = Optionals.unit()
        .unit("hello")
        .transform(h->Optionals.monad().flatMap((String v) ->Optionals.unit().unit(v.length()), h))
        .convert(OptionalKind::narrowK);

        //Arrays.asOptional("hello".length())

 
 

Returns:

Type class with monad functions for Optionals

monadZero

public static <T,R> MonadZero<OptionalKind.µ> monadZero()

 
  OptionalKind<String> list = Optionals.unit()
        .unit("hello")
        .transform(h->Optionals.monadZero().filter((String t)->t.startsWith("he"), h))
        .convert(OptionalKind::narrowK);

        //Arrays.asOptional("hello"));

 
 

Returns:

A filterable monad (with default value)

monadPlus

public static <T> MonadPlus<OptionalKind.µ> monadPlus()

 
  OptionalKind<Integer> list = Optionals.<Integer>monadPlus()
        .plus(OptionalKind.widen(Arrays.asOptional()), OptionalKind.widen(Arrays.asOptional(10)))
        .convert(OptionalKind::narrowK);
        //Arrays.asOptional(10))

 
 

Returns:

Type class for combining Optionals by concatenation

monadPlus

public static <T> MonadPlus<OptionalKind.µ> monadPlus(Monoid<OptionalKind<T>> m)

 
  Monoid<OptionalKind<Integer>> m = Monoid.of(OptionalKind.widen(Arrays.asOptional()), (a,b)->a.isEmpty() ? b : a);
        OptionalKind<Integer> list = Optionals.<Integer>monadPlus(m)
        .plus(OptionalKind.widen(Arrays.asOptional(5)), OptionalKind.widen(Arrays.asOptional(10)))
        .convert(OptionalKind::narrowK);
        //Arrays.asOptional(5))

 
 

Parameters:

m - Monoid to use for combining Optionals

Returns:

Type class for combining Optionals

traverse

public static <C2,T> Traverse<OptionalKind.µ> traverse()

Returns:

Type class for traversables with traverse / sequence operations

foldable

public static <T> Foldable<OptionalKind.µ> foldable()

 
 int sum  = Optionals.foldable()
        .foldLeft(0, (a,b)->a+b, OptionalKind.widen(Arrays.asOptional(1,2,3,4)));

        //10

 
 

Returns:

Type class for folding / reduction operations

comonad

public static <T> Comonad<OptionalKind.µ> comonad()