Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.commons.math.analysis
Class UnivariateRealSolverFactory

    java.lang.Object
      org.apache.commons.math.analysis.UnivariateRealSolverFactory

Direct Known Subclasses:
  UnivariateRealSolverFactoryImpl

public abstract class UnivariateRealSolverFactory
extends Object

Abstract factory class used to create `UnivariateRealSolver` instances.

Solvers implementing the following algorithms are supported:

- Bisection
- Brent's method
- Secant method

Concrete factories extending this class also specify a default solver, instances of which are returned by `newDefaultSolver()`.

Common usage:

     SolverFactory factory = UnivariateRealSolverFactory.newInstance();

     // create a Brent solver to use with a UnivariateRealFunction f
     BrentSolver solver = factory.newBrentSolver(f);

Jakarta Commons Discovery is used to determine the concrete factory returned by `UnivariateRealSolverFactory.newInstance().` The default is `UnivariateRealSolverFactoryImpl`.

Version:
  $Revision: 1.16 $ $Date: 2004/07/10 15:59:14 $

Constructor Summary
`protected` | `UnivariateRealSolverFactory()` Default constructor.

Method Summary
`abstract UnivariateRealSolver` | `newBisectionSolver(UnivariateRealFunction f)` Create a new `UnivariateRealSolver` for the given function.
`abstract UnivariateRealSolver` | `newBrentSolver(UnivariateRealFunction f)` Create a new `UnivariateRealSolver` for the given function.
`abstract UnivariateRealSolver` | `newDefaultSolver(UnivariateRealFunction f)` Create a new `UnivariateRealSolver` for the given function.
`static UnivariateRealSolverFactory` | `newInstance()` Create a new factory.
`abstract UnivariateRealSolver` | `newNewtonSolver(DifferentiableUnivariateRealFunction f)` Create a new `UnivariateRealSolver` for the given function.
`abstract UnivariateRealSolver` | `newSecantSolver(UnivariateRealFunction f)` Create a new `UnivariateRealSolver` for the given function.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### UnivariateRealSolverFactory

    protected UnivariateRealSolverFactory()

  Default constructor.

Method Detail

### newInstance

    public static UnivariateRealSolverFactory newInstance()

  Create a new factory.

  Returns:
    a new factory.

### newDefaultSolver

    public abstract UnivariateRealSolver newDefaultSolver(UnivariateRealFunction f)

  Create a new `UnivariateRealSolver` for the given function. The actual solver returned is determined by the underlying factory.

  Parameters:
    `f` - the function.
  Returns:
    the new solver.

### newBisectionSolver

    public abstract UnivariateRealSolver newBisectionSolver(UnivariateRealFunction f)

  Create a new `UnivariateRealSolver` for the given function. The solver is an implementation of the bisection method.

  Parameters:
    `f` - the function.
  Returns:
    the new solver.

### newBrentSolver

    public abstract UnivariateRealSolver newBrentSolver(UnivariateRealFunction f)

  Create a new `UnivariateRealSolver` for the given function. The solver is an implementation of the Brent method.

  Parameters:
    `f` - the function.
  Returns:
    the new solver.

### newNewtonSolver

    public abstract UnivariateRealSolver newNewtonSolver(DifferentiableUnivariateRealFunction f)

  Create a new `UnivariateRealSolver` for the given function. The solver is an implementation of Newton's Method.

  Parameters:
    `f` - the function.
  Returns:
    the new solver.

### newSecantSolver

    public abstract UnivariateRealSolver newSecantSolver(UnivariateRealFunction f)

  Create a new `UnivariateRealSolver` for the given function. The solver is an implementation of the secant method.

  Parameters:
    `f` - the function.
  Returns:
    the new solver.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2003-2004 The Apache Software Foundation. All Rights Reserved.