Update docs for has_root().
authorMichael Orlitzky <michael@orlitzky.com>
Fri, 14 Sep 2012 19:38:13 +0000 (15:38 -0400)
committerMichael Orlitzky <michael@orlitzky.com>
Fri, 14 Sep 2012 19:38:13 +0000 (15:38 -0400)
has_root.m

index da518e9f3e03524db06a9a1c10f4a41fbdfd9afe..ffd96666b0bca58366fc5b641c43a2893cf3b16c 100644 (file)
@@ -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,