comparison src/mappers.cc @ 9064:7c02ec148a3c

Check grammar on all .cc files Same check as previously done on .m files Attempt to enforce some conformity in documentation text for rules such as two spaces after a period, commas around latin abbreviations, etc.
author Rik <rdrider0-list@yahoo.com>
date Sat, 28 Mar 2009 13:57:22 -0700
parents 853f96e8008f
children 8207b833557f
comparison
equal deleted inserted replaced
9063:a6cf0ad87eee 9064:7c02ec148a3c
174 "-*- texinfo -*-\n\ 174 "-*- texinfo -*-\n\
175 @deftypefn {Mapping Function} {} arg (@var{z})\n\ 175 @deftypefn {Mapping Function} {} arg (@var{z})\n\
176 @deftypefnx {Mapping Function} {} angle (@var{z})\n\ 176 @deftypefnx {Mapping Function} {} angle (@var{z})\n\
177 Compute the argument of @var{z}, defined as\n\ 177 Compute the argument of @var{z}, defined as\n\
178 @var{theta} = @code{atan2 (@var{y}, @var{x})}.\n\ 178 @var{theta} = @code{atan2 (@var{y}, @var{x})}.\n\
179 in radians. \n\ 179 in radians. \n\
180 \n\ 180 \n\
181 For example,\n\ 181 For example,\n\
182 \n\ 182 \n\
183 @example\n\ 183 @example\n\
184 @group\n\ 184 @group\n\
732 @end tex\n\ 732 @end tex\n\
733 @end iftex\n\ 733 @end iftex\n\
734 @ifnottex\n\ 734 @ifnottex\n\
735 \n\ 735 \n\
736 @example\n\ 736 @example\n\
737 @group\n\
737 infinity\n\ 738 infinity\n\
738 /\n\ 739 /\n\
739 gamma (z) = | t^(z-1) exp (-t) dt.\n\ 740 gamma (z) = | t^(z-1) exp (-t) dt.\n\
740 /\n\ 741 /\n\
741 t=0\n\ 742 t=0\n\
743 @end group\n\
742 @end example\n\ 744 @end example\n\
743 @end ifnottex\n\ 745 @end ifnottex\n\
744 @seealso{gammainc, lgamma}\n\ 746 @seealso{gammainc, lgamma}\n\
745 @end deftypefn") 747 @end deftypefn")
746 { 748 {
1299 */ 1301 */
1300 1302
1301 DEFUN (roundb, args, , 1303 DEFUN (roundb, args, ,
1302 "-*- texinfo -*-\n\ 1304 "-*- texinfo -*-\n\
1303 @deftypefn {Mapping Function} {} roundb (@var{x})\n\ 1305 @deftypefn {Mapping Function} {} roundb (@var{x})\n\
1304 Return the integer nearest to @var{x}. If there are two nearest\n\ 1306 Return the integer nearest to @var{x}. If there are two nearest\n\
1305 integers, return the even one (banker's rounding). If @var{x} is complex,\n\ 1307 integers, return the even one (banker's rounding). If @var{x} is complex,\n\
1306 return @code{roundb (real (@var{x})) + roundb (imag (@var{x})) * I}.\n\ 1308 return @code{roundb (real (@var{x})) + roundb (imag (@var{x})) * I}.\n\
1307 @seealso{rem}\n\ 1309 @seealso{rem}\n\
1308 @end deftypefn") 1310 @end deftypefn")
1309 { 1311 {
1310 octave_value retval; 1312 octave_value retval;
1328 @end tex\n\ 1330 @end tex\n\
1329 @end iftex\n\ 1331 @end iftex\n\
1330 @ifnottex\n\ 1332 @ifnottex\n\
1331 \n\ 1333 \n\
1332 @example\n\ 1334 @example\n\
1335 @group\n\
1333 -1, x < 0;\n\ 1336 -1, x < 0;\n\
1334 sign (x) = 0, x = 0;\n\ 1337 sign (x) = 0, x = 0;\n\
1335 1, x > 0.\n\ 1338 1, x > 0.\n\
1339 @end group\n\
1336 @end example\n\ 1340 @end example\n\
1337 @end ifnottex\n\ 1341 @end ifnottex\n\
1338 \n\ 1342 \n\
1339 For complex arguments, @code{sign} returns @code{x ./ abs (@var{x})}.\n\ 1343 For complex arguments, @code{sign} returns @code{x ./ abs (@var{x})}.\n\
1340 @end deftypefn") 1344 @end deftypefn")
1566 Return a copy of the string or cell string @var{s}, with each upper-case\n\ 1570 Return a copy of the string or cell string @var{s}, with each upper-case\n\
1567 character replaced by the corresponding lower-case one; nonalphabetic\n\ 1571 character replaced by the corresponding lower-case one; nonalphabetic\n\
1568 characters are left unchanged. For example,\n\ 1572 characters are left unchanged. For example,\n\
1569 \n\ 1573 \n\
1570 @example\n\ 1574 @example\n\
1575 @group\n\
1571 tolower (\"MiXeD cAsE 123\")\n\ 1576 tolower (\"MiXeD cAsE 123\")\n\
1572 @result{} \"mixed case 123\"\n\ 1577 @result{} \"mixed case 123\"\n\
1578 @end group\n\
1573 @end example\n\ 1579 @end example\n\
1574 @seealso{toupper}\n\ 1580 @seealso{toupper}\n\
1575 @end deftypefn") 1581 @end deftypefn")
1576 { 1582 {
1577 octave_value retval; 1583 octave_value retval;
1605 1611
1606 DEFUNX ("toupper", Ftoupper, args, , 1612 DEFUNX ("toupper", Ftoupper, args, ,
1607 "-*- texinfo -*-\n\ 1613 "-*- texinfo -*-\n\
1608 @deftypefn {Built-in Function} {} toupper (@var{s})\n\ 1614 @deftypefn {Built-in Function} {} toupper (@var{s})\n\
1609 @deftypefnx {Built-in Function} {} upper (@var{s})\n\ 1615 @deftypefnx {Built-in Function} {} upper (@var{s})\n\
1610 Return a copy of the string or cell string @var{s}, with each lower-case\n\ 1616 Return a copy of the string or cell string @var{s}, with each lower-case\n\
1611 character replaced by the corresponding upper-case one; nonalphabetic\n\ 1617 character replaced by the corresponding upper-case one; nonalphabetic\n\
1612 characters are left unchanged. For example,\n\ 1618 characters are left unchanged. For example,\n\
1613 \n\ 1619 \n\
1614 @example\n\ 1620 @example\n\
1615 @group\n\ 1621 @group\n\