com.mojang.datafixers.kinds

Interface Functor<F extends K1,Mu extends Functor _>

Type Parameters:

F - The container type.

Mu - The witness type of this functor.

All Superinterfaces:

Mu<F>, Kind1 F

All Known Subinterfaces:

Applicative<F,Mu>, CartesianLike<T,C,Mu>, CocartesianLike<T,C,Mu>, Representable<T,C,Mu>, Traversable<T,Mu>

All Known Implementing Classes:

Const.Instance, DataResult.Instance, Either.Instance, FunctionType.ReaderInstance, IdF.Instance, ListBox.Instance, OptionalBox.Instance, Pair.Instance, RecordCodecBuilder.Instance

public interface Functor<F extends K1,Mu extends Functor _>
extends Kind1 F

The functor type class defines one method, map(Function, App), which transforms the contents of a container to another type.

In order to be a lawful functor, the implementation of map(Function, App) must satisfy the following requirements (== represents logical equality and not reference equality).

1. map(identity(), ft) = ft - Mapping with the identity function yields the input.
2. map(f.compose(g), ft) = map(f, map(g, ft)) - Mapping can be distributed over function composition.

Functors which do not satisfy these laws are said to be either neutral or chaotic, depending on the degree to which the laws are violated.

Type Shape:

%.Type. %0

See Also:

The functor type class

Method Summary

Modifier and Type	Method and Description
<T,R> F<R>	map((? super T) -> ? extends R func, F<T> ts) Maps the contents of ts from T to R using the func.

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

map

<T,R> F<R> map((? super T) -> ? extends R func,
               F<T> ts)

Maps the contents of ts from T to R using the func.

Implementation Requirements:

This method must obey the functor laws in order for this functor to be be lawful.

Type Parameters:

T - The input type.

R - The output type.

Parameters:

func - The transformation function.

ts - The input container that will be transformed.

Returns:

The transformed container.