Mercurial > octave-antonio

comparison libinterp/octave-value/ov-fcn-inline.cc @ 20163:075a5e2e1ba5 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed build-aux, libinterp/dldfcn, libinterp/octave-value, libinterp/parse-tree directories. * build-aux/mk-opts.pl, libinterp/dldfcn/__magick_read__.cc, libinterp/dldfcn/amd.cc, libinterp/dldfcn/audiodevinfo.cc, libinterp/dldfcn/audioread.cc, libinterp/dldfcn/ccolamd.cc, libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc, libinterp/dldfcn/convhulln.cc, libinterp/dldfcn/dmperm.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc, libinterp/dldfcn/symrcm.cc, libinterp/octave-value/ov-base.cc, libinterp/octave-value/ov-bool-mat.cc, libinterp/octave-value/ov-cell.cc, libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-fcn-handle.cc, libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc, libinterp/octave-value/ov-null-mat.cc, libinterp/octave-value/ov-oncleanup.cc, libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc, libinterp/octave-value/ov-typeinfo.cc, libinterp/octave-value/ov-usr-fcn.cc, libinterp/octave-value/ov.cc, libinterp/parse-tree/lex.ll, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc: doc: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 21:52:42 -0700
parents 17d647821d61
children
comparison
equal deleted inserted replaced
20162:2645f9ef8c88 20163:075a5e2e1ba5
652 @deftypefn {Built-in Function} {} inline (@var{str})\n\ 652 @deftypefn {Built-in Function} {} inline (@var{str})\n\
653 @deftypefnx {Built-in Function} {} inline (@var{str}, @var{arg1}, @dots{})\n\ 653 @deftypefnx {Built-in Function} {} inline (@var{str}, @var{arg1}, @dots{})\n\
654 @deftypefnx {Built-in Function} {} inline (@var{str}, @var{n})\n\ 654 @deftypefnx {Built-in Function} {} inline (@var{str}, @var{n})\n\
655 Create an inline function from the character string @var{str}.\n\ 655 Create an inline function from the character string @var{str}.\n\
656 \n\ 656 \n\
657 If called with a single argument, the arguments of the generated\n\ 657 If called with a single argument, the arguments of the generated function\n\
658 function are extracted from the function itself. The generated\n\ 658 are extracted from the function itself. The generated function arguments\n\
659 function arguments will then be in alphabetical order. It should\n\ 659 will then be in alphabetical order. It should be noted that i and j are\n\
660 be noted that i, and j are ignored as arguments due to the\n\ 660 ignored as arguments due to the ambiguity between their use as a variable or\n\
661 ambiguity between their use as a variable or their use as an inbuilt\n\ 661 their use as an built-in constant. All arguments followed by a parenthesis\n\
662 constant. All arguments followed by a parenthesis are considered\n\ 662 are considered to be functions. If no arguments are found, a function\n\
663 to be functions. If no arguments are found, a function taking a single\n\ 663 taking a single argument named @code{x} will be created.\n\
664 argument named @code{x} will be created.\n\
665 \n\ 664 \n\
666 If the second and subsequent arguments are character strings,\n\ 665 If the second and subsequent arguments are character strings, they are the\n\
667 they are the names of the arguments of the function.\n\ 666 names of the arguments of the function.\n\
668 \n\ 667 \n\
669 If the second argument is an integer @var{n}, the arguments are\n\ 668 If the second argument is an integer @var{n}, the arguments are\n\
670 @qcode{\"x\"}, @qcode{\"P1\"}, @dots{}, @qcode{\"P@var{N}\"}.\n\ 669 @qcode{\"x\"}, @qcode{\"P1\"}, @dots{}, @qcode{\"P@var{N}\"}.\n\
671 \n\ 670 \n\
672 Programming Note: The use of @code{inline} is discouraged and it may be\n\ 671 Programming Note: The use of @code{inline} is discouraged and it may be\n\
902 */ 901 */
903 902
904 DEFUN (argnames, args, , 903 DEFUN (argnames, args, ,
905 "-*- texinfo -*-\n\ 904 "-*- texinfo -*-\n\
906 @deftypefn {Built-in Function} {} argnames (@var{fun})\n\ 905 @deftypefn {Built-in Function} {} argnames (@var{fun})\n\
907 Return a cell array of character strings containing the names of\n\ 906 Return a cell array of character strings containing the names of the\n\
908 the arguments of the inline function @var{fun}.\n\ 907 arguments of the inline function @var{fun}.\n\
909 @seealso{inline, formula, vectorize}\n\ 908 @seealso{inline, formula, vectorize}\n\
910 @end deftypefn") 909 @end deftypefn")
911 { 910 {
912 octave_value retval; 911 octave_value retval;
913 912
949 */ 948 */
950 949
951 DEFUN (vectorize, args, , 950 DEFUN (vectorize, args, ,
952 "-*- texinfo -*-\n\ 951 "-*- texinfo -*-\n\
953 @deftypefn {Built-in Function} {} vectorize (@var{fun})\n\ 952 @deftypefn {Built-in Function} {} vectorize (@var{fun})\n\
954 Create a vectorized version of the inline function @var{fun}\n\ 953 Create a vectorized version of the inline function @var{fun} by replacing\n\
955 by replacing all occurrences of @code{*}, @code{/}, etc., with\n\ 954 all occurrences of @code{*}, @code{/}, etc., with @code{.*}, @code{./}, etc.\n\
956 @code{.*}, @code{./}, etc.\n\
957 \n\ 955 \n\
958 This may be useful, for example, when using inline functions with\n\ 956 This may be useful, for example, when using inline functions with numerical\n\
959 numerical integration or optimization where a vector-valued function\n\ 957 integration or optimization where a vector-valued function is expected.\n\
960 is expected.\n\
961 \n\ 958 \n\
962 @example\n\ 959 @example\n\
963 @group\n\ 960 @group\n\
964 fcn = vectorize (inline (\"x^2 - 1\"))\n\ 961 fcn = vectorize (inline (\"x^2 - 1\"))\n\
965 @result{} fcn = f(x) = x.^2 - 1\n\ 962 @result{} fcn = f(x) = x.^2 - 1\n\