annotate scripts/testfun/speed.m @ 11587:c792872f8942

all script files: untabify and strip trailing whitespace
author John W. Eaton <jwe@octave.org>
date Thu, 20 Jan 2011 17:35:29 -0500
parents fd0a3ac60b0e
children 1ca3cde15b18
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11523
fd0a3ac60b0e update copyright notices
John W. Eaton <jwe@octave.org>
parents: 11342
diff changeset
1 ## Copyright (C) 2000-2011 Paul Kienzle
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
2 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
3 ## This file is part of Octave.
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
4 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
6 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
8 ## your option) any later version.
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
9 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
13 ## General Public License for more details.
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
14 ##
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
18
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
20 ## @deftypefn {Function File} {} speed (@var{f}, @var{init}, @var{max_n}, @var{f2}, @var{tol})
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
21 ## @deftypefnx {Function File} {[@var{order}, @var{n}, @var{T_f}, @var{T_f2}] =} speed (@dots{})
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
22 ##
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
23 ## Determine the execution time of an expression (@var{f}) for various input
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
24 ## values (@var{n}). The @var{n} are log-spaced from 1 to @var{max_n}. For
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
25 ## each @var{n}, an initialization expression (@var{init}) is computed to
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
26 ## create any data needed for the test. If a second expression (@var{f2}) is
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
27 ## given then the execution times of the two expressions are compared. When
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
28 ## called without output arguments the results are displayed graphically.
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
29 ##
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
30 ## @table @code
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
31 ## @item @var{f}
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
32 ## The expression to evaluate.
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
33 ##
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
34 ## @item @var{max_n}
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
35 ## The maximum test length to run. Default value is 100. Alternatively,
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
36 ## use @code{[min_n, max_n]} or specify the @var{n} exactly with
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
37 ## @code{[n1, n2, @dots{}, nk]}.
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
38 ##
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
39 ## @item @var{init}
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
40 ## Initialization expression for function argument values. Use @var{k}
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
41 ## for the test number and @var{n} for the size of the test. This should
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
42 ## compute values for all variables used by @var{f}. Note that @var{init} will
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8506
diff changeset
43 ## be evaluated first for @math{k = 0}, so things which are constant throughout
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
44 ## the test series can be computed once. The default value is
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
45 ## @code{@var{x} = randn (@var{n}, 1)}.
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
46 ##
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
47 ## @item @var{f2}
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
48 ## An alternative expression to evaluate, so that the speed of two
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
49 ## expressions can be directly compared. The default is @code{[]}.
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
50 ##
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
51 ## @item @var{tol}
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
52 ## Tolerance used to compare the results of expression @var{f} and expression
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
53 ## @var{f2}. If @var{tol} is positive, the tolerance is an absolute one.
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
54 ## If @var{tol} is negative, the tolerance is a relative one. The default is
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
55 ## @code{eps}. If @var{tol} is @code{Inf}, then no comparison will be made.
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
56 ##
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
57 ## @item @var{order}
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
58 ## The time complexity of the expression @math{O(a*n^p)}. This
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
59 ## is a structure with fields @code{a} and @code{p}.
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
60 ##
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
61 ## @item @var{n}
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
62 ## The values @var{n} for which the expression was calculated AND
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
63 ## the execution time was greater than zero.
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
64 ##
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
65 ## @item @var{T_f}
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
66 ## The nonzero execution times recorded for the expression @var{f} in seconds.
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
67 ##
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
68 ## @item @var{T_f2}
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
69 ## The nonzero execution times recorded for the expression @var{f2} in seconds.
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
70 ## If required, the mean time ratio is simply @code{mean (T_f./T_f2)}.
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
71 ##
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
72 ## @end table
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
73 ##
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
74 ## The slope of the execution time graph shows the approximate
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
75 ## power of the asymptotic running time @math{O(n^p)}. This
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
76 ## power is plotted for the region over which it is approximated
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
77 ## (the latter half of the graph). The estimated power is not
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
78 ## very accurate, but should be sufficient to determine the
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
79 ## general order of an algorithm. It should indicate if, for
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
80 ## example, the implementation is unexpectedly @math{O(n^2)}
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
81 ## rather than @math{O(n)} because it extends a vector each
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
82 ## time through the loop rather than pre-allocating storage.
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
83 ## In the current version of Octave, the following is not the
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
84 ## expected @math{O(n)}.
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
85 ##
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
86 ## @example
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
87 ## speed ("for i = 1:n, y@{i@} = x(i); endfor", "", [1000, 10000])
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
88 ## @end example
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
89 ##
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
90 ## @noindent
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
91 ## But it is if you preallocate the cell array @code{y}:
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
92 ##
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
93 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
94 ## @group
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
95 ## speed ("for i = 1:n, y@{i@} = x(i); endfor", ...
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8506
diff changeset
96 ## "x = rand (n, 1); y = cell (size (x));", [1000, 10000])
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
97 ## @end group
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
98 ## @end example
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
99 ##
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
100 ## An attempt is made to approximate the cost of individual
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
101 ## operations, but it is wildly inaccurate. You can improve the
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
102 ## stability somewhat by doing more work for each @code{n}. For
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
103 ## example:
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
104 ##
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
105 ## @example
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8506
diff changeset
106 ## speed ("airy(x)", "x = rand (n, 10)", [10000, 100000])
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
107 ## @end example
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
108 ##
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
109 ## When comparing two different expressions (@var{f}, @var{f2}), the slope
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
110 ## of the line on the speedup ratio graph should be larger than 1 if the new
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
111 ## expression is faster. Better algorithms have a shallow slope. Generally,
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
112 ## vectorizing an algorithm will not change the slope of the execution
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
113 ## time graph, but will shift it relative to the original. For
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
114 ## example:
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
115 ##
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
116 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
117 ## @group
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8506
diff changeset
118 ## speed ("v = sum (x)", "", [10000, 100000], ...
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8506
diff changeset
119 ## "v = 0; for i = 1:length (x), v += x(i); end")
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
120 ## @end group
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
121 ## @end example
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
122 ##
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
123 ## The following is a more complex example. If there was an original version
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
124 ## of @code{xcorr} using for loops and a second version using an FFT, then
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
125 ## one could compare the run speed for various lags as follows, or for a fixed
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
126 ## lag with varying vector lengths as follows:
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
127 ##
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
128 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
129 ## @group
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8506
diff changeset
130 ## speed ("v = xcorr (x, n)", "x = rand (128, 1);", 100,
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8506
diff changeset
131 ## "v2 = xcorr_orig (x, n)", -100*eps)
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8506
diff changeset
132 ## speed ("v = xcorr (x, 15)", "x = rand (20+n, 1);", 100,
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8506
diff changeset
133 ## "v2 = xcorr_orig (x, n)", -100*eps)
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
134 ## @end group
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
135 ## @end example
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
136 ##
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
137 ## Assuming one of the two versions is in xcorr_orig, this
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
138 ## would compare their speed and their output values. Note that the
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
139 ## FFT version is not exact, so we specify an acceptable tolerance on
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
140 ## the comparison @code{100*eps}, and that the errors should be computed
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
141 ## relatively, as @code{abs ((@var{x} - @var{y}) ./ @var{y})} rather than
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
142 ## absolutely as @code{abs (@var{x} - @var{y})}.
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
143 ##
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
144 ## Type @code{example('speed')} to see some real examples. Note that for
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
145 ## obscure reasons, examples 1 and 2 can not be run directly using
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
146 ## @code{demo('speed')}. Instead use, @code{eval ( example('speed', 1) )}
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
147 ## or @code{eval ( example('speed', 2) )}.
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
148 ## @end deftypefn
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
149
8202
cf59d542f33e replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents: 7540
diff changeset
150 ## FIXME: consider two dimensional speedup surfaces for functions like kron.
11342
cc7f30d3fd01 speed.m: Eliminate line continuation in function definition.
Rik <octave@nomad.inbox5.com>
parents: 11314
diff changeset
151 function [__order, __test_n, __tnew, __torig] = speed (__f1, __init, __max_n, __f2, __tol)
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
152
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
153 if (nargin < 1 || nargin > 6)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5798
diff changeset
154 print_usage ();
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
155 endif
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
156
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
157 if (nargin < 2 || isempty (__init))
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
158 __init = "x = randn(n, 1);";
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
159 endif
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
160
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
161 if (nargin < 3 || isempty (__max_n))
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
162 __max_n = 100;
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
163 endif
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
164
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
165 if (nargin < 4)
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
166 __f2 = [];
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
167 endif
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
168
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
169 if (nargin < 5 || isempty (__tol))
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
170 __tol = eps;
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
171 endif
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
172
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
173 __numtests = 15;
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
174
8506
bc982528de11 comment style fixes
John W. Eaton <jwe@octave.org>
parents: 8202
diff changeset
175 ## Let user specify range of n.
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
176 if (isscalar (__max_n))
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
177 __min_n = 1;
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
178 assert (__max_n > __min_n);
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
179 __test_n = logspace (0, log10 (__max_n), __numtests);
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
180 elseif (length (__max_n) == 2)
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
181 __min_n = __max_n(1);
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
182 __max_n = __max_n(2);
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
183 assert (__min_n >= 1);
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
184 __test_n = logspace (log10 (__min_n), log10 (__max_n), __numtests);
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
185 else
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
186 __test_n = __max_n;
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
187 endif
8506
bc982528de11 comment style fixes
John W. Eaton <jwe@octave.org>
parents: 8202
diff changeset
188 ## Force n to be an integer.
bc982528de11 comment style fixes
John W. Eaton <jwe@octave.org>
parents: 8202
diff changeset
189 __test_n = unique (round (__test_n));
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
190 assert (__test_n >= 1);
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
191
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
192 __torig = __tnew = zeros (size (__test_n));
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
193
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
194 disp (cstrcat ("testing ", __f1, "\ninit: ", __init));
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
195
8506
bc982528de11 comment style fixes
John W. Eaton <jwe@octave.org>
parents: 8202
diff changeset
196 ## Make sure the functions are freshly loaded by evaluating them at
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
197 ## test_n(1); first have to initialize the args though.
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
198 n = 1;
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
199 k = 0;
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
200 eval (cstrcat (__init, ";"));
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
201 if (! isempty (__f2))
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
202 eval (cstrcat (__f2, ";"));
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
203 endif
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
204 eval (cstrcat (__f1, ";"));
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
205
8506
bc982528de11 comment style fixes
John W. Eaton <jwe@octave.org>
parents: 8202
diff changeset
206 ## Run the tests.
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
207 for k = 1:length (__test_n)
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
208 n = __test_n(k);
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
209 eval (cstrcat (__init, ";"));
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
210
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8506
diff changeset
211 printf ("n%i = %i ",k, n);
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
212 fflush (stdout);
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8506
diff changeset
213 eval (cstrcat ("__t = time();", __f1, "; __v1=ans; __t = time()-__t;"));
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
214 if (__t < 0.25)
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8506
diff changeset
215 eval (cstrcat ("__t2 = time();", __f1, "; __t2 = time()-__t2;"));
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8506
diff changeset
216 eval (cstrcat ("__t3 = time();", __f1, "; __t3 = time()-__t3;"));
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
217 __t = min ([__t, __t2, __t3]);
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
218 endif
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
219 __tnew(k) = __t;
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
220
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
221 if (! isempty (__f2))
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8506
diff changeset
222 eval (cstrcat ("__t = time();", __f2, "; __v2=ans; __t = time()-__t;"));
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
223 if (__t < 0.25)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9051
diff changeset
224 eval (cstrcat ("__t2 = time();", __f2, "; __t2 = time()-__t2;"));
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9051
diff changeset
225 eval (cstrcat ("__t3 = time();", __f2, "; __t3 = time()-__t3;"));
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
226 endif
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
227 __torig(k) = __t;
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
228 if (! isinf(__tol))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9051
diff changeset
229 assert (__v1, __v2, __tol);
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
230 endif
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
231 endif
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
232 endfor
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
233
8506
bc982528de11 comment style fixes
John W. Eaton <jwe@octave.org>
parents: 8202
diff changeset
234 ## Drop times of zero.
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
235 if (! isempty (__f2))
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
236 zidx = (__tnew < 100*eps | __torig < 100*eps);
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
237 __test_n(zidx) = [];
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
238 __tnew(zidx) = [];
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
239 __torig(zidx) = [];
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
240 else
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
241 zidx = (__tnew < 100*eps);
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
242 __test_n(zidx) = [];
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
243 __tnew(zidx) = [];
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
244 endif
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
245
8506
bc982528de11 comment style fixes
John W. Eaton <jwe@octave.org>
parents: 8202
diff changeset
246 ## Approximate time complexity and return it if requested.
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
247 tailidx = ceil(length(__test_n)/2):length(__test_n);
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
248 p = polyfit (log (__test_n(tailidx)), log (__tnew(tailidx)), 1);
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
249 if (nargout > 0)
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
250 __order.p = p(1);
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
251 __order.a = exp (p(2));
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
252 endif
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
253
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
254 ## Plot the data if no output is requested.
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
255 doplot = (nargout == 0);
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
256
6430
215b141470b4 [project @ 2007-03-21 20:58:08 by dbateman]
dbateman
parents: 6429
diff changeset
257 if (doplot)
215b141470b4 [project @ 2007-03-21 20:58:08 by dbateman]
dbateman
parents: 6429
diff changeset
258 figure;
215b141470b4 [project @ 2007-03-21 20:58:08 by dbateman]
dbateman
parents: 6429
diff changeset
259 endif
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
260
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
261 if (doplot && ! isempty (__f2))
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
262 subplot (1, 2, 1);
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
263 semilogx (__test_n, __torig./__tnew,
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9051
diff changeset
264 cstrcat ("-*r;", strrep (__f1, ";", "."), "/",
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9051
diff changeset
265 strrep (__f2, ";", "."), ";"),
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9051
diff changeset
266 __test_n, __tnew./__torig,
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9051
diff changeset
267 cstrcat ("-*g;", strrep (__f2, ";", "."), "/",
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9051
diff changeset
268 strrep (__f1, ";", "."), ";"));
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
269 xlabel ("test length");
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
270 title (__f1);
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
271 ylabel ("speedup ratio");
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
272
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
273 subplot (1, 2, 2);
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
274 loglog (__test_n, __tnew*1000,
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
275 cstrcat ("*-g;", strrep (__f1, ";", "."), ";"),
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9051
diff changeset
276 __test_n, __torig*1000,
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9051
diff changeset
277 cstrcat ("*-r;", strrep (__f2,";","."), ";"));
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
278
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
279 xlabel ("test length");
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
280 ylabel ("best execution time (ms)");
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
281 title (cstrcat ("init: ", __init));
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
282
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
283 ratio = mean (__torig ./ __tnew);
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
284 printf ("\n\nMean runtime ratio = %.3g for '%s' vs '%s'\n",
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
285 ratio, __f2, __f1);
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
286
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
287 elseif (doplot)
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
288
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
289 loglog (__test_n, __tnew*1000, "*-g;execution time;");
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
290 xlabel ("test length");
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
291 ylabel ("best execution time (ms)");
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
292 title (cstrcat (__f1, " init: ", __init));
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
293
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
294 endif
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
295
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
296 if (doplot)
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
297
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
298 ## Plot time complexity approximation (using milliseconds).
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
299 order = sprintf ("O(n^%g)", round (10*p(1))/10);
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
300 v = polyval (p, log (__test_n(tailidx)));
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
301
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
302 loglog (__test_n(tailidx), exp(v)*1000, sprintf ("b;%s;", order));
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
303
8506
bc982528de11 comment style fixes
John W. Eaton <jwe@octave.org>
parents: 8202
diff changeset
304 ## Get base time to 1 digit of accuracy.
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
305 dt = exp (p(2));
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
306 dt = floor (dt/10^floor(log10(dt)))*10^floor(log10(dt));
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
307 if (log10 (dt) >= -0.5)
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
308 time = sprintf ("%g s", dt);
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
309 elseif (log10 (dt) >= -3.5)
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
310 time = sprintf ("%g ms", dt*1e3);
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
311 elseif (log10 (dt) >= -6.5)
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
312 time = sprintf ("%g us", dt*1e6);
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
313 else
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
314 time = sprintf ("%g ns", dt*1e9);
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
315 endif
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
316
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
317 ## Display nicely formatted complexity.
6494
76a1a953533d [project @ 2007-04-05 16:09:03 by jwe]
jwe
parents: 6430
diff changeset
318 printf ("\nFor %s:\n", __f1);
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
319 printf (" asymptotic power: %s\n", order);
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
320 printf (" approximate time per operation: %s\n", time);
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
321
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
322 endif
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5589
diff changeset
323
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
324 endfunction
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
325
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
326 %!demo if 1
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
327 %! function x = build_orig(n)
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
328 %! ## extend the target vector on the fly
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
329 %! for i=0:n-1, x([1:10]+i*10) = 1:10; endfor
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
330 %! endfunction
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
331 %! function x = build(n)
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
332 %! ## preallocate the target vector
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
333 %! x = zeros(1, n*10);
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
334 %! try
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
335 %! if (prefer_column_vectors), x = x.'; endif
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
336 %! catch
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
337 %! end
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
338 %! for i=0:n-1, x([1:10]+i*10) = 1:10; endfor
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
339 %! endfunction
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
340 %!
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
341 %! disp("-----------------------");
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
342 %! type build_orig;
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
343 %! disp("-----------------------");
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
344 %! type build;
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
345 %! disp("-----------------------");
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
346 %!
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
347 %! disp("Preallocated vector test.\nThis takes a little while...");
6429
6ff2d413cf58 [project @ 2007-03-21 20:13:03 by dbateman]
dbateman
parents: 6046
diff changeset
348 %! speed('build(n)', '', 1000, 'build_orig(n)');
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
349 %! clear build build_orig
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
350 %! disp("Note how much faster it is to pre-allocate a vector.");
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
351 %! disp("Notice the peak speedup ratio.");
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
352 %! endif
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
353
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
354 %!demo if 1
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
355 %! function x = build_orig(n)
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
356 %! for i=0:n-1, x([1:10]+i*10) = 1:10; endfor
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
357 %! endfunction
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
358 %! function x = build(n)
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
359 %! idx = [1:10]';
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
360 %! x = idx(:,ones(1,n));
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
361 %! x = reshape(x, 1, n*10);
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
362 %! try
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
363 %! if (prefer_column_vectors), x = x.'; endif
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
364 %! catch
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
365 %! end
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
366 %! endfunction
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
367 %!
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
368 %! disp("-----------------------");
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
369 %! type build_orig;
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
370 %! disp("-----------------------");
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
371 %! type build;
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
372 %! disp("-----------------------");
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
373 %!
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
374 %! disp("Vectorized test.\nThis takes a little while...");
6429
6ff2d413cf58 [project @ 2007-03-21 20:13:03 by dbateman]
dbateman
parents: 6046
diff changeset
375 %! speed('build(n)', '', 1000, 'build_orig(n)');
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
376 %! clear build build_orig
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
377 %! disp("-----------------------");
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
378 %! disp("This time, the for loop is done away with entirely.");
11314
87f258202b0f speed.m: Overhaul documentation string.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
379 %! disp("Notice how much bigger the speedup is than in example 1.");
5589
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe]
jwe
parents:
diff changeset
380 %! endif