blob: b0cb76f5c1ebcdea47a8cbf48ac728531936f3af (
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
|
/*
* 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.bst;
/**
* Represents a function for doing a directed walk of a binary tree.
*
* @author ben
*
* @param <T>
* The type of element stored in the walked tree
*/
@FunctionalInterface
public interface DirectedWalkFunction<T> {
/**
* Represents the results used to direct a walk in a binary tree.
*
* @author ben
*/
public enum DirectedWalkResult {
/** Specifies that the function has failed. */
FAILURE,
/**
* Specifies that the function wants to move left in the tree next.
*/
LEFT,
/**
* Specifies that the function wants to move right in the tree next.
*/
RIGHT,
/** Specifies that the function has succesfully completed */
SUCCESS
}
/**
* Perform a directed walk on a node of a tree.
*
* @param element
* The data stored in the node currently being visited.
*
* @return The way the function wants the walk to go next.
*/
public DirectedWalkResult walk(T element);
}
|
