Class: Math_Numerical_RootFinding_Open

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

Class Overview

Math_Numerical_RootFinding
   |
   --Math_Numerical_RootFinding_Open

Open method base class.

Author(s):

Firman Wandayandi <firman at dotgeek.org>

Variables

Methods

Child classes:

Math_Numerical_RootFinding_newtonraphson2: Newton-Raphson 2 method class.

Math_Numerical_RootFinding_newtonraphson: Newton-Raphson method class.

Math_Numerical_RootFinding_fixedpoint: Fixed Point method class.

Math_Numerical_RootFinding_secant: Secant method class.

Math_Numerical_RootFinding_ralstonrabinowitz: Ralston and Rabinowitz method class.

Inherited Variables

Class: Math_Numerical_RootFinding

Math_Numerical_RootFinding::$root

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]
Open method base class.

Author: Firman Wandayandi <firman@dotgeek.org>
Abstract:

[ Top ]

Class Variables

$epsError = 0

[line 70]

Epsilon error.

Access: protected

Type:

float

[ Top ]

$iterationCount = 0

[line 62]

Iteration count.

Access: protected

Type:

int

[ Top ]

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

[line 50]

Math_Numerical_RootFinding_open options.

Access: protected

Type:	array
Overrides:	Array

[ Top ]

Method Detail

Math_Numerical_RootFinding_Open (Constructor) [line 87]

Math_Numerical_RootFinding_Open Math_Numerical_RootFinding_Open(
[array
$options = null])

Constructor.

Options:

 max_iteration   int    Maximum iteration.
 err_tolerance   float  Error tolerance.
 divergent_skip  bool   Flag whether skiped iteration, when
                        divergent rows detected.

Access: public

Parameters:

array $options — (optional) Options.

[ Top ]

getEpsError [line 142]

float getEpsError(
)

Get epsilon error.

Return: Epsilon error.
Access: public

[ Top ]

getIterationCount [line 131]

int getIterationCount(
)

Get iteration count.

Return: Iteration count.
Access: public

[ Top ]

isDivergentRow [line 112]

bool isDivergentRow(

$epsErrors, array
$epsilonErrors)

Detect for divergent rows.

Compare 3 rows of last epsilon errors, if no.3 bigger than no.2 and no.2 bigger than no.1, rows are divergent.

Return: TRUE if divergent, otherwise FALSE
Access: public

Parameters:

array	`$epsilonErrors`	—	Epsilon errors collection
	`$epsErrors`	—

[ Top ]

Class: Math_Numerical_RootFinding_Open

Class Overview

Author(s):

Variables

Methods

Child classes:

Inherited Variables

Class: Math_Numerical_RootFinding

Inherited Methods

Class: Math_Numerical_RootFinding

Class Details

Class Variables

$epsError = 0

$iterationCount = 0

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

Method Detail

Math_Numerical_RootFinding_Open (Constructor) [line 87]

Parameters:

getEpsError [line 142]

getIterationCount [line 131]

isDivergentRow [line 112]

Parameters:

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