blob: 7007325bdecc99c62dd837349cf9e1c5988a3822 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
/*
* esodata - data structures and other things, of varying utility
* Copyright 2022, Ben Culkin
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package bjc.funcdata.theory;
import java.util.function.Function;
/**
* Represents a container or context some sort usually, but the precise
* definition is that it represents exactly what it is defined as.
*
* @author ben
*
* @param <ContainedType>
* The value inside the functor.
*/
public interface Functor<ContainedType> {
/**
* Converts a normal function to operate over values in a functor..
*
* N.B: Even though the type signature implies that you can apply the resulting
* function to any type of functor, it is only safe to call it on instances of
* the type of functor you called fmap on..
*
* @param <ArgType>
* The argument of the function.
*
* @param <ReturnType>
* The return type of the function.
*
* @param func
* The function to convert.
*
* @return The passed in function converted to work over a particular type of
* functors.
*/
public <ArgType, ReturnType> Function<Functor<ArgType>, Functor<ReturnType>>
fmap(Function<ArgType, ReturnType> func);
/**
* Retrieve the thing inside this functor.
*
* @return The thing inside this functor.
*/
public ContainedType getValue();
}
|
