Mercurial > hg > octave-lyh
annotate scripts/general/rat.m @ 14872:c2dbdeaa25df
maint: use rows() and columns() to clarify m-files.
* gradient.m, interp1q.m, rat.m, tsearchn.m, image.m, imwrite.m, area.m,
contourc.m, hist.m, isocolors.m, isonormals.m, meshz.m, print.m, __bar__.m,
__go_draw_axes__.m, __interp_cube__.m, __marching_cube__.m, __patch__.m,
__print_parse_opts__.m, __quiver__.m, rose.m, shrinkfaces.m, stairs.m,
surfnorm.m, tetramesh.m, text.m, deconv.m, spline.m, intersect.m, setdiff.m,
setxor.m, union.m, periodogram.m, pcg.m, perms.m: Replace size (x,1) with
rows (x) and size(x,2) with columns(x).
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 17 Jul 2012 13:34:19 -0700 |
parents | 5d3a684236b0 |
children |
rev | line source |
---|---|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
12795
diff
changeset
|
1 ## Copyright (C) 2001-2012 Paul Kienzle |
6788 | 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. | |
6788 | 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/>. | |
6788 | 18 |
19 ## -*- texinfo -*- | |
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
20 ## @deftypefn {Function File} {@var{s} =} rat (@var{x}, @var{tol}) |
6788 | 21 ## @deftypefnx {Function File} {[@var{n}, @var{d}] =} rat (@var{x}, @var{tol}) |
22 ## | |
9039
51dc9691f23f
Cleanup documentation files errors.texi, debug.texi, io.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
23 ## Find a rational approximation to @var{x} within the tolerance defined |
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
24 ## by @var{tol} using a continued fraction expansion. For example: |
6788 | 25 ## |
26 ## @example | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
27 ## @group |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
28 ## rat (pi) = 3 + 1/(7 + 1/16) = 355/113 |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
29 ## rat (e) = 3 + 1/(-4 + 1/(2 + 1/(5 + 1/(-2 + 1/(-7))))) |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
30 ## = 1457/536 |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9039
diff
changeset
|
31 ## @end group |
6788 | 32 ## @end example |
33 ## | |
7001 | 34 ## Called with two arguments returns the numerator and denominator separately |
6788 | 35 ## as two matrices. |
12185
862a8e490445
doc fix for rational approximation functions
John W. Eaton <jwe@octave.org>
parents:
11589
diff
changeset
|
36 ## @seealso{rats} |
6788 | 37 ## @end deftypefn |
38 | |
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
39 function [n,d] = rat (x,tol) |
6788 | 40 |
41 if (nargin != [1,2] || nargout > 2) | |
42 print_usage (); | |
43 endif | |
44 | |
45 y = x(:); | |
46 | |
8506 | 47 ## Replace Inf with 0 while calculating ratios. |
6788 | 48 y(isinf(y)) = 0; |
49 | |
50 ## default norm | |
51 if (nargin < 2) | |
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
52 tol = 1e-6 * norm (y,1); |
6788 | 53 endif |
54 | |
55 ## First step in the approximation is the integer portion | |
8506 | 56 |
57 ## First element in the continued fraction. | |
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
58 n = round (y); |
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
59 d = ones (size (y)); |
6788 | 60 frac = y-n; |
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
61 lastn = ones (size (y)); |
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
62 lastd = zeros (size (y)); |
6788 | 63 |
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
64 nd = ndims (y); |
6967 | 65 nsz = numel (y); |
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
66 steps = zeros ([nsz, 0]); |
6788 | 67 |
8506 | 68 ## Grab new factors until all continued fractions converge. |
6788 | 69 while (1) |
8506 | 70 ## Determine which fractions have not yet converged. |
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
71 idx = find (abs (y-n./d) >= tol); |
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
72 if (isempty (idx)) |
7881
f74669a09deb
rat.m: handle arrays and all-integer inputs
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
73 if (isempty (steps)) |
10549 | 74 steps = NaN (nsz, 1); |
7881
f74669a09deb
rat.m: handle arrays and all-integer inputs
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
75 endif |
f74669a09deb
rat.m: handle arrays and all-integer inputs
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
76 break; |
f74669a09deb
rat.m: handle arrays and all-integer inputs
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
77 endif |
6788 | 78 |
8506 | 79 ## Grab the next step in the continued fraction. |
6788 | 80 flip = 1./frac(idx); |
8506 | 81 ## Next element in the continued fraction. |
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
82 step = round (flip); |
6788 | 83 |
84 if (nargout < 2) | |
10540
952d4df5b686
Eliminate NaN*ones and Inf*ones constructs and just use Nan() and Inf()
Rik <code@nomad.inbox5.com>
parents:
9051
diff
changeset
|
85 tsteps = NaN (nsz, 1); |
6788 | 86 tsteps (idx) = step; |
87 steps = [steps, tsteps]; | |
88 endif | |
89 | |
90 frac(idx) = flip-step; | |
91 | |
8506 | 92 ## Update the numerator/denominator. |
6788 | 93 nextn = n; |
94 nextd = d; | |
95 n(idx) = n(idx).*step + lastn(idx); | |
96 d(idx) = d(idx).*step + lastd(idx); | |
97 lastn = nextn; | |
98 lastd = nextd; | |
99 endwhile | |
100 | |
101 if (nargout == 2) | |
8506 | 102 ## Move the minus sign to the top. |
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
103 n = n .* sign (d); |
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
104 d = abs (d); |
6788 | 105 |
8506 | 106 ## Return the same shape as you receive. |
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
107 n = reshape (n, size (x)); |
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
108 d = reshape (d, size (x)); |
6788 | 109 |
8506 | 110 ## Use 1/0 for Inf. |
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
111 n(isinf (x)) = sign (x(isinf (x))); |
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
112 d(isinf (x)) = 0; |
6788 | 113 |
8506 | 114 ## Reshape the output. |
6788 | 115 n = reshape (n, size (x)); |
116 d = reshape (d, size (x)); | |
117 else | |
118 n = ""; | |
14872
c2dbdeaa25df
maint: use rows() and columns() to clarify m-files.
Rik <octave@nomad.inbox5.com>
parents:
14868
diff
changeset
|
119 nsteps = columns (steps); |
6788 | 120 for i = 1: nsz |
121 s = [int2str(y(i))," "]; | |
122 j = 1; | |
123 | |
124 while (true) | |
10549 | 125 step = steps(i, j++); |
126 if (isnan (step)) | |
127 break; | |
128 endif | |
129 if (j > nsteps || isnan (steps(i, j))) | |
130 if (step < 0) | |
131 s = [s(1:end-1), " + 1/(", int2str(step), ")"]; | |
132 else | |
133 s = [s(1:end-1), " + 1/", int2str(step)]; | |
134 endif | |
135 break; | |
136 else | |
137 s = [s(1:end-1), " + 1/(", int2str(step), ")"]; | |
6788 | 138 endif |
139 endwhile | |
140 s = [s, repmat(")", 1, j-2)]; | |
7881
f74669a09deb
rat.m: handle arrays and all-integer inputs
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
141 n_nc = columns (n); |
f74669a09deb
rat.m: handle arrays and all-integer inputs
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
142 s_nc = columns (s); |
f74669a09deb
rat.m: handle arrays and all-integer inputs
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
143 if (n_nc > s_nc) |
11589
b0084095098e
missing semicolons in script files
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
144 s(:,s_nc+1:n_nc) = " "; |
7881
f74669a09deb
rat.m: handle arrays and all-integer inputs
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
145 elseif (s_nc > n_nc) |
10549 | 146 n(:,n_nc+1:s_nc) = " "; |
7881
f74669a09deb
rat.m: handle arrays and all-integer inputs
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
147 endif |
6788 | 148 n = cat (1, n, s); |
149 endfor | |
150 endif | |
151 | |
152 endfunction | |
12795
9e7ebbaf69ff
codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents:
12185
diff
changeset
|
153 |
9e7ebbaf69ff
codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents:
12185
diff
changeset
|
154 |
9e7ebbaf69ff
codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents:
12185
diff
changeset
|
155 %!test |
9e7ebbaf69ff
codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents:
12185
diff
changeset
|
156 %! [n, d] = rat ([0.5, 0.3, 1/3]); |
9e7ebbaf69ff
codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents:
12185
diff
changeset
|
157 %! assert (n, [1, 3, 1]); |
9e7ebbaf69ff
codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents:
12185
diff
changeset
|
158 %! assert (d, [2, 10, 3]); |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
159 |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
160 %!error rat (); |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
161 %!error rat (1, 2, 3); |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
162 |