Modern Finance FinSolveResult

Home › Finance › Finance › FinSolveResult

FinSolveResult

Holds the root found, its residual, the iteration count and whether it converged.

Syntax

r.Root_  r.Residual_  r.Iterations_  r.Converged_  r.Bracketed_

Examples

#import "std/money"
using money

private function fRoot( byval x as float64, byval ctx as any ptr ) as float64
    return x * x - 2.0
end function

dim as FinSolverOptions o = FinSolverOptionsWithGuess( 1.0 )
o.LowerBound_ = -1.0e6
o.UpperBound_ =  1.0e6

var r = FinSolveRoot( @fRoot, 0, o )

print r.Value( ).Root_                   '' 1.414213562373095
print r.Value( ).Converged_              '' true

'' Bracketed_ is false when the Newton fast path alone got there -- the
'' answer never depends on which path was taken, only the cost does.
print r.Value( ).Bracketed_              '' false
print ( abs( r.Value( ).Residual_ ) <= 1.0e-12 )   '' -1 (an integer comparison)

---

Library: Finance
Category: Finance
Documented under: Nothing Becomes A Keyword
Source: pkg/std/money/finsolve.tiko in the tiko repository.