Uses of Class
gametree.MetricKeeper

Packages that use MetricKeeper

Package	Description
algorithm	Search techniques based on B* and various utility classes used primarily by these search techniques.
gametree	Various classes for storing and generating game trees for the use by algorithms and tree visualisation.
test	Various unit tests for maintaining basic functionality of several classes in other packages.
visualizer	Utilitiy classes specifically for visualising game trees using the command prompt or by generating figures with XML.

Uses of MetricKeeper in algorithm

Fields in algorithm declared as MetricKeeper

Modifier and Type	Field	Description
final MetricKeeper	BstarSquaredDB.L1Position.Settings.L1_metrics
final MetricKeeper	BstarSquaredSimple.L1Position.Settings.L1_metrics
final MetricKeeper	BstarSquaredSimpleMax.L1Position.Settings.L1_metrics
final MetricKeeper	BstarSquaredVariant.L1Position.Settings.L1_metrics
final MetricKeeper	BstarSquaredDB.L1Position.Settings.L2_metrics
final MetricKeeper	BstarSquaredSimple.L1Position.Settings.L2_metrics
final MetricKeeper	BstarSquaredSimpleMax.L1Position.Settings.L2_metrics
final MetricKeeper	BstarSquaredVariant.L1Position.Settings.L2_metrics
final MetricKeeper[]	BstarSquaredDB.L1Position.Settings.other_metrics
final MetricKeeper[]	BstarSquaredSimple.L1Position.Settings.other_metrics
final MetricKeeper[]	BstarSquaredSimpleMax.L1Position.Settings.other_metrics
final MetricKeeper[]	BstarSquaredVariant.L1Position.Settings.other_metrics
final MetricKeeper	BstarSquaredDB.L1Position.Settings.true_metrics
final MetricKeeper	BstarSquaredSimple.L1Position.Settings.true_metrics
final MetricKeeper	BstarSquaredSimpleMax.L1Position.Settings.true_metrics
final MetricKeeper	BstarSquaredVariant.L1Position.Settings.true_metrics

Methods in algorithm that return MetricKeeper

Modifier and Type	Method	Description
MetricKeeper	SearchAlgorithm.SearchResult.mainMetrics()
MetricKeeper[]	SearchAlgorithm.SearchResult.metrics()	Returns the value of the metrics record component.

Methods in algorithm with parameters of type MetricKeeper

Modifier and Type	Method	Description
double	StrategyFunction.HeuristicFunction.evaluate(GameTreeNode<?,?> node, boolean maximising, MetricKeeper... metrics)
static <N extends GameTreeNode<N,P>, P extends IGamePosition<P>> void	SearchAlgorithm.expand_tree_simple(N node, int depth, MetricKeeper... metrics)	Expands the search tree without stopping condition.
boolean	SearchAlgorithm.Limits.reached(MetricKeeper metrics)
boolean	SearchAlgorithm.Limits.reachedAll(MetricKeeper... metrics)
boolean	SearchAlgorithm.Limits.reachedAny(MetricKeeper... metrics)
boolean	SearchAlgorithm.Limits.reachedEvaluations(MetricKeeper metrics)
boolean	SearchAlgorithm.Limits.reachedExpansions(MetricKeeper metrics)
boolean	SearchAlgorithm.Limits.reachedNodes(MetricKeeper metrics)
boolean	SearchAlgorithm.Limits.reachedSum(MetricKeeper... metrics)
<P extends IGamePosition<P>> SearchAlgorithm.SearchResult<?,P>	BstarBasic.search(P root, Duration time_limit, SearchAlgorithm.Limits space_limit, MetricKeeper... metrics)
<P extends IGamePosition<P>> SearchAlgorithm.SearchResult<?,P>	BstarBasicDB.search(P root, Duration time_limit, SearchAlgorithm.Limits space_limit, MetricKeeper... metrics)
<P extends IGamePosition<P>> SearchAlgorithm.SearchResult<?,P>	BstarSquaredDB.search(P root, Duration time_limit, SearchAlgorithm.Limits space_limit, MetricKeeper... metrics)
<P extends IGamePosition<P>> SearchAlgorithm.SearchResult<?,P>	BstarSquaredSimple.search(P root, Duration time_limit, SearchAlgorithm.Limits space_limit, MetricKeeper... metrics)
<P extends IGamePosition<P>> SearchAlgorithm.SearchResult<?,P>	BstarSquaredSimpleMax.search(P root, Duration time_limit, SearchAlgorithm.Limits space_limit, MetricKeeper... metrics)
<P extends IGamePosition<P>> SearchAlgorithm.SearchResult<?,P>	BstarSquaredVariant.search(P root, Duration time_limit, SearchAlgorithm.Limits space_limit, MetricKeeper... metrics)	Deprecated.
<P extends IGamePosition<P>> SearchAlgorithm.SearchResult<?,P>	DfBstar.search(P root, Table table, Duration time_limit, SearchAlgorithm.Limits space_limit, MetricKeeper... metrics)	Deprecated.
<P extends IGamePosition<P>> SearchAlgorithm.SearchResult<?,P>	DfBstar2.search(P root, Table table, Duration time_limit, SearchAlgorithm.Limits space_limit, MetricKeeper... metrics)
<P extends IGamePosition<P>> SearchAlgorithm.SearchResult<?,P>	DfBstar3.search(P root, Table table, Duration time_limit, SearchAlgorithm.Limits space_limit, MetricKeeper... metrics)
<P extends IGamePosition<P>> SearchAlgorithm.SearchResult<?,P>	DfBstarDB.search(P root, Table table, Duration time_limit, SearchAlgorithm.Limits space_limit, MetricKeeper... metrics)
default <P extends IGamePosition<P>> SearchAlgorithm.SearchResult<?,P>	SearchAlgorithm.search(P root, SearchAlgorithm.Limits space_limit, MetricKeeper... metrics)	Initiates the search of the provided game tree without time limits.
default <P extends IGamePosition<P>> SearchAlgorithm.SearchResult<?,P>	SearchAlgorithm.search(P root, MetricKeeper... metrics)	Initiates the search of the provided game tree without time or spatial limits.
<P extends IGamePosition<P>> SearchAlgorithm.SearchResult<?,P>	SearchAlgorithm.search(P root, Duration time_limit, SearchAlgorithm.Limits space_limit, MetricKeeper... metrics)	Initiates the search of the provided game tree with a given time limit and spatial limit.
default <P extends IGamePosition<P>> SearchAlgorithm.SearchResult<?,P>	SearchAlgorithm.search(P root, Duration time_limit, MetricKeeper... metrics)	Initiates the search of the provided game tree without spatial limits.
default <P extends IGamePosition<P>> SearchAlgorithm.SearchResult<?,P>	SearchAlgorithm.SearchWithTable.search(P root, Table table, SearchAlgorithm.Limits space_limit, MetricKeeper... metrics)	Initiates the search of the provided game tree without time limits.
default <P extends IGamePosition<P>> SearchAlgorithm.SearchResult<?,P>	SearchAlgorithm.SearchWithTable.search(P root, Table table, MetricKeeper... metrics)	Initiates the search of the provided game tree without time or spatial limits.
<P extends IGamePosition<P>> SearchAlgorithm.SearchResult<?,P>	SearchAlgorithm.SearchWithTable.search(P root, Table table, Duration time_limit, SearchAlgorithm.Limits space_limit, MetricKeeper... metrics)	Initiates the search of the provided game tree with a given time limit and spatial limit.
default <P extends IGamePosition<P>> SearchAlgorithm.SearchResult<?,P>	SearchAlgorithm.SearchWithTable.search(P root, Table table, Duration time_limit, MetricKeeper... metrics)	Initiates the search of the provided game tree without spatial limits.
default <P extends IGamePosition<P>> SearchAlgorithm.SearchResult<?,P>	SearchAlgorithm.SearchWithTable.search(P root, Duration time_limit, SearchAlgorithm.Limits space_limit, MetricKeeper... metrics)	Initiates the search of the provided game tree with a given time limit and spatial limit.
<N extends GameTreeNode<N,P>, P extends IGamePosition<P>> SearchAlgorithm.SearchResult<N,P>	BstarBasic.searchWithTree(N root, Duration time_limit, SearchAlgorithm.Limits space_limit, MetricKeeper... metrics)
<N extends GameTreeNode<N,P>, P extends IGamePosition<P>> SearchAlgorithm.SearchResult<N,P>	BstarBasicDB.searchWithTree(N root, Duration time_limit, SearchAlgorithm.Limits space_limit, MetricKeeper... metrics)
default <N extends GameTreeNode<N,P>, P extends IGamePosition<P>> SearchAlgorithm.SearchResult<N,P>	SearchAlgorithm.SearchWithTree.searchWithTree(N root, SearchAlgorithm.Limits space_limit, MetricKeeper... metrics)	Initiates the search of the provided game tree without time limits.
default <N extends GameTreeNode<N,P>, P extends IGamePosition<P>> SearchAlgorithm.SearchResult<N,P>	SearchAlgorithm.SearchWithTree.searchWithTree(N root, MetricKeeper... metrics)	Initiates the search of the provided game tree without time or spatial limits.
<N extends GameTreeNode<N,P>, P extends IGamePosition<P>> SearchAlgorithm.SearchResult<N,P>	SearchAlgorithm.SearchWithTree.searchWithTree(N root, Duration time_limit, SearchAlgorithm.Limits space_limit, MetricKeeper... metrics)	Initiates the search of the provided game tree with a given time limit and spatial limit.
default <N extends GameTreeNode<N,P>, P extends IGamePosition<P>> SearchAlgorithm.SearchResult<N,P>	SearchAlgorithm.SearchWithTree.searchWithTree(N root, Duration time_limit, MetricKeeper... metrics)	Initiates the search of the provided game tree without spatial limits.
<N extends GameTreeNode<N,P>, P extends IGamePosition<P>> N	BstarBasic.selectNext(N current, boolean provebest, MetricKeeper... metrics)
<N extends GameTreeNode<N,P>, P extends IGamePosition<P>> N	BstarBasicDB.selectNext(N current, boolean provebest, MetricKeeper... metrics)
<N extends GameTreeNode<N,P>, P extends IGamePosition<P>> N	BstarBasicDB.selectNextDB(N current, double low, double high, MetricKeeper... metrics)
boolean	StopCondition.stopSearching(GameTreeNode<?,?> node, MetricKeeper... metrics)
boolean	StrategyFunction.useProveBest(GameTreeNode<?,?> root, MetricKeeper... metrics)

Method parameters in algorithm with type arguments of type MetricKeeper

Modifier and Type	Method	Description
static StrategyFunction.Deterministic	StrategyFunction.BY_SUBTREE_PARAMS(int num_alternatives, boolean by_optimistic, ToDoubleFunction<MetricKeeper> bestNodeEvaluator, ToDoubleFunction<MetricKeeper> restNodesEvaluator)

Constructors in algorithm with parameters of type MetricKeeper

Modifier	Constructor	Description
	SearchResult(N root, MetricKeeper... metrics)	Creates an instance of a SearchResult record class.
	Settings(int level, Instant start, SearchAlgorithm.Limits space_limit, Duration time_limit, MetricKeeper L1_metrics, MetricKeeper L2_metrics, MetricKeeper true_metrics, MetricKeeper[] other_metrics, StrategyFunction[] strategyFunctions)
	Settings(int level, Instant start, SearchAlgorithm.Limits space_limit, Duration time_limit, MetricKeeper L1_metrics, MetricKeeper L2_metrics, MetricKeeper true_metrics, MetricKeeper[] other_metrics, StrategyFunction[] strategyFunctions)
	Settings(int level, Instant start, SearchAlgorithm.Limits space_limit, Duration time_limit, MetricKeeper L1_metrics, MetricKeeper L2_metrics, MetricKeeper true_metrics, MetricKeeper[] other_metrics, StrategyFunction[] strategyFunctions)
	Settings(int level, Instant start, SearchAlgorithm.Limits space_limit, Duration time_limit, MetricKeeper L1_metrics, MetricKeeper L2_metrics, MetricKeeper true_metrics, MetricKeeper[] other_metrics, StrategyFunction[] strategyFunctions)

Uses of MetricKeeper in gametree

Methods in gametree that return MetricKeeper

Modifier and Type	Method	Description
protected MetricKeeper[]	GameTreeNode.combineMetricList(MetricKeeper... metrics)
MetricKeeper	MetricKeeper.copy()	Creates a copy of this MetricKeeper with the same metric values, but no link to this object.
MetricKeeper	MetricKeeper.copy(String name)	Creates a copy of this MetricKeeper with the same metric values, but no link to this object.
MetricKeeper[]	GameTreeNode.getAttachedMetrics()

Methods in gametree with parameters of type MetricKeeper

Modifier and Type	Method	Description
protected boolean	DepthFirstNode._adjustBounds(List<DepthFirstNode<P>> children, MetricKeeper... metrics)
protected abstract boolean	GameTreeNode._adjustBounds(List<N> children, MetricKeeper... metrics)	Method to implement functionality of GameTreeNode.adjustBounds(List<N>, MetricKeeper...).
protected boolean	ResultTreeNode._adjustBounds(List<ResultTreeNode<N,P,Q>> children, MetricKeeper... metrics)
boolean	SearchTreeNode._adjustBounds(List<SearchTreeNode<P>> children, MetricKeeper... metrics)
protected List<DepthFirstNode<P>>	DepthFirstNode._children(MetricKeeper... metrics)
List<DepthFirstNode<P>>	DepthFirstNode.RootDFNode._children(MetricKeeper... metrics)	This implementation stores the children of the root node only, only the root node will be of the type DepthFirstNode.RootDFNode, whereas all children will be of the type DepthFirstNode which does not store children in memory.
protected abstract List<N>	GameTreeNode._children(MetricKeeper... metrics)	Method to implement functionality of GameTreeNode.children(MetricKeeper...).
protected List<ResultTreeNode<N,P,Q>>	ResultTreeNode._children(MetricKeeper... metrics)
ArrayList<SearchTreeNode<P>>	SearchTreeNode._children(MetricKeeper... metrics)
protected long	DepthFirstNode._depthOfLower(MetricKeeper... metrics)
protected abstract long	GameTreeNode._depthOfLower(MetricKeeper... metrics)	Method to implement functionality of GameTreeNode.depthOfLower(MetricKeeper...).
protected long	ResultTreeNode._depthOfLower(MetricKeeper... metrics)
long	SearchTreeNode._depthOfLower(MetricKeeper... metrics)
protected long	DepthFirstNode._depthOfUpper(MetricKeeper... metrics)
protected abstract long	GameTreeNode._depthOfUpper(MetricKeeper... metrics)	Method to implement functionality of GameTreeNode.depthOfUpper(MetricKeeper...).
protected long	ResultTreeNode._depthOfUpper(MetricKeeper... metrics)
long	SearchTreeNode._depthOfUpper(MetricKeeper... metrics)
protected double	DepthFirstNode._lowerbound(MetricKeeper... metrics)
protected abstract double	GameTreeNode._lowerbound(MetricKeeper... metrics)	Method to implement functionality of GameTreeNode.lowerbound(MetricKeeper...).
protected double	ResultTreeNode._lowerbound(MetricKeeper... metrics)
double	SearchTreeNode._lowerbound(MetricKeeper... metrics)
protected double	DepthFirstNode._upperbound(MetricKeeper... metrics)
protected abstract double	GameTreeNode._upperbound(MetricKeeper... metrics)	Method to implement functionality of GameTreeNode.upperbound(MetricKeeper...).
protected double	ResultTreeNode._upperbound(MetricKeeper... metrics)
double	SearchTreeNode._upperbound(MetricKeeper... metrics)
static <N extends GameTreeNode<N,P>, P extends IGamePosition<P>> boolean	GameTreeNode.adjustBounds(boolean maximising, double[] lowerUpper, long[] depthLowerUpper, List<N> children, MetricKeeper... metrics)	Adjust the bounds of a node.
boolean	GameTreeNode.adjustBounds(boolean useExpansions, MetricKeeper... metrics)
boolean	GameTreeNode.adjustBounds(MetricKeeper... metrics)	Adjusts the bounds of this node according to the values of the children nodes as given by GameTreeNode.children(MetricKeeper...).
boolean	GameTreeNode.adjustBounds(List<N> children, MetricKeeper... metrics)
boolean	ResultTreeNode.adjustBounds(boolean useExpansions, MetricKeeper... metrics)
static void	MetricKeeper.adjustNodeCount(long nodesSavedIncrease, MetricKeeper... metrics)	Increases the number of nodes kept in memory of all MetricKeeper objects provided by nodesSavedIncrease which may be negative.
void	GameTreeNode.attachMetrics(MetricKeeper... m)
void	SearchTreeNode.attachMetrics(MetricKeeper... metrics)
double[]	GameTreeNode.CDF(int maxDepth, MetricKeeper... metrics)	Computes the Cumulative Distribution Function (CDF) P(X ≤ t) of this node, assuming that the distribution is a discrete one.
List<N>	GameTreeNode.children(MetricKeeper... metrics)	The children of this node are its direct descendants.
protected MetricKeeper[]	GameTreeNode.combineMetricList(MetricKeeper... metrics)
long	GameTreeNode.depthOfLower(MetricKeeper... metrics)	Depth-of-lowerbound is the depth from which the lower bound of this node has been backed up.
long	GameTreeNode.depthOfUpper(MetricKeeper... metrics)	Depth-of-upperbound is the depth from which the upper bound of this node has been backed up.
boolean	SearchTreeNode.evaluate(MetricKeeper... metrics)	Evaluates this node if the tree has not been frozen in the SearchTreeNode.settings.
static <N extends GameTreeNode<N,P>, P extends IGamePosition<P>> GameTreeNode.Result<N,P>	GameTreeNode.findBest2(Collection<N> children, boolean maximising, boolean by_optimistic, MetricKeeper... metrics)	Calculate the best 2 nodes from the perspective specified by the maximizing and by_optimistic flags.
Stream<N>	GameTreeNode.getAllLeafnodes(int maxDepth, Predicate<N> include, MetricKeeper... metrics)
static Comparator<GameTreeNode<?,?>>	GameTreeNode.getComparator(boolean maximising, boolean by_optimistic, MetricKeeper... metrics)	This method gives a comparator for GameTreeNode objects from the perspective of a parent node.
static <P extends IGamePosition<P>> DepthFirstNode<P>	DepthFirstNode.getTree(P root, boolean saveRootChildren, MetricKeeper... metrics)	Get a new depth-first game tree based on the provided game position and the saveRootChildren parameter.
static void	MetricKeeper.incrementEvaluations(long evaluationsIncrement, MetricKeeper... metrics)	Increments the number of evaluations of all MetricKeeper objects provided by 0 or evaluationsIncrement if it is positive.
static void	MetricKeeper.incrementEvaluations(MetricKeeper... metrics)	Increments the number of evaluations of all MetricKeeper objects provided by 1.
static void	MetricKeeper.incrementExpansions(long expansionsIncrement, MetricKeeper... metrics)	Increments the number of expansions of all MetricKeeper objects provided by 0 or expansionsIncrement if it is positive.
static void	MetricKeeper.incrementExpansions(MetricKeeper... metrics)	Increments the number of expansions of all MetricKeeper objects provided by 1.
static void	MetricKeeper.incrementMetrics(long evaluationsIncrement, long expansionsIncrement, MetricKeeper... metrics)	Updates the given MetricKeeper objects with the supplied values to increment the evaluations and expansions counts by.
boolean	GameTreeNode.isRelevant(MetricKeeper... metrics)
static <N extends GameTreeNode<N,P>, P extends IGamePosition<P>> GameTreeNode.Result<N,P>	GameTreeNode.leastPessimistic2(Collection<N> children, boolean maximising, MetricKeeper... metrics)	Same as GameTreeNode.findBest2(Collection, boolean, boolean, MetricKeeper...) where by_optimistic is assumed false.
double	GameTreeNode.lowerbound(MetricKeeper... metrics)	The lower-bound value is the lower bound on the game-theoretical mini-max value of this game position.
static <N extends GameTreeNode<N,P>, P extends IGamePosition<P>> GameTreeNode.Result<N,P>	GameTreeNode.mostOptimistic2(Collection<N> children, boolean maximising, MetricKeeper... metrics)	Same as GameTreeNode.findBest2(Collection, boolean, boolean, MetricKeeper...) where by_optimistic is assumed true.
double[]	GameTreeNode.PMF(int maxDepth, MetricKeeper... metrics)	Computes the Probability Mass Function (PMF) P(X = x) of this node, assuming that the distribution is a discrete one.
String	GameTreeNode.printTree(int depth, boolean toString, boolean printDist, MetricKeeper... metrics)	Visually represents the structure of the sub-tree starting from this node as a String.
String	GameTreeNode.printTree(int depth, boolean toString, MetricKeeper... metrics)	Visually represents the structure of the sub-tree starting from this node as a String.
String	GameTreeNode.printTree(int depth, MetricKeeper... metrics)
boolean	SearchTreeNode.pruneIrrelevantChildren(MetricKeeper[] m)
double	GameTreeNode.remainingSolveEffort(MetricKeeper... metrics)
boolean	GameTreeNode.Result.separation(MetricKeeper... metrics)	Separation occurs when one node in a set of children is strictly better than its siblings.
static <N extends GameTreeNode<N,P>, P extends IGamePosition<P>> boolean	GameTreeNode.separation(GameTreeNode<?,?> n, MetricKeeper... metrics)
static <N extends GameTreeNode<N,P>, P extends IGamePosition<P>> boolean	GameTreeNode.separation(Collection<N> children, boolean maximising, MetricKeeper... metrics)
double[]	GameTreeNode.survivalFunction(int maxDepth, MetricKeeper... metrics)	Computes the Survival Function P(X ≥ x) of this node, assuming that the distribution is a discrete one.
void	GameTreeNode.updateTree(MetricKeeper... metrics)
double	GameTreeNode.upperbound(MetricKeeper... metrics)	The upper-bound value is the upper bound on the game-theoretical mini-max value of this game GameTreeNode.position().

Constructors in gametree with parameters of type MetricKeeper

Modifier	Constructor	Description
protected	DepthFirstNode(DepthFirstNode<P> parent, P position, MetricKeeper... metrics)
protected	GameTreeNode(N parent, P position, MetricKeeper... metrics)	Creates a GameTreeNode in the same game tree as the given parent node, as its child node, where the given position is the current game state.
	MetricKeeper(MetricKeeper m)
	MetricKeeper(String metricName, MetricKeeper m)	Initialises this object with initial values equal to the current values of the given MetricKeeper object m.
	RootDFNode(P position, MetricKeeper... metrics)
	SearchTreeNode(SearchTreeNode.Settings settings, SearchTreeNode<P> parent, P position, MetricKeeper... metrics)
	SearchTreeNode(SearchTreeNode.Settings settings, P position, MetricKeeper... metrics)

Uses of MetricKeeper in test

Methods in test with parameters of type MetricKeeper

Modifier and Type	Method	Description
boolean	SimpleNode._adjustBounds(List<SimpleNode<P>> children, MetricKeeper... metrics)
List<SimpleNode<P>>	SimpleNode._children(MetricKeeper... metrics)
long	SimpleNode._depthOfLower(MetricKeeper... metrics)
long	SimpleNode._depthOfUpper(MetricKeeper... metrics)
double	SimpleNode._lowerbound(MetricKeeper... metrics)
double	SimpleNode._upperbound(MetricKeeper... metrics)

Uses of MetricKeeper in visualizer

Methods in visualizer that return MetricKeeper

Modifier and Type	Method	Description
MetricKeeper	TextExplorer.getMetrics()

Methods in visualizer with parameters of type MetricKeeper

Modifier and Type	Method	Description
void	TextExplorer.addMetrics(MetricKeeper... metrics)
void	TextExplorer.setMetrics(MetricKeeper m)