Mercurial > octave

comparison libinterp/corefcn/pr-output.cc @ 18433:812162c34a93 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improve docstring for fixed_point_format(). * pr-output.cc (Ffixed_point_format): Improve docstring.
author Rik <rik@octave.org>
date Tue, 04 Feb 2014 14:07:49 -0800
parents 5ac0545fb4c0
children e76d50d65278 97eea1e2d9ff c490eac28bbb
comparison
equal deleted inserted replaced
18432:c71cbbae9443 18433:812162c34a93
3977 "-*- texinfo -*-\n\ 3977 "-*- texinfo -*-\n\
3978 @deftypefn {Built-in Function} {@var{val} =} fixed_point_format ()\n\ 3978 @deftypefn {Built-in Function} {@var{val} =} fixed_point_format ()\n\
3979 @deftypefnx {Built-in Function} {@var{old_val} =} fixed_point_format (@var{new_val})\n\ 3979 @deftypefnx {Built-in Function} {@var{old_val} =} fixed_point_format (@var{new_val})\n\
3980 @deftypefnx {Built-in Function} {} fixed_point_format (@var{new_val}, \"local\")\n\ 3980 @deftypefnx {Built-in Function} {} fixed_point_format (@var{new_val}, \"local\")\n\
3981 Query or set the internal variable that controls whether Octave will\n\ 3981 Query or set the internal variable that controls whether Octave will\n\
3982 use a scaled format to print matrix values such that the largest\n\ 3982 use a scaled format to print matrix values.\n\
3983 element may be written with a single leading digit with the scaling\n\ 3983 \n\
3984 factor is printed on the first line of output. For example:\n\ 3984 The scaled format prints a scaling factor on the first line of output chosen\n\
3985 such that the largest matrix element can be written with a single leading\n\
3986 digit. For example:\n\
3985 \n\ 3987 \n\
3986 @example\n\ 3988 @example\n\
3987 @group\n\ 3989 @group\n\
3988 octave:1> logspace (1, 7, 5)'\n\ 3990 logspace (1, 7, 5)'\n\
3989 ans =\n\ 3991 ans =\n\
3990 \n\ 3992 \n\
3991 1.0e+07 *\n\ 3993 1.0e+07 *\n\
3992 \n\ 3994 \n\
3993 0.00000\n\ 3995 0.00000\n\
3997 1.00000\n\ 3999 1.00000\n\
3998 @end group\n\ 4000 @end group\n\
3999 @end example\n\ 4001 @end example\n\
4000 \n\ 4002 \n\
4001 @noindent\n\ 4003 @noindent\n\
4002 Notice that first value appears to be zero when it is actually 1. For\n\ 4004 Notice that the first value appears to be 0 when it is actually 1. Because\n\
4003 this reason, you should be careful when setting\n\ 4005 of the possibilty for confusion you should be careful about enabling\n\
4004 @code{fixed_point_format} to a nonzero value.\n\ 4006 @code{fixed_point_format}.\n\
4005 \n\ 4007 \n\
4006 When called from inside a function with the @qcode{\"local\"} option, the\n\ 4008 When called from inside a function with the @qcode{\"local\"} option, the\n\
4007 variable is changed locally for the function and any subroutines it calls. \n\ 4009 variable is changed locally for the function and any subroutines it calls. \n\
4008 The original variable value is restored when exiting the function.\n\ 4010 The original variable value is restored when exiting the function.\n\
4009 @seealso{format, output_max_field_width, output_precision}\n\ 4011 @seealso{format, output_max_field_width, output_precision}\n\