Package com.jgalgo.alg.common

Interface AlgorithmBuilderBase

All Known Subinterfaces:
MatchingAlgo.Builder, MinimumCostFlow.Builder, ShortestPathAllPairs.Builder, ShortestPathSingleSource.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 useful public API methods, rather it contains a single method, setOption(String, Object) 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 Details

    • 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