File: Coding-Tips.html

package info (click to toggle)
octave3.2 3.2.4-8
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 62,936 kB
  • ctags: 37,353
  • sloc: cpp: 219,497; fortran: 116,336; ansic: 10,264; sh: 5,508; makefile: 4,245; lex: 3,573; yacc: 3,062; objc: 2,042; lisp: 1,692; awk: 860; perl: 844
file content (162 lines) | stat: -rw-r--r-- 7,565 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
<html lang="en">
<head>
<title>Coding Tips - Untitled</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Untitled">
<meta name="generator" content="makeinfo 4.11">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Tips-and-Standards.html#Tips-and-Standards" title="Tips and Standards">
<link rel="prev" href="Style-Tips.html#Style-Tips" title="Style Tips">
<link rel="next" href="Comment-Tips.html#Comment-Tips" title="Comment Tips">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
--></style>
</head>
<body>
<div class="node">
<p>
<a name="Coding-Tips"></a>
Next:&nbsp;<a rel="next" accesskey="n" href="Comment-Tips.html#Comment-Tips">Comment Tips</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Style-Tips.html#Style-Tips">Style Tips</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Tips-and-Standards.html#Tips-and-Standards">Tips and Standards</a>
<hr>
</div>

<h3 class="section">C.2 Tips for Making Code Run Faster.</h3>

<p><a name="index-execution-speed-2508"></a><a name="index-speedups-2509"></a>
Here are some ways of improving the execution speed of Octave programs.

     <ul>
<li>Vectorize loops. For instance, rather than
     <pre class="example">          for i = 1:n-1
            a(i) = b(i+1) - b(i);
          endfor
</pre>
     <p>write

     <pre class="example">          a = b(2:n) - b(1:n-1);
</pre>
     <p>This is especially important for loops with "cheap" bodies. Often it suffices to vectorize
just the innermost loop to get acceptable performance. A general rule of thumb is that the
"order" of the vectorized body should be greater or equal to the "order" of the enclosing loop.

     <li>Use built-in and library functions if possible. Built-in and compiled functions are very fast. 
Even with a m-file library function, chances are good that it is already optimized, or will be
optimized more in a future release.

     <li>Avoid computing costly intermediate results multiple times. Octave currently
does not eliminate common subexpressions.

     <li>Be aware of lazy copies (copy-on-write). When a copy of an object
is created, the data is not immediately copied, but rather shared. The actual
copying is postponed until the copied data needs to be modified. For example:

     <pre class="example">          a = zeros (1000); # create a 1000x1000 matrix
          b = a; # no copying done here
          b(1) = 1; # copying done here
</pre>
     <p>Lazy copying applies to whole Octave objects such as matrices, cells, struct,
and also individual cell or struct elements (not array elements).

     <p>Additionally, index expressions also use lazy copying when Octave can determine
that the indexed portion is contiguous in memory. For example:

     <pre class="example">          a = zeros (1000); # create a 1000x1000 matrix
          b = a(:,10:100); # no copying done here
          b = a(10:100,:); # copying done here
</pre>
     <p>This applies to arrays (matrices), cell arrays, and structs indexed using (). 
Index expressions generating cs-lists can also benefit of shallow copying
in some cases. In particular, when <var>a</var> is a struct array, expressions like
<code>{a.x}, {a(:,2).x}</code> will use lazy copying, so that data can be shared
between a struct array and a cell array.

     <p>Most indexing expressions do not live longer than their `parent' objects. 
In rare cases, however, a lazily copied slice outlasts its parent, in which
case it becomes orphaned, still occupying unnecessarily more memory than needed. 
To provide a remedy working in most real cases,
Octave checks for orphaned lazy slices at certain situations, when a value
is stored into a "permanent" location, such as a named variable or cell or
struct element, and possibly economizes them. For example

     <pre class="example">          a = zeros (1000); # create a 1000x1000 matrix
          b = a(:,10:100); # lazy slice
          a = []; # the original a array is still allocated
          c{1} = b; # b is reallocated at this point
</pre>
     <li>Avoid deep recursion. Function calls to m-file functions carry a relatively significant overhead,
so rewriting a recursion as a loop often helps. Also, note that the maximum level of recursion is
limited.

     <li>Avoid resizing matrices unnecessarily. When building a single result
matrix from a series of calculations, set the size of the result matrix
first, then insert values into it.  Write

     <pre class="example">          result = zeros (big_n, big_m)
          for i = over:and_over
            r1 = ...
            r2 = ...
            result (r1, r2) = new_value ();
          endfor
</pre>
     <p class="noindent">instead of

     <pre class="example">          result = [];
          for i = ever:and_ever
            result = [ result, new_value() ];
          endfor
</pre>
     <p>Sometimes the number of items can't be computed in advance, and stack-like operations
are needed. When elements are being repeatedly inserted at/removed from the end of an
array, Octave detects it as stack usage and attempts to use a smarter memory management
strategy preallocating the array in bigger chunks. Likewise works for cell and
struct arrays.

     <pre class="example">          a = [];
          while (condition)
            ...
            a(end+1) = value; # "push" operation
            ...
            a(end) = []; # "pop" operation
            ...
          endwhile
</pre>
     <li>Use <code>cellfun</code> intelligently. The <code>cellfun</code> function is a useful tool
for avoiding loops. See <a href="Processing-Data-in-Cell-Arrays.html#Processing-Data-in-Cell-Arrays">Processing Data in Cell Arrays</a>. 
<code>cellfun</code> is often use with anonymous function handles; however, calling
an anonymous function involves an overhead quite comparable to the overhead
of an m-file function. Passing a handle to a built-in function is faster,
because the interpreter is not involved in the internal loop. For example:

     <pre class="example">          a = {...}
          v = cellfun (@(x) det(x), a); # compute determinants
          v = cellfun (@det, a); # faster
</pre>
     <li>Avoid calling <code>eval</code> or <code>feval</code> excessively, because
they require Octave to parse input or look up the name of a function in
the symbol table.

     <p>If you are using <code>eval</code> as an exception handling mechanism and not
because you need to execute some arbitrary text, use the <code>try</code>
statement instead.  See <a href="The-_003ccode_003etry_003c_002fcode_003e-Statement.html#The-_003ccode_003etry_003c_002fcode_003e-Statement">The <code>try</code> Statement</a>.

     <li>If you are calling lots of functions but none of them will need to
change during your run, set the variable
<code>ignore_function_time_stamp</code> to <code>"all"</code> so that Octave doesn't
waste a lot of time checking to see if you have updated your function
files. 
</ul>

   </body></html>