com.mojang.datafixers.optics.profunctors

Interface Cartesian<P extends K2,Mu extends Cartesian _>

Type Parameters:

P - The transformation type.

Mu - The witness type for this profunctor.

All Superinterfaces:

Mu<P>, Kind2 P, Profunctor P

All Known Subinterfaces:

AffineP<P,Mu>, Mapping<P,Mu>, TraversalP<P,Mu>

All Known Implementing Classes:

Affine.Instance, Forget.Instance, ForgetOpt.Instance, FunctionType.Instance, Lens.Instance, ReForgetC.Instance, Traversal.Instance

public interface Cartesian<P extends K2,Mu extends Cartesian _>
extends Profunctor P

A profunctor that supports converting a transformation acting on some type to and from a transformation acting on pairs holding that type. This allows one to add a "pass-through" value to the type transformed via the profunctor that is left untransformed.

Type Shape:

%.Type. %0

Method Summary

Modifier and Type	Method and Description
<A,B,C> P<(A,C),(B,C)>	first(P<A,B> input) Converts the given transformation into one that transforms the first type of a Pair.
default <A,B,C> P<(C,A),(C,B)>	second(P<A,B> input) Converts the given transformation into one that transforms the second type of a Pair.
default FunctorProfunctor<CartesianLike _> P	toFP2() Converts this profunctor into a FunctorProfunctor that distributes CartesianLike functors.

Methods inherited from interface com.mojang.datafixers.optics.profunctors.Profunctor

dimap, dimap, dimap, lmap, rmap

Method Detail

first

<A,B,C> P<(A,C),(B,C)> first(P<A,B> input)

Converts the given transformation into one that transforms the first type of a Pair. The second type is not transformed - any values of that type are passed through the returned transformation unchanged.

Type Parameters:

A - The input type.

B - The output type.

C - A "pass-through" type that is not transformed.

Parameters:

input - The transformation.

Returns:

A transformation on pairs, where the first type is transformed and the second is not.

second

default <A,B,C> P<(C,A),(C,B)> second(P<A,B> input)

Converts the given transformation into one that transforms the second type of a Pair. The first type is not transformed - any values of that type are passed through the returned transformation unchanged.

Implementation Requirements:

The default implementation calls first(App2) and swaps the order of the types in the Pair.

Type Parameters:

A - The input type.

B - The output type.

C - A "pass-through" type that is not transformed.

Parameters:

input - The transformation.

Returns:

A transformation on pairs, where the second type is transformed and the first is not.

toFP2

default FunctorProfunctor<CartesianLike _> P toFP2()

Converts this profunctor into a FunctorProfunctor that distributes CartesianLike functors.