diff src/DLD-FUNCTIONS/betainc.cc @ 3444:fa0d84558faa

[project @ 2000-01-17 08:40:39 by jwe]
author jwe
date Mon, 17 Jan 2000 08:40:41 +0000
parents 28d5f556b8cf
children 9f7ef92b50b0
line wrap: on
line diff
--- a/src/DLD-FUNCTIONS/betainc.cc	Mon Jan 17 08:28:27 2000 +0000
+++ b/src/DLD-FUNCTIONS/betainc.cc	Mon Jan 17 08:40:41 2000 +0000
@@ -33,13 +33,31 @@
 #include "utils.h"
 
 DEFUN_DLD (betainc, args, ,
-  "betainc (x, a, b)\n\
-\n\
-Compute the incomplete beta function\n\
+  "-*- texinfo -*-\n\
+@deftypefn {Mapping Function} {} betainc (@var{x}, @var{a}, @var{b})\n\
+Return the incomplete Beta function,\n\
+@iftex\n\
+@tex\n\
+$$\n\
+ \\beta (a, b, x) = B (a, b)^{-1} \\int_0^x t^{(a-z)} (1-t)^{(b-1)} dt.\n\
+$$\n\
+@end tex\n\
+@end iftex\n\
+@ifinfo\n\
 \n\
-  betainc(x,a,b) = beta(a,b)^(-1) \\int_0^x t^(a-1) (1-t)^(b-1) dt\n\
+@smallexample\n\
+                                    x\n\
+                                   /\n\
+betai (a, b, x) = beta (a, b)^(-1) | t^(a-1) (1-t)^(b-1) dt.\n\
+                                   /\n\
+                                t=0\n\
+@end smallexample\n\
+@end ifinfo\n\
 \n\
-The sizes of x, a, and b must agree.")
+If x has more than one component, both @var{a} and @var{b} must be\n\
+scalars.  If @var{x} is a scalar, @var{a} and @var{b} must be of\n\
+compatible dimensions.\n\
+@end deftypefn")
 {
   octave_value retval;