Math_Numerical_RootFinding
[ class tree: Math_Numerical_RootFinding ] [ index: Math_Numerical_RootFinding ] [ all elements ]

Class: Math_Numerical_RootFinding_Bracketing

Source Location: /Math_Numerical_RootFinding-0.2.0/Math/Numerical/RootFinding/Bracketing.php

Class Overview

Math_Numerical_RootFinding
   |
   --Math_Numerical_RootFinding_Bracketing

Bracketing method base class.


Author(s):

Variables

Methods


Child classes:

Math_Numerical_RootFinding_falseposition
False Position method class.
Math_Numerical_RootFinding_bisection
Bisection method class.

Inherited Variables

Inherited Methods

Class: Math_Numerical_RootFinding

Math_Numerical_RootFinding::Math_Numerical_RootFinding()
Constructor.
Math_Numerical_RootFinding::factory()
Create new instance of rootfinding method class.
Math_Numerical_RootFinding::getEqResult()
Compute a value using given equation function or object/method.
Math_Numerical_RootFinding::getRoot()
Get root value.
Math_Numerical_RootFinding::set()
Set the option(s).
Math_Numerical_RootFinding::validateEqFunction()
Validate equation function or object/method.

Class Details

[line 42]
Bracketing method base class.


[ Top ]


Class Variables

$epsError =  0

[line 69]

Epsilon error.
  • Access: protected

Type:   float


[ Top ]

$iterationCount =  0

[line 61]

Iteration count.
  • Access: protected

Type:   int


[ Top ]

$options = array(
        'max_iteration' => 30,
        'err_tolerance' => 1E-005
    )

[line 50]

Math_Numerical_RootFinding_bracketing options.
  • Access: public

Type:   array
Overrides:   Array


[ Top ]



Method Detail

Math_Numerical_RootFinding_Bracketing (Constructor)   [line 84]

Math_Numerical_RootFinding_Bracketing Math_Numerical_RootFinding_Bracketing( [array $options = null])

Constructor.

Options:

 max_iteration   int    maximum iteration
 err_tolerance   float  Error tolerance.

  • Access: public

Parameters:

array   $options   —  (optional) Options.

[ Top ]

getEpsError   [line 115]

float getEpsError( )

Get epsilon error.
  • Return: Epsilon error.
  • Access: public

[ Top ]

getIterationCount   [line 104]

int getIterationCount( )

Get iteration count.
  • Return: Iteration count.
  • Access: public

[ Top ]


Documentation generated on Mon, 11 Mar 2019 13:52:41 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.