com.mojang.datafixers.kinds

Interface CartesianLike<T extends K1,C,Mu extends CartesianLike _>

Type Parameters:

T - The partially applied product type.

C - The other type of interest in the product type.

Mu - The witness type of this functor.

All Superinterfaces:

Mu<T>, Functor T, Kind1 T, Traversable T

All Known Implementing Classes:

Pair.Instance

public interface CartesianLike<T extends K1,C,Mu extends CartesianLike _>
extends Functor T, Traversable T

A Traversable functor that operates on a product type, such as a tuple. This type class defines two methods, from(App) and to(App), that convert the type T to and from a Pair.

Type Shape:

%.Type. %0

See Also:

Cartesian

Method Summary

Modifier and Type	Method and Description
<A> T<A>	from((A,C) input) Transforms a pair of (A, C) into a container of A and C.
<A> (A,C)	to(T<A> input) Transforms a container of types A and C into a Pair of (A, C).
default <F extends K1,A,B> F<T<B>>	traverse(Applicative F applicative, (A) -> F<B> function, T<A> input) Applies a function that produces an Applicative effect to each value contained within input, then builds a container with an equivalent structure containing the (unboxed) results.

Methods inherited from interface com.mojang.datafixers.kinds.Traversable

flip

Methods inherited from interface com.mojang.datafixers.kinds.Functor

map

Methods inherited from interface com.mojang.datafixers.kinds.Kind1

group, group, group, group, group, group, group, group, group, group, group, group, group, group, group, group

Method Detail

to

<A> (A,C) to(T<A> input)

Transforms a container of types A and C into a Pair of (A, C).

Type Parameters:

A - The type of the value stored in the container.

Parameters:

input - The input container.

Returns:

A pair containing the values stored in the container.

from

<A> T<A> from((A,C) input)

Transforms a pair of (A, C) into a container of A and C.

Type Parameters:

A - The type of value stored in the pair.

Parameters:

input - The input pair.

Returns:

A container of the values in the pair.

traverse

default <F extends K1,A,B> F<T<B>> traverse(Applicative F applicative,
                                            (A) -> F<B> function,
                                            T<A> input)

Description copied from interface: Traversable

Applies a function that produces an Applicative effect to each value contained within input, then builds a container with an equivalent structure containing the (unboxed) results.

Specified by:

traverse in interface Traversable T extends K1

Type Parameters:

F - The type of the effect.

A - The input type.

B - The output type.

Parameters:

applicative - An instance of the Applicative type class which defines the behavior of F.

function - The function to apply.

input - The input container.

Returns:

A container holding the results of applying function to each element, if the function was successful for every element.