annotate scripts/legacy/@inline/vectorize.m @ 32632:2e484f9f1f18 stable

maint: update Octave Project Developers copyright for the new year
author John W. Eaton <jwe@octave.org>
date Fri, 22 Dec 2023 12:08:17 -0500
parents 597f3ee61a48
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
28459
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
1 ########################################################################
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
2 ##
32632
2e484f9f1f18 maint: update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 31706
diff changeset
3 ## Copyright (C) 2020-2024 The Octave Project Developers
28459
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
4 ##
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
5 ## See the file COPYRIGHT.md in the top-level directory of this
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
6 ## distribution or <https://octave.org/copyright/>.
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
7 ##
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
8 ## This file is part of Octave.
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
9 ##
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
10 ## Octave is free software: you can redistribute it and/or modify it
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
11 ## under the terms of the GNU General Public License as published by
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
12 ## the Free Software Foundation, either version 3 of the License, or
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
13 ## (at your option) any later version.
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
14 ##
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
15 ## Octave is distributed in the hope that it will be useful, but
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
18 ## GNU General Public License for more details.
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
19 ##
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
20 ## You should have received a copy of the GNU General Public License
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
21 ## along with Octave; see the file COPYING. If not, see
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
22 ## <https://www.gnu.org/licenses/>.
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
23 ##
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
24 ########################################################################
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28456
diff changeset
25
28427
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
26 ## -*- texinfo -*-
30911
b7edac56a810 Add functions to @inline class for Matlab compatibility (Bug #62260).
Rik <rik@octave.org>
parents: 30910
diff changeset
27 ## @deftypefn {} {@var{vfcn} =} vectorize (@var{fobj})
b7edac56a810 Add functions to @inline class for Matlab compatibility (Bug #62260).
Rik <rik@octave.org>
parents: 30910
diff changeset
28 ## Create a vectorized version of the inline function @var{fobj} by
28427
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
29 ## replacing all occurrences of @code{*}, @code{/}, etc., with
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
30 ## @code{.*}, @code{./}, etc.
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
31 ##
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
32 ## This may be useful, for example, when using inline functions with
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
33 ## numerical integration or optimization where a vector-valued function
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
34 ## is expected.
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35 ##
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36 ## @example
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37 ## @group
30911
b7edac56a810 Add functions to @inline class for Matlab compatibility (Bug #62260).
Rik <rik@octave.org>
parents: 30910
diff changeset
38 ## fobj = vectorize (inline ("x^2 - 1"))
b7edac56a810 Add functions to @inline class for Matlab compatibility (Bug #62260).
Rik <rik@octave.org>
parents: 30910
diff changeset
39 ## @result{} fobj = f(x) = x.^2 - 1
b7edac56a810 Add functions to @inline class for Matlab compatibility (Bug #62260).
Rik <rik@octave.org>
parents: 30910
diff changeset
40 ## quadv (fobj, 0, 3)
28427
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41 ## @result{} 6
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
42 ## @end group
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43 ## @end example
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
44 ## @seealso{inline, formula, argnames}
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
45 ## @end deftypefn
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
46
30911
b7edac56a810 Add functions to @inline class for Matlab compatibility (Bug #62260).
Rik <rik@octave.org>
parents: 30910
diff changeset
47 function vfcn = vectorize (fobj)
28427
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
48
30911
b7edac56a810 Add functions to @inline class for Matlab compatibility (Bug #62260).
Rik <rik@octave.org>
parents: 30910
diff changeset
49 vfcn = inline (__vectorize__ (fobj.expr));
28427
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
50
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
51 endfunction