Package com.jgalgo.alg

Interface AlgorithmBuilderBase

All Known Subinterfaces:

BiConnectedComponentsAlgo.Builder, ChinesePostman.Builder, ClosuresEnumerator.Builder, ColoringAlgo.Builder, CoresAlgo.Builder, CyclesEnumerator.Builder, DominatingSetAlgo.Builder, EdgeCover.Builder, EulerianTourAlgo.Builder, KEdgeConnectedComponentsAlgo.Builder, KShortestPathsST.Builder, KVertexConnectedComponentsAlgo.Builder, LowestCommonAncestorDynamic.Builder, LowestCommonAncestorOffline.Builder, LowestCommonAncestorStatic.Builder, MatchingAlgo.Builder, MaximalCliquesEnumerator.Builder, MaximumFlow.Builder, MinimumCostFlow.Builder, MinimumDirectedSpanningTree.Builder, MinimumEdgeCutAllST.Builder, MinimumEdgeCutGlobal.Builder, MinimumEdgeCutST.Builder, MinimumMeanCycle.Builder, MinimumSpanningTree.Builder, MinimumVertexCutAllGlobal.Builder, MinimumVertexCutAllST.Builder, MinimumVertexCutGlobal.Builder, MinimumVertexCutST.Builder, ShortestPathAllPairs.Builder, ShortestPathHeuristicST.Builder, ShortestPathSingleSource.Builder, ShortestPathST.Builder, SimplePathsEnumerator.Builder, SteinerTreeAlgo.Builder, StronglyConnectedComponentsAlgo.Builder, TopologicalOrderAlgo.Builder, TreePathMaxima.Builder, VertexCover.Builder, VoronoiAlgo.Builder, WeaklyConnectedComponentsAlgo.Builder

public interface AlgorithmBuilderBase

A base interface for all algorithm builders.

Algorithms such as ShortestPathSingleSource define their own builder as an inner interface, for example ShortestPathSingleSource.Builder. These builder interfaces extend this interface. This base interface does not contain methods which are useful to the user, rather its used for the setOption(String, Object) method which is used internally for debugging and benchmarking.

Author:

Barak Ugav

Method Summary

Modifier and Type	Method	Description
default void	setOption(String key, Object value)	[TL;DR Don't call me!] Set an option.

Method Detail

setOption

default void setOption(String key,
                       Object value)

[TL;DR Don't call me!] Set an option.

The builder might support different options to customize its implementation. These options never change the behavior of the algorithm, only its internal implementation. The possible options are not exposed as 'public' because they are not part of the API and may change in the future.

These options are mainly for debug and benchmark purposes.

Parameters:

key - the option key

value - the option value