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

Class: Math_Numerical_RootFinding

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

Class Overview


Math_Numerical_RootFinding base class.


Author(s):

Variables

Methods


Child classes:

Math_Numerical_RootFinding_Open
Open method base class.
Math_Numerical_RootFinding_Bracketing
Bracketing method base class.

Inherited Variables

Inherited Methods


Class Details

[line 54]
Math_Numerical_RootFinding base class.

This class intended for build API structure and abstract class members.



[ Top ]


Class Variables

$options = array()

[line 62]

Subclass options.
  • Access: protected

Type:   array


[ Top ]

$root =  null

[line 70]

Root value.
  • Access: protected

Type:   float


[ Top ]



Method Detail

Math_Numerical_RootFinding (Constructor)   [line 80]

Math_Numerical_RootFinding Math_Numerical_RootFinding( [array $options = null])

Constructor.

Parameters:

array   $options   —  (optional) Options.

[ Top ]

factory   [line 104]

object New &factory( string $method, [array $options = null])

Create new instance of rootfinding method class.

Parameters:

string   $method   —  Method name.
array   $options   —  (optional) Options.

[ Top ]

getEqResult   [line 215]

float|PEAR_Error getEqResult( callback $eqFunction, float $x)

Compute a value using given equation function or object/method.
  • Return: result value on success, PEAR_Error on failure.
  • Access: protected

Parameters:

callback   $eqFunction   —  Equation function name or object method tuple.
float   $x   —  Variable value.

[ Top ]

getRoot   [line 182]

float getRoot( )

Get root value.
  • Return: Root value.
  • Access: public

[ Top ]

set   [line 151]

bool|PEAR_Error set( mixed $option, [mixed $value = null])

Set the option(s).

Set a single option or multiple options.

  • Return: TRUE on success, PEAR_Error on failure.
  • Access: public

Parameters:

mixed   $option   —  A string with option name as value for single option or An associative array contains options array('<option>' => <value>) for multiple options.
mixed   $value   —  (optional) Option value. Require when $option is string (single option mode).

[ Top ]

validateEqFunction   [line 198]

bool|PEAR_Error validateEqFunction( string $eqFunction)

Validate equation function or object/method.

Simple function to know the whether equation function or object/method callback is working.


Parameters:

string   $eqFunction   —  Equation function name or object method tuple.

[ Top ]


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