Mercurial > octave-nkf
annotate scripts/general/cumtrapz.m @ 20652:a3b9ee5c040a
Replace bsxfun with broadcasting for performance with complex inputs (bug #38628).
cumtrapz.m, quadgk.m, trapz.m, center.m, zscore.m: Replace bsxfun with
broadcasting for performance where inputs might be complex.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 12 Oct 2015 21:28:32 -0700 |
parents | 7503499a252b |
children |
rev | line source |
---|---|
19731
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
1 ## Copyright (C) 2000-2015 Kai Habel |
5820 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
8 ## your option) any later version. | |
5820 | 9 ## |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 ## General Public License for more details. | |
14 ## | |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
5820 | 18 |
19 ## -*- texinfo -*- | |
12612
16cca721117b
doc: Update all documentation for chapter on Numerical Integration
Rik <octave@nomad.inbox5.com>
parents:
12575
diff
changeset
|
20 ## @deftypefn {Function File} {@var{q} =} cumtrapz (@var{y}) |
16cca721117b
doc: Update all documentation for chapter on Numerical Integration
Rik <octave@nomad.inbox5.com>
parents:
12575
diff
changeset
|
21 ## @deftypefnx {Function File} {@var{q} =} cumtrapz (@var{x}, @var{y}) |
16cca721117b
doc: Update all documentation for chapter on Numerical Integration
Rik <octave@nomad.inbox5.com>
parents:
12575
diff
changeset
|
22 ## @deftypefnx {Function File} {@var{q} =} cumtrapz (@dots{}, @var{dim}) |
16cca721117b
doc: Update all documentation for chapter on Numerical Integration
Rik <octave@nomad.inbox5.com>
parents:
12575
diff
changeset
|
23 ## Cumulative numerical integration of points @var{y} using the trapezoidal |
16cca721117b
doc: Update all documentation for chapter on Numerical Integration
Rik <octave@nomad.inbox5.com>
parents:
12575
diff
changeset
|
24 ## method. |
20193
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19867
diff
changeset
|
25 ## |
12612
16cca721117b
doc: Update all documentation for chapter on Numerical Integration
Rik <octave@nomad.inbox5.com>
parents:
12575
diff
changeset
|
26 ## @w{@code{cumtrapz (@var{y})}} computes the cumulative integral of @var{y} |
20193
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19867
diff
changeset
|
27 ## along the first non-singleton dimension. Where @code{trapz} reports only |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19867
diff
changeset
|
28 ## the overall integral sum, @code{cumtrapz} reports the current partial sum |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19867
diff
changeset
|
29 ## value at each point of @var{y}. |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
30 ## |
20193
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19867
diff
changeset
|
31 ## When the argument @var{x} is omitted an equally spaced @var{x} vector with |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19867
diff
changeset
|
32 ## unit spacing (1) is assumed. @code{cumtrapz (@var{x}, @var{y})} evaluates |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19867
diff
changeset
|
33 ## the integral with respect to the spacing in @var{x} and the values in |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19867
diff
changeset
|
34 ## @var{y}. This is useful if the points in @var{y} have been sampled unevenly. |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19867
diff
changeset
|
35 ## |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19867
diff
changeset
|
36 ## If the optional @var{dim} argument is given, operate along this dimension. |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19867
diff
changeset
|
37 ## |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19867
diff
changeset
|
38 ## Application Note: If @var{x} is not specified then unit spacing will be |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19867
diff
changeset
|
39 ## used. To scale the integral to the correct value you must multiply by the |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19867
diff
changeset
|
40 ## actual spacing value (deltaX). |
12575
d0b799dafede
Grammarcheck files for 3.4.1 release.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
41 ## @seealso{trapz, cumsum} |
5820 | 42 ## @end deftypefn |
43 | |
10549 | 44 ## Author: Kai Habel <kai.habel@gmx.de> |
5820 | 45 ## |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
46 ## also: June 2000 Paul Kienzle (fixes,suggestions) |
5820 | 47 ## 2006-05-12 David Bateman - Modified for NDArrays |
48 | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
49 function z = cumtrapz (x, y, dim) |
5820 | 50 |
51 if (nargin < 1) || (nargin > 3) | |
6046 | 52 print_usage (); |
5820 | 53 endif |
54 | |
12667
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
55 have_xy = have_dim = false; |
5820 | 56 |
57 if (nargin == 3) | |
12667
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
58 have_xy = true; |
5820 | 59 have_dim = true; |
10690
35adf2a71f3f
Use common code block to find first non-singleton dimension.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
60 elseif (nargin == 2) |
6157 | 61 if (! size_equal (x, y) && isscalar (y)) |
5820 | 62 dim = y; |
63 have_dim = true; | |
64 else | |
12667
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
65 have_xy = true; |
5820 | 66 endif |
67 endif | |
68 | |
12667
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
69 if (have_xy) |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
70 nd = ndims (y); |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
71 sz = size (y); |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
72 else |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
73 nd = ndims (x); |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
74 sz = size (x); |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
75 endif |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
76 |
5820 | 77 if (! have_dim) |
10690
35adf2a71f3f
Use common code block to find first non-singleton dimension.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
78 ## Find the first non-singleton dimension. |
12667
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
79 (dim = find (sz > 1, 1)) || (dim = 1); |
5820 | 80 else |
12667
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
81 if (!(isscalar (dim) && dim == fix (dim)) |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
82 || !(1 <= dim && dim <= nd)) |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
83 error ("trapz: DIM must be an integer and a valid dimension"); |
5820 | 84 endif |
85 endif | |
86 | |
87 n = sz(dim); | |
12675
2e9cf640379b
trapz.m, cumtrapz.m: Quote ':' in initialization statement to prevent it being
Rik <octave@nomad.inbox5.com>
parents:
12667
diff
changeset
|
88 idx1 = idx2 = repmat ({':'}, [nd, 1]); |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
89 idx1{dim} = 2 : n; |
5820 | 90 idx2{dim} = 1 : (n - 1); |
91 | |
12667
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
92 if (! have_xy) |
5820 | 93 z = 0.5 * cumsum (x(idx1{:}) + x(idx2{:}), dim); |
94 else | |
19867
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
95 if (isvector (x) && ! isvector (y)) |
12667
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
96 if (length (x) != sz(dim)) |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
97 error ("cumtrapz: length of X and length of Y along DIM must match"); |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
98 endif |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
99 ## Reshape vector to point along dimension DIM |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
100 shape = ones (nd, 1); |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
101 shape(dim) = sz(dim); |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
102 x = reshape (x, shape); |
20652
a3b9ee5c040a
Replace bsxfun with broadcasting for performance with complex inputs (bug #38628).
Rik <rik@octave.org>
parents:
20193
diff
changeset
|
103 z = 0.5 * cumsum (diff (x) .* (y(idx1{:}) + y(idx2{:})), dim); |
12667
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
104 else |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
105 if (! size_equal (x, y)) |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
106 error ("cumtrapz: X and Y must have same shape"); |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
107 endif |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
108 z = 0.5 * cumsum (diff (x, 1, dim) .* (y(idx1{:}) + y(idx2{:})), dim); |
5820 | 109 endif |
110 endif | |
111 | |
112 sz(dim) = 1; | |
113 z = cat (dim, zeros (sz), z); | |
114 | |
115 endfunction | |
116 | |
12667
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
117 |
5820 | 118 %!shared x1,x2,y |
119 %! x1 = [0,0,0;2,2,2]; | |
120 %! x2 = [0,2,4;0,2,4]; | |
121 %! y = [1,2,3;4,5,6]; | |
19867
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
122 %! |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
123 %!assert (cumtrapz (y), [0,0,0;2.5,3.5,4.5]) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
124 %!assert (cumtrapz (x1,y), [0,0,0;5,7,9]) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
125 %!assert (cumtrapz (y,1), [0,0,0;2.5,3.5,4.5]) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
126 %!assert (cumtrapz (x1,y,1), [0,0,0;5,7,9]) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
127 %!assert (cumtrapz (y,2), [0,1.5,4;0,4.5,10]) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
128 %!assert (cumtrapz (x2,y,2), [0,3,8;0,9,20]) |
19867
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
129 |
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
130 ## Test ND-array implementation |
12667
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
131 %!shared x1,x2,y |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
132 %! x1 = 1:3; |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
133 %! x2 = reshape ([0,2,4;0,2,4], [1 2 3]); |
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
134 %! y = reshape ([1,2,3;4,5,6], [1 2 3]); |
19867
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
135 %! |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
136 %!assert (cumtrapz (y,3), reshape ([0,1.5,4;0,4.5,10],[1 2 3])) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
137 %!assert (cumtrapz (x1,y,3), reshape ([0,1.5,4;0,4.5,10],[1 2 3])) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
138 %!assert (cumtrapz (x2,y,3), reshape ([0,3,8;0,9,20],[1 2 3])) |
12667
d8aff843a9e9
Accept input x vector with y matrix for trapz,cumtrapz (bug #33292).
Rik <octave@nomad.inbox5.com>
parents:
12642
diff
changeset
|
139 |