Package org.tweetyproject.math.opt.rootFinder

Class RootFinder

java.lang.Object
org.tweetyproject.math.opt.rootFinder.RootFinder
Direct Known Subclasses:
NewtonRootFinder, OptimizationRootFinder
public abstract class RootFinder extends Object
Classes which extend this class represent algorithms for finding zero points (roots) of functions.
Author:
Matthias Thimm

  • Field Details

    • PRECISION

      public static double PRECISION
      The precision for finding roots.

  • Constructor Details

    • RootFinder

      public RootFinder()
      Creates a new root finder for the given function.

    • RootFinder

      public RootFinder(List<Term> functions, Map<Variable,Term> startingPoint)
      Creates a new root finder for the given starting point and the given (multi-dimensional) function
      Parameters:
      functions - a list of functions
      startingPoint - the starting point

  • Method Details

    • setStartingPoint

      public void setStartingPoint(Map<Variable,Term> startingPoint)
      sets the starting point of this root finder.
      Parameters:
      startingPoint - the starting point

    • getStartingPoint

      public Map<Variable,Term> getStartingPoint()
      Returns the starting point of this finder.
      Returns:
      the starting point of this finder.

    • getFunctions

      public List<Term> getFunctions()
      Returns the function of this root finder.
      Returns:
      the function of this root finder.

    • randomRoot

      public abstract Map<Variable,Term> randomRoot(List<Term> functions, Map<Variable,Term> startingPoint) throws GeneralMathException
      Determines the values for the variables appearing in the function such the function evaluates to zero.
      Parameters:
      functions - the functions
      startingPoint - the starting point for the search
      Returns:
      a map from variables to terms such that "function" evaluates to zero.
      Throws:
      GeneralMathException - if something went wrong.