Mercurial > octave
comparison libinterp/octave-value/ov-usr-fcn.cc @ 21072:a9ed4104ecfd
doc: Rewrite documentation for Object Oriented Programming.
* octave.texi: Rename "Manipulating Classes" node to "Class Methods"
* oop.txi: Rewrite signicant parts of Object Oriented Programming chapter.
* examples/code/@FIRfilter/subsasgn.m, examples/code/@FIRfilter/subsref.m,
examples/code/@polynomial/get.m, examples/code/@polynomial/subsasgn.m:
Enclose property in error messages in double quotes ("%s").
* examples/code/@polynomial/subsref.m: Rename input object to 'p'.
Rename variable "ind" to "idx". Enclose property in error messages in double
quotes ("%s").
* ov-class.cc (Fsuperiorto, Finferiorto): Improve docstrings.
* ov-usr-fcn.cc (Foptimize_subsasgn_calls): Improve docstring.
* ov.cc (Fsubsref, Fsubsasgn): Improve docstrings.
* display.m: Rewrite docstring. Rename input variable to "obj". Remove unused
output variable from function declaration.
* subsindex.m: Rename input variable to "obj". Rewrite examples in docstring.
Add input validation and BIST tests to m-file.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 14 Jan 2016 13:30:22 -0800 |
parents | 93748bcaec17 |
children | e39e05d90788 |
comparison
equal
deleted
inserted
replaced
21071:f25c14056b7c | 21072:a9ed4104ecfd |
---|---|
985 DEFUN (optimize_subsasgn_calls, args, nargout, | 985 DEFUN (optimize_subsasgn_calls, args, nargout, |
986 "-*- texinfo -*-\n\ | 986 "-*- texinfo -*-\n\ |
987 @deftypefn {} {@var{val} =} optimize_subsasgn_calls ()\n\ | 987 @deftypefn {} {@var{val} =} optimize_subsasgn_calls ()\n\ |
988 @deftypefnx {} {@var{old_val} =} optimize_subsasgn_calls (@var{new_val})\n\ | 988 @deftypefnx {} {@var{old_val} =} optimize_subsasgn_calls (@var{new_val})\n\ |
989 @deftypefnx {} {} optimize_subsasgn_calls (@var{new_val}, \"local\")\n\ | 989 @deftypefnx {} {} optimize_subsasgn_calls (@var{new_val}, \"local\")\n\ |
990 Query or set the internal flag for subsasgn method call optimizations.\n\ | 990 Query or set the internal flag for @code{subsasgn} method call\n\ |
991 optimizations.\n\ | |
991 \n\ | 992 \n\ |
992 If true, Octave will attempt to eliminate the redundant copying when calling\n\ | 993 If true, Octave will attempt to eliminate the redundant copying when calling\n\ |
993 the subsasgn method of a user-defined class.\n\ | 994 the @code{subsasgn} method of a user-defined class.\n\ |
994 \n\ | 995 \n\ |
995 When called from inside a function with the @qcode{\"local\"} option, the\n\ | 996 When called from inside a function with the @qcode{\"local\"} option, the\n\ |
996 variable is changed locally for the function and any subroutines it calls.\n\ | 997 variable is changed locally for the function and any subroutines it calls.\n\ |
997 The original variable value is restored when exiting the function.\n\ | 998 The original variable value is restored when exiting the function.\n\ |
999 @seealso{subsasgn}\n\ | |
998 @end deftypefn") | 1000 @end deftypefn") |
999 { | 1001 { |
1000 return SET_INTERNAL_VARIABLE (optimize_subsasgn_calls); | 1002 return SET_INTERNAL_VARIABLE (optimize_subsasgn_calls); |
1001 } | 1003 } |
1002 | 1004 |