com.aol.cyclops2.types

Interface BiFunctor<T1,T2>

All Known Subinterfaces:

Either<ST,PT>, Either3<LT1,LT2,RT>, Either4<LT1,LT2,LT3,RT>, Either5<LT1,LT2,LT3,LT4,RT>, Ior<ST,PT>, MapX<K,V>, PMapX<K,V>, Xor<ST,PT>

All Known Implementing Classes:

Either.Lazy, Either.Left, Either.Right, Either3.Lazy, Either3.Left1, Either3.Left2, Either3.Right, Either4.Lazy, Either4.Left1, Either4.Left2, Either4.Left3, Either4.Right, Either5.Lazy, Either5.Left1, Either5.Left2, Either5.Left3, Either5.Left4, Either5.Right, Ior.Both, Ior.Primary, Ior.Secondary, MapXImpl, PMapXImpl, Xor.Primary, Xor.Secondary

public interface BiFunctor<T1,T2>

Method Summary

Modifier and Type	Method and Description
default <U1,U2> BiFunctor<U1,U2>	bicast(java.lang.Class<U1> type1, java.lang.Class<U2> type2) Cast two data types simulatanously.
<R1,R2> BiFunctor<R1,R2>	bimap(java.util.function.Function<? super T1,? extends R1> fn1, java.util.function.Function<? super T2,? extends R2> fn2) Transform this BiFunctor, changing two value types at once.
default BiFunctor<T1,T2>	bipeek(java.util.function.Consumer<? super T1> c1, java.util.function.Consumer<? super T2> c2) Peek at two data types simulatanously (typically to perform a side-effect with each data point)
default <R1,R2> BiFunctor<R1,R2>	bitrampoline(java.util.function.Function<? super T1,? extends Trampoline<? extends R1>> mapper1, java.util.function.Function<? super T2,? extends Trampoline<? extends R2>> mapper2) Perform a tail-call optimized recursive transformation operation across two data points simultaneously

Method Detail

bimap

<R1,R2> BiFunctor<R1,R2> bimap(java.util.function.Function<? super T1,? extends R1> fn1,
                               java.util.function.Function<? super T2,? extends R2> fn2)

Transform this BiFunctor, changing two value types at once.

 
     MapX<String,Integer> map = MapXs.of("hello",2);
     MapX<String,Integer> transformedMap = map.bimap(s->s+" world",i->i*4);
     //["hello world",8]
 
 

Parameters:

fn1 - transformation function for the first type

fn2 - transformation function for the second type

Returns:

New BiFunctor containing transformed data

bipeek

default BiFunctor<T1,T2> bipeek(java.util.function.Consumer<? super T1> c1,
                                java.util.function.Consumer<? super T2> c2)

Peek at two data types simulatanously (typically to perform a side-effect with each data point)

 
     MapX<String,Integer> map = MapXs.of("hello",2);
     map.bipeek(s->System.out.pritnln("key = " + s),System.out::println);
 
 

Parameters:

c1 - consumer for the first type

c2 - consumer for the second type

Returns:

New BiFunctor with the same data

bicast

default <U1,U2> BiFunctor<U1,U2> bicast(java.lang.Class<U1> type1,
                                        java.lang.Class<U2> type2)

Cast two data types simulatanously.

 
     MapX<Animal,Food> map = MapXs.of(cow,grass);
     MapX<Mamaml,Vegitation> herbervoreMammals = map.bicast(Mammal.class,Vegitation.class);
 
 

Parameters:

type1 -

type2 -

Returns:

bitrampoline

default <R1,R2> BiFunctor<R1,R2> bitrampoline(java.util.function.Function<? super T1,? extends Trampoline<? extends R1>> mapper1,
                                              java.util.function.Function<? super T2,? extends Trampoline<? extends R2>> mapper2)

Perform a tail-call optimized recursive transformation operation across two data points simultaneously

Parameters:

mapper1 - transformation function for the first type

mapper2 - transformation function for the second type

Returns:

New BiFunctor containing transformed data