diff src/bitfcns.cc @ 5040:b6ff3a0d3d17

[project @ 2004-09-27 13:50:01 by jwe]
author jwe
date Mon, 27 Sep 2004 13:50:01 +0000
parents bfd57b466752
children 4c8a2e4e0717
line wrap: on
line diff
--- a/src/bitfcns.cc
+++ b/src/bitfcns.cc
@@ -492,6 +492,30 @@
 DEFUN (intmax, args, ,
   "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} intmax (@var{type})\n\
+Return the largest integer that can be represented in an integer type.\n\
+The variable @var{type} can be\n\
+\n\
+@table @code\n\
+@item int8\n\
+signed 8-bit integer.\n\
+@item int16\n\
+signed 16-bit integer.\n\
+@item int32\n\
+signed 32-bit integer.\n\
+@item int64\n\
+signed 64-bit integer.\n\
+@item uint8\n\
+unsigned 8-bit integer.\n\
+@item uint16\n\
+unsigned 16-bit integer.\n\
+@item uint32\n\
+unsigned 32-bit integer.\n\
+@item uint64\n\
+unsigned 64-bit integer.\n\
+@end table\n\
+\n\
+The default for @var{type} is @code{uint32}.\n\
+@seealso{intmin,bitmax}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -531,6 +555,30 @@
 DEFUN (intmin, args, ,
   "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} intmin (@var{type})\n\
+Return the smallest integer that can be represented in an integer type.\n\
+The variable @var{type} can be\n\
+\n\
+@table @code\n\
+@item int8\n\
+signed 8-bit integer.\n\
+@item int16\n\
+signed 16-bit integer.\n\
+@item int32\n\
+signed 32-bit integer.\n\
+@item int64\n\
+signed 64-bit integer.\n\
+@item uint8\n\
+unsigned 8-bit integer.\n\
+@item uint16\n\
+unsigned 16-bit integer.\n\
+@item uint32\n\
+unsigned 32-bit integer.\n\
+@item uint64\n\
+unsigned 64-bit integer.\n\
+@end table\n\
+\n\
+The default for @var{type} is @code{uint32}.\n\
+@seealso{intmax,bitmax}\n\
 @end deftypefn")
 {
   octave_value retval;