From: Michael Orlitzky Date: Fri, 14 Sep 2012 19:38:13 +0000 (-0400) Subject: Update docs for has_root(). X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=f731b63a9705d1365df898881b7aaafe371e5dde;p=octave.git Update docs for has_root(). --- diff --git a/has_root.m b/has_root.m index da518e9..ffd9666 100644 --- a/has_root.m +++ b/has_root.m @@ -7,7 +7,19 @@ function has_root = has_root(fa, fb) ## Call the function whose roots we're concerned with 'f'. The two ## parameters `fa` and `fb` should correspond to f(a) and f(b). ## - + ## + ## INPUTS: + ## + ## * ``fa`` - The value of `f` at one end of the interval. + ## + ## * ``fb`` - The value of `f` at the other end of the interval. + ## + ## OUTPUTS: + ## + ## * ``has_root`` - True if we can use the I.V.T. to conclude that + ## there is a root on [a,b], false otherwise. + ## + ## If either f(a) or f(b) is zero, the product of their signs will be ## zero and either a or b is a root. If the product of their signs is ## negative, then f(a) and f(b) are non-zero and have opposite sign,