Mercurial > hg > octave-nkf
annotate scripts/signal/unwrap.m @ 20818:9d2023d1a63c
binoinv.m: Implement binary search algorithm for 28X performance increase (bug #34363).
* binoinv.m: Call new functions scalar_binoinv or vector_binoinv to calculate
binoinv. If there are still uncalculated values then call bin_search_binoinv
to perform binary search for remaining values. Add more BIST tests.
* binoinv.m (scalar_binoinv): New subfunction to calculate binoinv for scalar x.
Stops when x > 1000.
* binoinv.m (vector_binoinv): New subfunction to calculate binoinv for scalar x.
Stops when x > 1000.
author | Lachlan Andrew <lachlanbis@gmail.com> |
---|---|
date | Sun, 11 Oct 2015 19:49:40 -0700 |
parents | f1d0f506ee78 |
children |
rev | line source |
---|---|
19898
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
1 ## Copyright (C) 2000-2015 Bill Lash |
3942 | 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. | |
3942 | 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/>. | |
3942 | 18 |
19 ## -*- texinfo -*- | |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
20 ## @deftypefn {Function File} {@var{b} =} unwrap (@var{x}) |
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
21 ## @deftypefnx {Function File} {@var{b} =} unwrap (@var{x}, @var{tol}) |
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
22 ## @deftypefnx {Function File} {@var{b} =} unwrap (@var{x}, @var{tol}, @var{dim}) |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
23 ## |
20375
f1d0f506ee78
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20038
diff
changeset
|
24 ## Unwrap radian phases by adding multiples of 2*pi as appropriate to remove |
f1d0f506ee78
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20038
diff
changeset
|
25 ## jumps greater than @var{tol}. |
f1d0f506ee78
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20038
diff
changeset
|
26 ## |
f1d0f506ee78
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20038
diff
changeset
|
27 ## @var{tol} defaults to pi. |
3942 | 28 ## |
10711
fbd7843974fa
Periodic grammar check of documentation files to ensure common format.
Rik <octave@nomad.inbox5.com>
parents:
10690
diff
changeset
|
29 ## Unwrap will work along the dimension @var{dim}. If @var{dim} |
10690
35adf2a71f3f
Use common code block to find first non-singleton dimension.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
30 ## is unspecified it defaults to the first non-singleton dimension. |
3942 | 31 ## @end deftypefn |
32 | |
33 ## Author: Bill Lash <lash@tellabs.com> | |
34 | |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
35 function retval = unwrap (x, tol, dim) |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
36 |
3942 | 37 if (nargin < 1 || nargin > 3) |
6046 | 38 print_usage (); |
3942 | 39 endif |
40 | |
20038
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
41 if (! isnumeric (x)) |
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
11471
diff
changeset
|
42 error ("unwrap: X must be a numeric matrix or vector"); |
3942 | 43 endif |
44 | |
4862 | 45 if (nargin < 2 || isempty (tol)) |
3942 | 46 tol = pi; |
47 endif | |
48 | |
49 ## Don't let anyone use a negative value for TOL. | |
50 tol = abs (tol); | |
10690
35adf2a71f3f
Use common code block to find first non-singleton dimension.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
51 |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
52 nd = ndims (x); |
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
53 sz = size (x); |
10690
35adf2a71f3f
Use common code block to find first non-singleton dimension.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
54 if (nargin == 3) |
11149
fe3c3dfc07eb
style fix: break lines before && and ||, not after
John W. Eaton <jwe@octave.org>
parents:
10711
diff
changeset
|
55 if (!(isscalar (dim) && dim == fix (dim)) |
fe3c3dfc07eb
style fix: break lines before && and ||, not after
John W. Eaton <jwe@octave.org>
parents:
10711
diff
changeset
|
56 || !(1 <= dim && dim <= nd)) |
10690
35adf2a71f3f
Use common code block to find first non-singleton dimension.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
57 error ("unwrap: DIM must be an integer and a valid dimension"); |
35adf2a71f3f
Use common code block to find first non-singleton dimension.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
58 endif |
35adf2a71f3f
Use common code block to find first non-singleton dimension.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
59 else |
12674
9493880928c8
Use common idiom in m-files for finding first non-singleton dimension.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
60 ## Find the first non-singleton dimension. |
9493880928c8
Use common idiom in m-files for finding first non-singleton dimension.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
61 (dim = find (sz > 1, 1)) || (dim = 1); |
10690
35adf2a71f3f
Use common code block to find first non-singleton dimension.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
62 endif |
35adf2a71f3f
Use common code block to find first non-singleton dimension.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
63 |
3942 | 64 rng = 2*pi; |
7208 | 65 m = sz(dim); |
3942 | 66 |
67 ## Handle case where we are trying to unwrap a scalar, or only have | |
68 ## one sample in the specified dimension. | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
69 if (m == 1) |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
70 retval = x; |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
71 return; |
3942 | 72 endif |
73 | |
74 ## Take first order difference to see so that wraps will show up | |
75 ## as large values, and the sign will show direction. | |
12676
2783fa95cab7
Use common code idiom for creating cell array for indexing ND-arrays
Rik <octave@nomad.inbox5.com>
parents:
12674
diff
changeset
|
76 idx = repmat ({':'}, nd, 1); |
7208 | 77 idx{dim} = [1,1:m-1]; |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
78 d = x(idx{:}) - x; |
3942 | 79 |
12904
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
80 ## Find only the peaks, and multiply them by the appropriate amount |
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
81 ## of ranges so that there are kronecker deltas at each wrap point |
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
82 ## multiplied by the appropriate amount of range values. |
20038
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
83 p = ceil (abs (d)./rng) .* rng .* (((d > tol) > 0) - ((d < -tol) > 0)); |
3942 | 84 |
85 ## Now need to "integrate" this so that the deltas become steps. | |
4862 | 86 r = cumsum (p, dim); |
3942 | 87 |
88 ## Now add the "steps" to the original data and put output in the | |
89 ## same shape as originally. | |
11471
994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
Rik <octave@nomad.inbox5.com>
parents:
11149
diff
changeset
|
90 retval = x + r; |
3942 | 91 |
92 endfunction | |
7411 | 93 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
94 |
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
95 %!function t = __xassert (a,b,tol) |
7411 | 96 %! if (nargin == 1) |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
97 %! t = all (a(:)); |
7411 | 98 %! else |
99 %! if (nargin == 2) | |
100 %! tol = 0; | |
101 %! endif | |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
102 %! if (any (size (a) != size (b))) |
7411 | 103 %! t = 0; |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
104 %! elseif (any (abs (a(:) - b(:)) > tol)) |
7411 | 105 %! t = 0; |
106 %! else | |
107 %! t = 1; | |
108 %! endif | |
109 %! endif | |
13305
63463570d9fe
Add %!endfunction block keyword to test.m
Rik <octave@nomad.inbox5.com>
parents:
12904
diff
changeset
|
110 %!endfunction |
7411 | 111 %! |
112 %!test | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
113 %! |
7411 | 114 %! i = 0; |
115 %! t = []; | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
116 %! |
7411 | 117 %! r = [0:100]; # original vector |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
118 %! w = r - 2*pi*floor ((r+pi)/(2*pi)); # wrapped into [-pi,pi] |
7411 | 119 %! tol = 1e3*eps; # maximum expected deviation |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
120 %! |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
121 %! t(++i) = __xassert (r, unwrap (w), tol); #unwrap single row |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
122 %! t(++i) = __xassert (r', unwrap (w'), tol); #unwrap single column |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
123 %! t(++i) = __xassert ([r',r'], unwrap ([w',w']), tol); #unwrap 2 columns |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
124 %! t(++i) = __xassert ([r;r], unwrap ([w;w],[],2), tol); #check that dim works |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
125 %! t(++i) = __xassert (r+10, unwrap (10+w), tol); #check r(1)>pi works |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
126 %! |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
127 %! t(++i) = __xassert (w', unwrap (w',[],2)); #unwrap col by rows should not change it |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
128 %! t(++i) = __xassert (w, unwrap (w,[],1)); #unwrap row by cols should not change it |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
129 %! t(++i) = __xassert ([w;w], unwrap ([w;w])); #unwrap 2 rows by cols should not change them |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
130 %! |
7411 | 131 %! ## verify that setting tolerance too low will cause bad results. |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
132 %! t(++i) = __xassert (any (abs (r - unwrap (w,0.8)) > 100)); |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
133 %! |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
134 %! assert (all (t)); |
12904
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
135 %! |
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
136 %!test |
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
137 %! A = [pi*(-4), pi*(-2+1/6), pi/4, pi*(2+1/3), pi*(4+1/2), pi*(8+2/3), pi*(16+1), pi*(32+3/2), pi*64]; |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
138 %! assert (unwrap (A), unwrap (A, pi)); |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
139 %! assert (unwrap (A, pi), unwrap (A, pi, 2)); |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
140 %! assert (unwrap (A', pi), unwrap (A', pi, 1)); |
12904
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
141 %! |
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
142 %!test |
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
143 %! A = [pi*(-4); pi*(2+1/3); pi*(16+1)]; |
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
144 %! B = [pi*(-2+1/6); pi*(4+1/2); pi*(32+3/2)]; |
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
145 %! C = [pi/4; pi*(8+2/3); pi*64]; |
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
146 %! D = [pi*(-2+1/6); pi*(2+1/3); pi*(8+2/3)]; |
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
147 %! E(:, :, 1) = [A, B, C, D]; |
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
148 %! E(:, :, 2) = [A+B, B+C, C+D, D+A]; |
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
149 %! F(:, :, 1) = [unwrap(A), unwrap(B), unwrap(C), unwrap(D)]; |
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
150 %! F(:, :, 2) = [unwrap(A+B), unwrap(B+C), unwrap(C+D), unwrap(D+A)]; |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
151 %! assert (unwrap (E), F); |
12904
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
152 %! |
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
153 %!test |
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
154 %! A = [0, 2*pi, 4*pi, 8*pi, 16*pi, 65536*pi]; |
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
155 %! B = [pi*(-2+1/6), pi/4, pi*(2+1/3), pi*(4+1/2), pi*(8+2/3), pi*(16+1), pi*(32+3/2), pi*64]; |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
156 %! assert (unwrap (A), zeros (1, length (A))); |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
157 %! assert (diff (unwrap (B), 1) < 2*pi, true (1, length (B)-1)); |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
158 |
12904
7cdf39348879
unwrap.m: Fix incorrect behavior when unwrapping gaps larger then 2*pi with tests for it (Bug #33883)
Andriy Shinkarchuck <adriano32.gnu@gmail.com>
parents:
12676
diff
changeset
|
159 %!error unwrap() |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
160 |