com.mojang.datafixers

Enum FunctionType.Instance

java.lang.Object

java.lang.Enum<FunctionType.Instance>

com.mojang.datafixers.FunctionType.Instance

All Implemented Interfaces:

FunctionType.Instance.Mu<(_) -> _>, Kind2 (_) -> _, AffineP (_) -> _, Cartesian (_) -> _, Cocartesian (_) -> _, Mapping<(_) -> _,FunctionType.Instance.Mu>, Monoidal<(_) -> _,FunctionType.Instance.Mu>, MonoidProfunctor<(_) -> _,FunctionType.Instance.Mu>, Profunctor (_) -> _, TraversalP (_) -> _, Serializable, Comparable<FunctionType.Instance>

Enclosing interface:

FunctionType<A,B>

public static enum FunctionType.Instance
extends Enum<FunctionType.Instance>
implements TraversalP (_) -> _, MonoidProfunctor<(_) -> _,FunctionType.Instance.Mu>, Mapping<(_) -> _,FunctionType.Instance.Mu>, Monoidal<(_) -> _,FunctionType.Instance.Mu>

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
<A,B,C,D> ((A) -> B) -> (C) -> D	dimap((C) -> A g, (B) -> D h) Takes a function from the output type C to the input type A and a function from the input type B to the output type D, and returns a function from a container of A, B to a container of C, D.
(Void) -> Void	empty()
<A,B,C> ((A,C)) -> (B,C)	first((A) -> B input) Converts the given transformation into one that transforms the first type of a Pair.
<A,B,C> ((A|C)) -> (B|C)	left((A) -> B input) Converts the given transformation into one that transforms the left type of an Either.
<A,B,F extends K1> (F<A>) -> F<B>	mapping(Functor F functor, (A) -> B input)
<A,B,C,D> ((A,C)) -> (B,D)	par((A) -> B first, by-name (C) -> D second)
<A,B> (A) -> B	plus(Procompose<(A) -> ?C,(?C) -> B> input)
<A,B,C> ((C|A)) -> (C|B)	right((A) -> B input) Converts the given transformation into one that transforms the right type of an Either.
<A,B,C> ((C,A)) -> (C,B)	second((A) -> B input) Converts the given transformation into one that transforms the second type of a Pair.
static FunctionType.Instance	valueOf(String name) Returns the enum constant of this type with the specified name.
static FunctionType.Instance[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
<S,T,A,B> (S) -> T	wander(Wander<S::A,T::B> wander, (A) -> B input) Takes an operation defined by Wander and a transformation between field types, and produces a transformation between object types.
<A,B> (A) -> B	zero((A) -> B func)

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

compose

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

unbox

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

toFP3, traverse

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

toFP2

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

toFP

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

dimap, dimap, lmap, rmap

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

unbox

Enum Constant Detail

INSTANCE

public static final FunctionType.Instance INSTANCE

Method Detail

values

public static FunctionType.Instance[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FunctionType.Instance c : FunctionType.Instance.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FunctionType.Instance valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

dimap

public <A,B,C,D> ((A) -> B) -> (C) -> D dimap((C) -> A g,
                                              (B) -> D h)

Description copied from interface: Profunctor

Takes a function from the output type C to the input type A and a function from the input type B to the output type D, and returns a function from a container of A, B to a container of C, D.

A straightforward example of an implementation of dimap is the method Function.andThen(Function). For functions, the expression

 dimap(g, h).apply(f)
 

is equivalent to

 g.andThen(f).andThen(h)
 

Specified by:

dimap in interface Profunctor (_) -> _

Type Parameters:

A - The first input type.

B - The second input type.

C - The first output type.

D - The second output type.

Parameters:

g - A function from output to input.

h - A function from input to output.

Returns:

A function from an input container to an output container.

See Also:

Profunctor.dimap(App2, Function, Function)

first

public <A,B,C> ((A,C)) -> (B,C) first((A) -> B input)

Description copied from interface: Cartesian

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.

Specified by:

first in interface Cartesian (_) -> _

Specified by:

first in interface TraversalP (_) -> _

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

public <A,B,C> ((C,A)) -> (C,B) second((A) -> B input)

Description copied from interface: Cartesian

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.

Specified by:

second in interface Cartesian (_) -> _

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.

wander

public <S,T,A,B> (S) -> T wander(Wander<S::A,T::B> wander,
                                 (A) -> B input)

Description copied from interface: TraversalP

Takes an operation defined by Wander and a transformation between field types, and produces a transformation between object types.

The returned transformation should accept an object S, extract a field A, apply the given input, and return the resulting B via an output object T, all in the context of some effectful computation defined by the wander.

Specified by:

wander in interface TraversalP (_) -> _

Type Parameters:

S - The input object type.

T - The output object type.

A - The input field type.

B - The output field type.

Parameters:

wander - A mapping from effectful functions on the field types to effectful functions on the object types.

input - A (non-effectful) transformation between object types.

Returns:

A transformation between object types.

See Also:

Wander, Traversable

left

public <A,B,C> ((A|C)) -> (B|C) left((A) -> B input)

Description copied from interface: Cocartesian

Converts the given transformation into one that transforms the left type of an Either. The right type of the Either is left unchanged by the returned transformation.

Specified by:

left in interface Cocartesian (_) -> _

Specified by:

left in interface TraversalP (_) -> _

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 the left type of an Either.

right

public <A,B,C> ((C|A)) -> (C|B) right((A) -> B input)

Description copied from interface: Cocartesian

Converts the given transformation into one that transforms the right type of an Either. The left type of the Either is left unchanged by the returned transformation.

Specified by:

right in interface Cocartesian (_) -> _

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 the right type of an Either.

par

public <A,B,C,D> ((A,C)) -> (B,D) par((A) -> B first,
                                      by-name (C) -> D second)

Specified by:

par in interface Monoidal<(_) -> _,FunctionType.Instance.Mu>

empty

public (Void) -> Void empty()

Specified by:

empty in interface Monoidal<(_) -> _,FunctionType.Instance.Mu>

zero

public <A,B> (A) -> B zero((A) -> B func)

Specified by:

zero in interface MonoidProfunctor<(_) -> _,FunctionType.Instance.Mu>

plus

public <A,B> (A) -> B plus(Procompose<(A) -> ?C,(?C) -> B> input)

Specified by:

plus in interface MonoidProfunctor<(_) -> _,FunctionType.Instance.Mu>

mapping

public <A,B,F extends K1> (F<A>) -> F<B> mapping(Functor F functor,
                                                 (A) -> B input)

Specified by:

mapping in interface Mapping<(_) -> _,FunctionType.Instance.Mu>