Mercurial > hg > octave-nkf
annotate doc/interpreter/tips.txi @ 10791:3140cb7a05a1
Add spellchecker scripts for Octave and run spellcheck of documentation
interpreter/doccheck: New directory for spelling/grammar scripts.
interpreter/doccheck/README: Instructions for using scripts.
interpreter/doccheck/spellcheck: Script to spellcheck a Texinfo file.
interpreter/doccheck/aspell.conf: GNU Aspell configuration file for
Octave documentation.
interpreter/doccheck/aspell-octave.en.pws: Private Aspell dictionary.
interpreter/doccheck/add_to_aspell_dict: Script to add new
Octave-specific words to
private Aspell dictionary.
interpreter/octave.texi: New @nospell macro which forces Aspell
to ignore the word marked by the macro.
interpreter/mk_doc_cache.m: Skip new @nospell macro when building
doc_cache.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Sat, 17 Jul 2010 19:53:01 -0700 |
| parents | c3df189b1b15 |
| children | 5b68000faac1 |
| rev | line source |
|---|---|
| 8920 | 1 @c Copyright (C) 1996, 1997, 1999, 2002, 2004, 2005, 2007, 2008, |
| 2 @c 2009 John W. Eaton | |
| 7018 | 3 @c |
| 4 @c This file is part of Octave. | |
| 5 @c | |
| 6 @c Octave is free software; you can redistribute it and/or modify it | |
| 7 @c under the terms of the GNU General Public License as published by the | |
| 8 @c Free Software Foundation; either version 3 of the License, or (at | |
| 9 @c your option) any later version. | |
| 10 @c | |
| 11 @c Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 12 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 13 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 14 @c for more details. | |
| 15 @c | |
| 16 @c You should have received a copy of the GNU General Public License | |
| 17 @c along with Octave; see the file COPYING. If not, see | |
| 18 @c <http://www.gnu.org/licenses/>. | |
| 3294 | 19 |
|
9032
349616d9c38e
Cleanup top-level documentation menu in octave.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
20 @node Tips and Standards |
| 3294 | 21 @appendix Tips and Standards |
| 22 @cindex tips | |
| 23 @cindex standards of coding style | |
| 24 @cindex coding standards | |
| 25 | |
| 26 This chapter describes no additional features of Octave. Instead it | |
| 27 gives advice on making effective use of the features described in the | |
| 28 previous chapters. | |
| 29 | |
| 30 @menu | |
| 31 * Style Tips:: Writing clean and robust programs. | |
| 32 * Coding Tips:: Making code run faster. | |
| 33 * Comment Tips:: Conventions for writing comments. | |
| 34 * Function Headers:: Standard headers for functions. | |
| 6574 | 35 * Documentation Tips:: Writing readable documentation strings. |
| 3294 | 36 @end menu |
| 37 | |
| 4167 | 38 @node Style Tips |
| 3294 | 39 @section Writing Clean Octave Programs |
| 40 | |
| 41 Here are some tips for avoiding common errors in writing Octave code | |
| 42 intended for widespread use: | |
| 43 | |
| 44 @itemize @bullet | |
| 45 @item | |
| 46 Since all global variables share the same name space, and all functions | |
| 47 share another name space, you should choose a short word to distinguish | |
| 48 your program from other Octave programs. Then take care to begin the | |
| 49 names of all global variables, constants, and functions with the chosen | |
| 50 prefix. This helps avoid name conflicts. | |
| 51 | |
| 52 If you write a function that you think ought to be added to Octave under | |
| 53 a certain name, such as @code{fiddle_matrix}, don't call it by that name | |
| 54 in your program. Call it @code{mylib_fiddle_matrix} in your program, | |
| 5041 | 55 and send mail to @email{maintainers@@octave.org} suggesting that it |
| 3294 | 56 be added to Octave. If and when it is, the name can be changed easily |
| 57 enough. | |
| 58 | |
| 59 If one prefix is insufficient, your package may use two or three | |
| 60 alternative common prefixes, so long as they make sense. | |
| 61 | |
| 62 Separate the prefix from the rest of the symbol name with an underscore | |
| 63 @samp{_}. This will be consistent with Octave itself and with most | |
| 64 Octave programs. | |
| 65 | |
| 66 @item | |
| 67 When you encounter an error condition, call the function @code{error} | |
| 68 (or @code{usage}). The @code{error} and @code{usage} functions do not | |
| 69 return. | |
| 70 @xref{Errors}. | |
| 71 | |
| 72 @item | |
| 73 Please put a copyright notice on the file if you give copies to anyone. | |
| 74 Use the same lines that appear at the top of the function files | |
| 75 distributed with Octave. If you have not signed papers to assign the | |
| 76 copyright to anyone else, then place your name in the copyright notice. | |
| 77 @end itemize | |
| 78 | |
| 4167 | 79 @node Coding Tips |
| 3294 | 80 @section Tips for Making Code Run Faster. |
| 81 @cindex execution speed | |
| 82 @cindex speedups | |
| 83 | |
| 84 Here are some ways of improving the execution speed of Octave programs. | |
| 85 | |
| 86 @itemize @bullet | |
| 87 @item | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
88 Vectorize loops. For instance, rather than |
| 9356 | 89 @example |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
90 @group |
| 9356 | 91 for i = 1:n-1 |
| 92 a(i) = b(i+1) - b(i); | |
| 93 endfor | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
94 @end group |
| 9356 | 95 @end example |
| 96 | |
| 97 write | |
| 98 | |
| 99 @example | |
| 100 a = b(2:n) - b(1:n-1); | |
| 101 @end example | |
| 102 | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
103 This is especially important for loops with "cheap" bodies. Often it suffices to vectorize |
|
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
104 just the innermost loop to get acceptable performance. A general rule of thumb is that the |
| 9356 | 105 "order" of the vectorized body should be greater or equal to the "order" of the enclosing loop. |
| 106 | |
| 107 @item | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
108 Use built-in and library functions if possible. Built-in and compiled functions are very fast. |
| 9356 | 109 Even with a m-file library function, chances are good that it is already optimized, or will be |
| 110 optimized more in a future release. | |
| 111 | |
| 112 @item | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
113 Avoid computing costly intermediate results multiple times. Octave currently |
| 9356 | 114 does not eliminate common subexpressions. |
| 9486 | 115 Also, certain internal computation results are cached for variables. |
| 116 For instance, if a matrix variable is used multiple times as an index, | |
| 117 checking the indices (and internal conversion to integers) is only done once. | |
| 3294 | 118 |
| 119 @item | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
120 Be aware of lazy copies (copy-on-write). When a copy of an object |
|
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
121 is created, the data is not immediately copied, but rather shared. The actual |
|
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
122 copying is postponed until the copied data needs to be modified. For example: |
| 9356 | 123 |
| 124 @example | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
125 @group |
| 9356 | 126 a = zeros (1000); # create a 1000x1000 matrix |
| 127 b = a; # no copying done here | |
| 128 b(1) = 1; # copying done here | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
129 @end group |
| 9356 | 130 @end example |
| 131 | |
| 132 Lazy copying applies to whole Octave objects such as matrices, cells, struct, | |
| 133 and also individual cell or struct elements (not array elements). | |
| 134 | |
| 135 Additionally, index expressions also use lazy copying when Octave can determine | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
136 that the indexed portion is contiguous in memory. For example: |
| 9356 | 137 |
| 138 @example | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
139 @group |
| 9356 | 140 a = zeros (1000); # create a 1000x1000 matrix |
| 141 b = a(:,10:100); # no copying done here | |
| 142 b = a(10:100,:); # copying done here | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
143 @end group |
| 9356 | 144 @end example |
| 145 | |
| 146 This applies to arrays (matrices), cell arrays, and structs indexed using (). | |
| 147 Index expressions generating cs-lists can also benefit of shallow copying | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
148 in some cases. In particular, when @var{a} is a struct array, expressions like |
| 9356 | 149 @code{@{a.x@}, @{a(:,2).x@}} will use lazy copying, so that data can be shared |
| 150 between a struct array and a cell array. | |
| 151 | |
| 152 Most indexing expressions do not live longer than their `parent' objects. | |
| 153 In rare cases, however, a lazily copied slice outlasts its parent, in which | |
| 154 case it becomes orphaned, still occupying unnecessarily more memory than needed. | |
| 155 To provide a remedy working in most real cases, | |
| 156 Octave checks for orphaned lazy slices at certain situations, when a value | |
| 157 is stored into a "permanent" location, such as a named variable or cell or | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
158 struct element, and possibly economizes them. For example |
| 9356 | 159 |
| 160 @example | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
161 @group |
| 9356 | 162 a = zeros (1000); # create a 1000x1000 matrix |
| 163 b = a(:,10:100); # lazy slice | |
| 164 a = []; # the original a array is still allocated | |
| 165 c@{1@} = b; # b is reallocated at this point | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
166 @end group |
| 9356 | 167 @end example |
| 3294 | 168 |
| 169 @item | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
170 Avoid deep recursion. Function calls to m-file functions carry a relatively significant overhead, |
|
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
171 so rewriting a recursion as a loop often helps. Also, note that the maximum level of recursion is |
| 9356 | 172 limited. |
| 173 | |
| 174 @item | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
175 Avoid resizing matrices unnecessarily. When building a single result |
| 3294 | 176 matrix from a series of calculations, set the size of the result matrix |
| 177 first, then insert values into it. Write | |
| 178 | |
| 179 @example | |
| 180 @group | |
| 181 result = zeros (big_n, big_m) | |
| 182 for i = over:and_over | |
| 183 r1 = @dots{} | |
| 184 r2 = @dots{} | |
| 185 result (r1, r2) = new_value (); | |
| 186 endfor | |
| 187 @end group | |
| 188 @end example | |
| 189 | |
| 190 @noindent | |
| 191 instead of | |
| 192 | |
| 193 @example | |
| 194 @group | |
| 195 result = []; | |
| 196 for i = ever:and_ever | |
| 197 result = [ result, new_value() ]; | |
| 198 endfor | |
| 199 @end group | |
| 200 @end example | |
| 201 | |
| 9356 | 202 Sometimes the number of items can't be computed in advance, and stack-like operations |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
203 are needed. When elements are being repeatedly inserted at/removed from the end of an |
| 9356 | 204 array, Octave detects it as stack usage and attempts to use a smarter memory management |
|
10791
3140cb7a05a1
Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents:
10284
diff
changeset
|
205 strategy pre-allocating the array in bigger chunks. Likewise works for cell and |
| 9356 | 206 struct arrays. |
| 207 | |
| 208 @example | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
209 @group |
| 9356 | 210 a = []; |
| 211 while (condition) | |
| 212 @dots{} | |
| 213 a(end+1) = value; # "push" operation | |
| 214 @dots{} | |
| 215 a(end) = []; # "pop" operation | |
| 216 @dots{} | |
| 217 endwhile | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
218 @end group |
| 9356 | 219 @end example |
| 220 | |
| 3294 | 221 @item |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
222 Use @code{cellfun} intelligently. The @code{cellfun} function is a useful tool |
|
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
223 for avoiding loops. @xref{Processing Data in Cell Arrays}. |
| 10284 | 224 @code{cellfun} is often used with anonymous function handles; however, calling |
| 9356 | 225 an anonymous function involves an overhead quite comparable to the overhead |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
226 of an m-file function. Passing a handle to a built-in function is faster, |
|
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
227 because the interpreter is not involved in the internal loop. For example: |
| 9356 | 228 |
| 229 @example | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
230 @group |
| 9356 | 231 a = @{@dots{}@} |
| 232 v = cellfun (@@(x) det(x), a); # compute determinants | |
| 233 v = cellfun (@@det, a); # faster | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9486
diff
changeset
|
234 @end group |
| 9356 | 235 @end example |
| 236 | |
| 237 @item | |
| 10284 | 238 Octave includes a number of other functions that can replace common types of loops, |
| 239 including @code{bsxfun}, @code{arrayfun}, @code{structfun}, @code{accumarray}. | |
| 240 These functions can take an arbitrary function as a handle. | |
| 241 | |
| 242 @item | |
| 9356 | 243 Avoid calling @code{eval} or @code{feval} excessively, because |
| 3294 | 244 they require Octave to parse input or look up the name of a function in |
| 245 the symbol table. | |
| 246 | |
| 247 If you are using @code{eval} as an exception handling mechanism and not | |
| 248 because you need to execute some arbitrary text, use the @code{try} | |
|
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
249 statement instead. @xref{The @code{try} Statement}. |
| 3294 | 250 |
| 251 @item | |
| 252 If you are calling lots of functions but none of them will need to | |
| 253 change during your run, set the variable | |
| 254 @code{ignore_function_time_stamp} to @code{"all"} so that Octave doesn't | |
| 255 waste a lot of time checking to see if you have updated your function | |
| 256 files. | |
| 257 @end itemize | |
| 258 | |
| 4167 | 259 @node Comment Tips |
| 3294 | 260 @section Tips on Writing Comments |
| 261 | |
| 262 Here are the conventions to follow when writing comments. | |
| 263 | |
| 264 @table @samp | |
| 265 @item # | |
| 266 Comments that start with a single sharp-sign, @samp{#}, should all be | |
| 267 aligned to the same column on the right of the source code. Such | |
| 268 comments usually explain how the code on the same line does its job. In | |
| 269 the Emacs mode for Octave, the @kbd{M-;} (@code{indent-for-comment}) | |
| 270 command automatically inserts such a @samp{#} in the right place, or | |
| 271 aligns such a comment if it is already present. | |
| 272 | |
| 273 @item ## | |
| 7345 | 274 Comments that start with a double sharp-sign, @samp{##}, should be aligned to |
| 3294 | 275 the same level of indentation as the code. Such comments usually |
| 276 describe the purpose of the following lines or the state of the program | |
| 277 at that point. | |
| 278 @end table | |
| 279 | |
| 280 @noindent | |
| 281 The indentation commands of the Octave mode in Emacs, such as @kbd{M-;} | |
| 282 (@code{indent-for-comment}) and @kbd{TAB} (@code{octave-indent-line}) | |
| 283 automatically indent comments according to these conventions, | |
| 284 depending on the number of semicolons. @xref{Comments,, | |
| 285 Manipulating Comments, emacs, The GNU Emacs Manual}. | |
| 286 | |
| 4167 | 287 @node Function Headers |
| 3294 | 288 @section Conventional Headers for Octave Functions |
| 289 @cindex header comments | |
| 290 | |
| 291 Octave has conventions for using special comments in function files | |
| 292 to give information such as who wrote them. This section explains these | |
| 293 conventions. | |
| 294 | |
| 295 The top of the file should contain a copyright notice, followed by a | |
| 296 block of comments that can be used as the help text for the function. | |
| 297 Here is an example: | |
| 298 | |
| 299 @example | |
| 6778 | 300 ## Copyright (C) 1996, 1997, 2007 John W. Eaton |
| 3294 | 301 ## |
| 302 ## This file is part of Octave. | |
| 303 ## | |
| 304 ## Octave is free software; you can redistribute it and/or | |
| 305 ## modify it under the terms of the GNU General Public | |
| 306 ## License as published by the Free Software Foundation; | |
| 7081 | 307 ## either version 3 of the License, or (at your option) any |
| 308 ## later version. | |
| 3294 | 309 ## |
| 310 ## Octave is distributed in the hope that it will be useful, | |
| 311 ## but WITHOUT ANY WARRANTY; without even the implied | |
| 312 ## warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR | |
| 313 ## PURPOSE. See the GNU General Public License for more | |
| 314 ## details. | |
| 315 ## | |
| 316 ## You should have received a copy of the GNU General Public | |
| 317 ## License along with Octave; see the file COPYING. If not, | |
| 7016 | 318 ## see <http://www.gnu.org/licenses/>. |
| 3294 | 319 |
| 320 ## usage: [IN, OUT, PID] = popen2 (COMMAND, ARGS) | |
| 321 ## | |
| 322 ## Start a subprocess with two-way communication. COMMAND | |
| 323 ## specifies the name of the command to start. ARGS is an | |
| 324 ## array of strings containing options for COMMAND. IN and | |
| 325 ## OUT are the file ids of the input and streams for the | |
| 326 ## subprocess, and PID is the process id of the subprocess, | |
| 327 ## or -1 if COMMAND could not be executed. | |
| 328 ## | |
| 329 ## Example: | |
| 330 ## | |
| 331 ## [in, out, pid] = popen2 ("sort", "-nr"); | |
| 332 ## fputs (in, "these\nare\nsome\nstrings\n"); | |
| 333 ## fclose (in); | |
|
7768
a2d9f325b65a
Use isschar instead of deprecated isstr
Rafael Laboissiere <rafael@debian.org>
parents:
7345
diff
changeset
|
334 ## while (ischar (s = fgets (out))) |
| 3294 | 335 ## fputs (stdout, s); |
| 336 ## endwhile | |
| 337 ## fclose (out); | |
| 338 @end example | |
| 339 | |
| 340 Octave uses the first block of comments in a function file that do not | |
| 341 appear to be a copyright notice as the help text for the file. For | |
| 342 Octave to recognize the first comment block as a copyright notice, it | |
| 6530 | 343 must start with the word `Copyright' after stripping the leading |
| 344 comment characters. | |
| 3294 | 345 |
| 346 After the copyright notice and help text come several @dfn{header | |
| 347 comment} lines, each beginning with @samp{## @var{header-name}:}. For | |
| 348 example, | |
| 349 | |
| 350 @example | |
| 351 @group | |
| 352 ## Author: jwe | |
| 353 ## Keywords: subprocesses input-output | |
| 354 ## Maintainer: jwe | |
| 355 @end group | |
| 356 @end example | |
| 357 | |
| 358 Here is a table of the conventional possibilities for @var{header-name}: | |
| 359 | |
| 360 @table @samp | |
| 361 @item Author | |
| 362 This line states the name and net address of at least the principal | |
| 363 author of the library. | |
| 364 | |
| 6670 | 365 @example |
| 9322 | 366 ## Author: John W. Eaton <jwe@@octave.org> |
| 6670 | 367 @end example |
| 3294 | 368 |
| 369 @item Maintainer | |
| 370 This line should contain a single name/address as in the Author line, or | |
| 371 an address only, or the string @samp{jwe}. If there is no maintainer | |
| 372 line, the person(s) in the Author field are presumed to be the | |
| 373 maintainers. The example above is mildly bogus because the maintainer | |
| 374 line is redundant. | |
| 375 | |
| 376 The idea behind the @samp{Author} and @samp{Maintainer} lines is to make | |
| 377 possible a function to ``send mail to the maintainer'' without | |
| 378 having to mine the name out by hand. | |
| 379 | |
| 380 Be sure to surround the network address with @samp{<@dots{}>} if | |
| 381 you include the person's full name as well as the network address. | |
| 382 | |
| 383 @item Created | |
| 384 This optional line gives the original creation date of the | |
| 385 file. For historical interest only. | |
| 386 | |
| 387 @item Version | |
| 388 If you wish to record version numbers for the individual Octave program, | |
| 389 put them in this line. | |
| 390 | |
| 391 @item Adapted-By | |
| 392 In this header line, place the name of the person who adapted the | |
| 393 library for installation (to make it fit the style conventions, for | |
| 394 example). | |
| 395 | |
| 396 @item Keywords | |
| 397 This line lists keywords. Eventually, it will be used by an apropos | |
| 398 command to allow people will find your package when they're looking for | |
| 399 things by topic area. To separate the keywords, you can use spaces, | |
| 400 commas, or both. | |
| 401 @end table | |
| 402 | |
| 403 Just about every Octave function ought to have the @samp{Author} and | |
| 404 @samp{Keywords} header comment lines. Use the others if they are | |
| 405 appropriate. You can also put in header lines with other header | |
| 406 names---they have no standard meanings, so they can't do any harm. | |
| 6574 | 407 |
| 408 @node Documentation Tips | |
| 409 @section Tips for Documentation Strings | |
| 410 | |
| 411 As noted above, documentation is typically in a commented header block | |
|
9080
ec41eabf4499
Cleanup documentation files dynamic.texi, testfun.texi, tips.texi
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
412 on an Octave function following the copyright statement. The help string |
| 7001 | 413 shown above is an unformatted string and will be displayed as is by |
|
9080
ec41eabf4499
Cleanup documentation files dynamic.texi, testfun.texi, tips.texi
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
414 Octave. Here are some tips for the writing of documentation strings. |
| 6574 | 415 |
| 416 @itemize @bullet | |
| 417 @item | |
| 418 Every command, function, or variable intended for users to know about | |
| 419 should have a documentation string. | |
| 420 | |
| 421 @item | |
| 422 An internal variable or subroutine of an Octave program might as well have | |
| 423 a documentation string. | |
| 424 | |
| 425 @item | |
| 426 The first line of the documentation string should consist of one or two | |
| 427 complete sentences that stand on their own as a summary. | |
| 428 | |
| 429 The documentation string can have additional lines that expand on the | |
| 430 details of how to use the function or variable. The additional lines | |
| 431 should also be made up of complete sentences. | |
| 432 | |
| 433 @item | |
| 434 For consistency, phrase the verb in the first sentence of a | |
| 435 documentation string as an infinitive with ``to'' omitted. For | |
| 436 instance, use ``Return the frob of A and B.'' in preference to ``Returns | |
| 437 the frob of A and B@.'' Usually it looks good to do likewise for the | |
| 438 rest of the first paragraph. Subsequent paragraphs usually look better | |
| 439 if they have proper subjects. | |
| 440 | |
| 441 @item | |
| 442 Write documentation strings in the active voice, not the passive, and in | |
| 443 the present tense, not the future. For instance, use ``Return a list | |
| 444 containing A and B.'' instead of ``A list containing A and B will be | |
| 445 returned.'' | |
| 446 | |
| 447 @item | |
| 448 Avoid using the word ``cause'' (or its equivalents) unnecessarily. | |
| 449 Instead of, ``Cause Octave to display text in boldface,'' write just | |
| 450 ``Display text in boldface.'' | |
| 451 | |
| 452 @item | |
| 453 Do not start or end a documentation string with whitespace. | |
| 454 | |
| 455 @item | |
| 456 Format the documentation string so that it fits in an Emacs window on an | |
| 457 80-column screen. It is a good idea for most lines to be no wider than | |
| 458 60 characters. | |
| 459 | |
| 460 However, rather than simply filling the entire documentation string, you | |
| 461 can make it much more readable by choosing line breaks with care. | |
| 462 Use blank lines between topics if the documentation string is long. | |
| 463 | |
| 464 @item | |
| 465 @strong{Do not} indent subsequent lines of a documentation string so | |
| 466 that the text is lined up in the source code with the text of the first | |
| 467 line. This looks nice in the source code, but looks bizarre when users | |
| 468 view the documentation. Remember that the indentation before the | |
| 469 starting double-quote is not part of the string! | |
| 470 | |
| 471 @item | |
| 472 The documentation string for a variable that is a yes-or-no flag should | |
| 473 start with words such as ``Nonzero means@dots{}'', to make it clear that | |
| 474 all nonzero values are equivalent and indicate explicitly what zero and | |
| 475 nonzero mean. | |
| 476 | |
| 477 @item | |
| 478 When a function's documentation string mentions the value of an argument | |
| 479 of the function, use the argument name in capital letters as if it were | |
| 480 a name for that value. Thus, the documentation string of the operator | |
| 481 @code{/} refers to its second argument as @samp{DIVISOR}, because the | |
| 482 actual argument name is @code{divisor}. | |
| 483 | |
| 484 Also use all caps for meta-syntactic variables, such as when you show | |
| 485 the decomposition of a list or vector into subunits, some of which may | |
| 486 vary. | |
| 487 @end itemize | |
| 488 | |
| 489 Octave also allows extensive formatting of the help string of functions | |
| 490 using Texinfo. The effect on the online documentation is relatively | |
| 491 small, but makes the help string of functions conform to the help of | |
| 492 Octave's own functions. However, the effect on the appearance of printed | |
| 493 or online documentation will be greatly improved. | |
| 494 | |
| 495 The fundamental building block of Texinfo documentation strings is the | |
| 496 Texinfo-macro @code{@@deftypefn}, which takes three arguments: The class | |
| 497 the function is in, its output arguments, and the function's | |
| 498 signature. Typical classes for functions include @code{Function File} | |
| 499 for standard Octave functions, and @code{Loadable Function} for | |
| 500 dynamically linked functions. A skeletal Texinfo documentation string | |
| 501 therefore looks like this | |
| 502 | |
| 503 @example | |
| 504 @group | |
| 505 -*- texinfo -*- | |
|
9210
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
506 @@deftypefn@{Function File@} @{@@var@{ret@} =@} fn (@dots{}) |
| 6574 | 507 @@cindex index term |
| 7081 | 508 Help text in Texinfo format. Code samples should be marked |
| 509 like @@code@{sample of code@} and variables should be marked | |
| 510 as @@var@{variable@}. | |
| 511 @@seealso@{fn2@} | |
| 6574 | 512 @@end deftypefn |
| 513 @end group | |
| 514 @end example | |
| 515 | |
| 516 This help string must be commented in user functions, or in the help | |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9080
diff
changeset
|
517 string of the @w{@code{DEFUN_DLD}} macro for dynamically loadable |
| 6574 | 518 functions. The important aspects of the documentation string are |
| 519 | |
| 520 @table @asis | |
|
10791
3140cb7a05a1
Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents:
10284
diff
changeset
|
521 @item -*- @nospell{texinfo} -*- |
|
8347
fa78cb8d8a5c
corrections for typos
Brian Gough<bjg@network-theory.co.uk>
parents:
7768
diff
changeset
|
522 This string signals Octave that the following text is in Texinfo format, |
| 6574 | 523 and should be the first part of any help string in Texinfo format. |
| 524 @item @@deftypefn@{class@} @dots{} @@end deftypefn | |
| 525 The entire help string should be enclosed within the block defined by | |
| 526 deftypefn. | |
| 527 @item @@cindex index term | |
| 528 This generates an index entry, and can be useful when the function is | |
| 529 included as part of a larger piece of documentation. It is ignored | |
|
9210
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
530 within Octave's help viewer. Only one index term may appear per line |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
531 but multiple @@cindex lines are valid if the function should be |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
532 filed under different terms. |
| 6574 | 533 @item @@var@{variable@} |
| 534 All variables should be marked with this macro. The markup of variables | |
| 535 is then changed appropriately for display. | |
| 536 @item @@code@{sample of code@} | |
| 537 All samples of code should be marked with this macro for the same | |
| 538 reasons as the @@var macro. | |
| 539 @item @@seealso@{function2@} | |
| 540 This is a comma separated list of function names that allows cross | |
| 541 referencing from one function documentation string to another. | |
| 542 @end table | |
| 543 | |
| 544 Texinfo format has been designed to generate output for online viewing | |
|
9210
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
545 with text terminals as well as generating high-quality printed output. |
| 6574 | 546 To these ends, Texinfo has commands which control the diversion of parts |
| 547 of the document into a particular output processor. Three formats are | |
|
10791
3140cb7a05a1
Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents:
10284
diff
changeset
|
548 of importance: info, HTML and @TeX{}. These are selected with |
| 6574 | 549 |
| 550 @example | |
| 551 @group | |
| 552 @@ifinfo | |
| 553 Text area for info only | |
| 554 @@end ifinfo | |
| 555 @end group | |
| 556 @end example | |
| 557 | |
| 558 @example | |
| 559 @group | |
| 560 @@ifhtml | |
|
9210
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
561 Text area for HTML only |
| 6574 | 562 @@end ifhtml |
| 563 @end group | |
| 564 @end example | |
| 565 | |
| 566 @example | |
| 567 @group | |
| 568 @@tex | |
|
9210
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
569 Text area for TeX only |
| 6574 | 570 @@end tex |
| 571 @end group | |
| 572 @end example | |
| 573 | |
|
10791
3140cb7a05a1
Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents:
10284
diff
changeset
|
574 Note that often @TeX{} output can be used in HTML documents and so often |
|
9080
ec41eabf4499
Cleanup documentation files dynamic.texi, testfun.texi, tips.texi
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
575 the @code{@@ifhtml} blocks are unnecessary. If no specific output |
| 6574 | 576 processor is chosen, by default, the text goes into all output |
|
9080
ec41eabf4499
Cleanup documentation files dynamic.texi, testfun.texi, tips.texi
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
577 processors. It is usual to have the above blocks in pairs to allow the |
| 6574 | 578 same information to be conveyed in all output formats, but with a |
|
9210
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
579 different markup. Currently, most Octave documentation only makes a |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
580 distinction between @TeX{} and all other formats. Therefore, the |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
581 following construct is seen repeatedly. |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
582 |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
583 @example |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
584 @group |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
585 @@tex |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
586 text for TeX only |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
587 @@end tex |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
588 @@ifnottex |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
589 text for info, HTML, plaintext |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
590 @@end ifnottex |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
591 @end group |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
592 @end example |
| 6574 | 593 |
| 594 Another important feature of Texinfo that is often used in Octave help | |
|
9080
ec41eabf4499
Cleanup documentation files dynamic.texi, testfun.texi, tips.texi
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
595 strings is the @code{@@example} environment. An example of its use is |
| 6574 | 596 |
| 597 @example | |
| 598 @group | |
| 599 @@example | |
| 600 @@group | |
| 601 @@code@{2 * 2@} | |
| 602 @@result@{@} 4 | |
| 603 @@end group | |
| 604 @@end example | |
| 605 @end group | |
| 606 @end example | |
| 607 | |
| 608 which produces | |
| 609 | |
| 610 @example | |
| 611 @group | |
| 612 @code{2 * 2} | |
| 613 @result{} 4 | |
| 614 @end group | |
| 615 @end example | |
| 616 | |
| 617 The @code{@@group} block prevents the example from being split across a | |
| 618 page boundary, while the @code{@@result@{@}} macro produces a right | |
|
9210
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
619 arrow signifying the result of a command. If your example is larger than |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
620 20 lines it is better NOT to use grouping so that a reasonable page boundary |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
621 can be calculated. |
| 6574 | 622 |
| 8828 | 623 In many cases a function has multiple ways in which it can be called, |
|
9080
ec41eabf4499
Cleanup documentation files dynamic.texi, testfun.texi, tips.texi
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
624 and the @code{@@deftypefnx} macro can be used to give alternatives. For |
| 6574 | 625 example |
| 626 | |
| 627 @example | |
| 628 @group | |
| 629 -*- texinfo -*- | |
|
9210
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
630 @@deftypefn@{Function File@} @{@@var@{a@} =@} fn (@@var@{x@}, @dots{}) |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
631 @@deftypefnx@{Function File@} @{@@var@{a@} =@} fn (@@var@{y@}, @dots{}) |
| 6574 | 632 Help text in Texinfo format. |
| 633 @@end deftypefn | |
| 634 @end group | |
| 635 @end example | |
| 636 | |
| 637 Many complete examples of Texinfo documentation can be taken from the | |
|
9080
ec41eabf4499
Cleanup documentation files dynamic.texi, testfun.texi, tips.texi
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
638 help strings for the Octave functions themselves. A relatively complete |
|
ec41eabf4499
Cleanup documentation files dynamic.texi, testfun.texi, tips.texi
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
639 example of which is the @code{nchoosek} function. The Texinfo |
|
9210
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
640 documentation string for @code{nchoosek} is |
| 6574 | 641 |
| 642 @example | |
| 643 -*- texinfo -*- | |
| 7081 | 644 @@deftypefn @{Function File@} @{@} nchoosek (@@var@{n@}, @@var@{k@}) |
| 6574 | 645 |
| 7081 | 646 Compute the binomial coefficient or all combinations of |
|
9080
ec41eabf4499
Cleanup documentation files dynamic.texi, testfun.texi, tips.texi
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
647 @@var@{n@}. If @@var@{n@} is a scalar then, calculate the |
| 7081 | 648 binomial coefficient of @@var@{n@} and @@var@{k@}, defined as |
| 6574 | 649 |
| 650 @@tex | |
| 651 $$ | |
| 652 @{n \choose k@} = @{n (n-1) (n-2) \cdots (n-k+1) \over k!@} | |
| 653 $$ | |
| 654 @@end tex | |
|
9210
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
655 @@ifnottex |
| 6574 | 656 |
| 657 @@example | |
| 658 @@group | |
| 659 / \ | |
|
9080
ec41eabf4499
Cleanup documentation files dynamic.texi, testfun.texi, tips.texi
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
660 | n | n (n-1) (n-2) @dots{} (n-k+1) |
| 6574 | 661 | | = ------------------------- |
| 662 | k | k! | |
| 663 \ / | |
| 664 @@end group | |
| 665 @@end example | |
|
9210
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
666 @@end ifnottex |
| 6574 | 667 |
| 7081 | 668 If @@var@{n@} is a vector, this generates all combinations |
| 669 of the elements of @@var@{n@}, taken @@var@{k@} at a time, | |
|
9080
ec41eabf4499
Cleanup documentation files dynamic.texi, testfun.texi, tips.texi
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
670 one row per combination. The resulting @@var@{c@} has size |
| 7081 | 671 @@code@{[nchoosek (length (@@var@{n@}),@@var@{k@}), @@var@{k@}]@}. |
| 6574 | 672 |
|
9210
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
673 @@code@{nchoosek@} works only for non-negative integer arguments; use |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
674 @@code@{bincoeff@} for non-integer scalar arguments and for using vector |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
675 arguments to compute many coefficients at once. |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
676 |
| 6574 | 677 @@seealso@{bincoeff@} |
| 678 @@end deftypefn | |
| 679 @end example | |
| 680 | |
| 681 which demonstrates most of the concepts discussed above. | |
| 682 @iftex | |
| 683 This documentation string renders as | |
| 684 | |
| 685 @c Note actually use the output of info below rather than try and | |
| 686 @c reproduce it here to prevent it looking different than how it would | |
| 687 @c appear with info. | |
| 688 @example | |
| 689 @group | |
| 690 -- Function File: C = nchoosek (N, K) | |
| 7081 | 691 Compute the binomial coefficient or all combinations |
| 692 of N. If N is a scalar then, calculate the binomial | |
| 693 coefficient of N and K, defined as | |
| 6574 | 694 |
| 695 / \ | |
|
9080
ec41eabf4499
Cleanup documentation files dynamic.texi, testfun.texi, tips.texi
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
696 | n | n (n-1) (n-2) @dots{} (n-k+1) n! |
| 7081 | 697 | | = ------------------------- = --------- |
| 698 | k | k! k! (n-k)! | |
| 6574 | 699 \ / |
| 700 | |
| 7081 | 701 If N is a vector generate all combinations of the |
| 702 elements of N, taken K at a time, one row per | |
|
9080
ec41eabf4499
Cleanup documentation files dynamic.texi, testfun.texi, tips.texi
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
703 combination. The resulting C has size `[nchoosek |
| 7081 | 704 (length (N), K), K]'. |
| 6574 | 705 |
|
9210
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
706 `nchoosek' works only for non-negative integer |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
707 arguments; use `bincoeff' for non-integer scalar |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
708 arguments and for using vector arguments to compute |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
709 many coefficients at once. |
| 6574 | 710 |
| 711 See also: bincoeff. | |
| 712 @end group | |
| 713 @end example | |
| 714 | |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9080
diff
changeset
|
715 using info, whereas in a printed documentation using @TeX{} it will appear |
| 6574 | 716 as |
| 717 | |
| 718 @deftypefn {Function File} {@var{c} =} nchoosek (@var{n}, @var{k}) | |
| 719 | |
| 6576 | 720 Compute the binomial coefficient or all combinations of @var{n}. |
| 6574 | 721 If @var{n} is a scalar then, calculate the binomial coefficient |
| 722 of @var{n} and @var{k}, defined as | |
| 723 | |
| 724 @tex | |
| 725 $$ | |
| 726 {n \choose k} = {n (n-1) (n-2) \cdots (n-k+1) \over k!} | |
| 727 $$ | |
| 728 @end tex | |
| 729 | |
| 730 If @var{n} is a vector generate all combinations of the elements | |
|
9080
ec41eabf4499
Cleanup documentation files dynamic.texi, testfun.texi, tips.texi
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
731 of @var{n}, taken @var{k} at a time, one row per combination. The |
| 6574 | 732 resulting @var{c} has size @code{[nchoosek (length (@var{n}), |
| 733 @var{k}), @var{k}]}. | |
| 734 | |
|
9210
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
735 @code{nchoosek} works only for non-negative integer arguments; use |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
736 @code{bincoeff} for non-integer scalar arguments and for using vector |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
737 arguments to compute many coefficients at once. |
|
a7a9eecc07b5
Change recommendation for writing documentation to favor @tex
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
738 |
| 6574 | 739 @seealso{bincoeff} |
| 740 @end deftypefn | |
| 741 | |
| 742 @end iftex |