Mercurial > octave
annotate doc/refcard/refcard.tex @ 31264:af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
refcard.tex: Remove Readline material, expand Octave examples.
The intended audience of this reference card is someone who
already knows programming in a different language like Python
and is referring to this refcard.ps / refcard.pdf for Octave
syntax. It is not a comprehensive reference, but gives enough
function names to be useful with help / doc.
Intended length 2 pages.
| author | Arun Giridhar <arungiridhar@gmail.com> |
|---|---|
| date | Wed, 05 Oct 2022 22:26:22 -0400 |
| parents | 796f54d4ddbf |
| children | 3e4b9ecc031c |
| rev | line source |
|---|---|
| 2333 | 1 % refcard.tex |
| 2 % | |
| 3 % This file is TeX source for a reference card describing Octave. | |
| 4 % | |
|
30564
796f54d4ddbf
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
29358
diff
changeset
|
5 % Copyright (C) 1996-2022 The Octave Project Developers |
|
27918
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
6 % |
|
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
7 % See the file COPYRIGHT.md in the top-level directory of this |
|
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
8 % distribution or <https://octave.org/copyright/>. |
| 2333 | 9 % |
| 7016 | 10 % This file is part of Octave. |
| 11 % | |
|
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
12 % Octave is free software: you can redistribute it and/or modify it |
|
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
13 % under the terms of the GNU General Public License as published by |
|
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
14 % the Free Software Foundation, either version 3 of the License, or |
|
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
15 % (at your option) any later version. |
| 2333 | 16 % |
|
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
17 % Octave is distributed in the hope that it will be useful, but |
|
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
18 % WITHOUT ANY WARRANTY; without even the implied warranty of |
|
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
19 % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
20 % GNU General Public License for more details. |
| 2333 | 21 % |
| 7016 | 22 % You should have received a copy of the GNU General Public License |
| 23 % along with Octave; see the file COPYING. If not, see | |
|
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
24 % <https://www.gnu.org/licenses/>. |
| 2333 | 25 % |
|
27918
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
26 % |
| 7018 | 27 % Heavily modified by jwe from the source for the gdb reference card, |
|
27956
2310164737b3
fix many spelling errors (bug #57613)
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
28 % which was originally written by Roland Pesch <pesch@cygnus.com>. |
| 7018 | 29 % |
| 30 % Copyright (C) 1991, 1992 Free Software Foundation, Inc. | |
| 31 % Permission is granted to make and distribute verbatim copies of | |
| 32 % this reference provided the copyright notices and permission notices | |
| 33 % are preserved on all copies. | |
| 34 % | |
|
27918
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
35 % |
| 7018 | 36 % TeX markup is a programming language; accordingly this file is source |
| 37 % for a program to generate a reference. | |
| 38 % | |
| 2333 | 39 % You only have to set the total width and height of the paper, the |
| 40 % horizontal and vertical margin space measured from *paper edge* | |
| 41 % and the interline and interspec spacing. | |
| 42 % In order to support a new papersize, you have to fiddle with the | |
| 43 % latter four dimensions. Just try out a few values. | |
| 44 % All other values will be computed at process time so it should be | |
| 45 % quite easy to support different paper sizes - only four values to | |
| 46 % guess :-) | |
| 47 % | |
| 48 % To find the configuration places, just search for the string | |
| 49 % "User configuration". | |
| 50 % | |
| 51 % -- Andreas Vogel (av@ssw.de) | |
| 52 % | |
| 53 % NOTE ON INTENTIONAL OMISSIONS: This reference card includes many | |
| 54 % Octave commands, but due to space constraints there are some things | |
| 55 % I chose to omit. In general, not all synonyms for commands are | |
| 56 % covered, nor all variations of a command. | |
| 57 | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
58 \def\octaveversion{8.0.0} |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
59 \def\refcardedition{3.0} |
| 2333 | 60 |
| 61 % ------------------ | |
| 62 % multicolumn format | |
| 63 % ------------------ | |
| 64 | |
| 65 % Declarations (these must come first) | |
| 66 | |
| 67 \newdimen\totalwidth | |
| 68 \newdimen\totalheight | |
| 69 \newdimen\hmargin | |
| 70 \newdimen\vmargin | |
| 71 \newdimen\secskip | |
| 72 \newdimen\lskip | |
| 73 \newdimen\barwidth | |
| 74 \newdimen\barheight | |
| 75 \newdimen\intersecwidth | |
| 76 | |
| 77 \newcount\columnsperpage | |
| 78 | |
| 79 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
| 80 % % | |
| 81 % CONFIGURATION % | |
| 82 % % | |
| 83 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
| 84 | |
| 85 % There are currently 8 total columns, so some of these options will | |
| 86 % not create a single page reference card. | |
| 87 | |
| 88 % Choose a paper size. Default is US letter size. | |
| 89 | |
| 90 \def\refcardafoursize{a4} % 3 columns, A4 paper (1 in = 254 mm) | |
| 91 \def\refcardlegalsize{legal} % 4 columns, US legal paper (8.5 x 14in) | |
| 4893 | 92 \def\refcardlettersize{letter} % 3 columns, US letter paper (8.5 x 11in) |
| 2333 | 93 |
| 94 \ifx\refcardsize\refcardafoursize | |
| 95 \columnsperpage=3 % total number of columns to typeset | |
| 96 \totalwidth=297mm % total width of paper | |
| 97 \totalheight=210mm % total height of paper | |
| 98 \hmargin=9mm % horizontal margin width | |
| 99 \vmargin=7mm % vertical margin width | |
| 100 \secskip=3mm % space between refcard secs | |
| 101 \lskip=0.4mm % extra skip between \sec entries | |
| 102 \else | |
| 103 \ifx\refcardsize\refcardlegalsize | |
| 104 \columnsperpage=4 % total number of columns to typeset | |
| 105 \totalwidth=14in % total width of paper | |
| 106 \totalheight=8.5in % total height of paper | |
| 107 \hmargin=0.20in % horizontal margin width | |
| 108 \vmargin=0.25in % vertical margin width | |
| 109 \secskip=0.75pc % space between refcard secs | |
| 110 \lskip=2pt % extra skip between \sec entries | |
| 111 \else | |
| 112 \columnsperpage=3 % total number of columns to typeset | |
| 113 \totalwidth=11in % total width of paper | |
| 114 \totalheight=8.5in % total height of paper | |
| 115 \hmargin=0.25in % horizontal margin width | |
| 116 \vmargin=0.25in % vertical margin width | |
| 117 \secskip=0.75pc % space between refcard secs | |
| 118 \lskip=2pt % extra skip between \sec entries | |
| 119 \fi | |
| 120 \fi | |
| 121 | |
| 4489 | 122 \ifx\pdfoutput\undefined |
| 123 \else | |
| 124 \pdfpageheight=\totalheight | |
| 4866 | 125 \pdfpagewidth=\totalwidth |
| 4489 | 126 \fi |
| 127 | |
| 2333 | 128 % Change according to personal taste, not papersize dependent. |
| 129 | |
| 130 \barwidth=.1pt % width of the cropmark bar | |
| 131 \barheight=2pt % height of the cropmark bar | |
| 132 \intersecwidth=0.5em % width between \itmwid and \dfnwid | |
| 133 | |
| 134 % Uncomment only one of the following definitions for folding guides. | |
| 135 | |
| 136 % No printed folding guide: | |
| 137 | |
| 138 %\def\vdecor{\hskip\hmargin plus1fil | |
| 139 % \hskip\barwidth plus1fil | |
| 140 % \hskip\hmargin plus1fil} | |
| 141 | |
| 142 % Solid line folding guide: | |
| 143 | |
| 144 %\def\vdecor{\hskip\hmargin plus1fil% | |
| 145 % \vrule width \barwidth% | |
| 146 % \hskip\hmargin plus1fil} | |
| 147 | |
| 148 % For small marks near top and bottom as folding guide: | |
| 149 | |
| 150 \def\vdecor{\hskip\hmargin plus1fil% | |
| 151 \vbox to \vsize{\hbox to \barwidth{\vrule height\barheight width\barwidth}% | |
| 152 \vfill | |
| 153 \hbox to \barwidth{\vrule height\barheight width\barwidth}}% | |
| 154 \hskip\hmargin plus1fil} | |
| 155 | |
| 156 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
| 157 % % | |
| 158 % END CONFIGURATION % | |
| 159 % % | |
| 160 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
| 161 | |
| 162 % values to be computed based on above definitions. | |
| 163 % nothing to configure | |
| 164 | |
| 165 \newdimen\fullhsize % width of area without margins | |
| 166 \newdimen\itmwid % width of item column | |
| 167 \newdimen\dfnwid % width of definition column | |
| 168 \newdimen\idnwid % width of indented text | |
| 169 \newdimen\temp % only for temporary use | |
| 170 | |
| 171 % an alternate section format, used in some cases to make text fit better. | |
| 172 | |
| 173 \newdimen\altitmwid % width of item column in altsec | |
| 174 \newdimen\altdfnwid % width of definition column in altsec | |
| 175 | |
| 176 % Subtract hmargin for left and right sides of paper from full width. | |
| 177 % | |
| 178 % fullhsize = totalwidth - (2 * hmargin) | |
| 179 | |
| 180 \fullhsize=\totalwidth | |
| 181 \temp=\hmargin | |
| 182 \multiply \temp by 2 | |
| 183 \advance \fullhsize by -\temp | |
| 184 | |
| 185 % intercolumn space is composed of hmargin barwidth hmargin so that we | |
| 186 % get the same amount of space on either side of the (optional) rule | |
| 187 % between columns. For N columns, we need to subtract this amount of | |
| 188 % space N-1 times. Divide by the number of columns to get the final | |
| 189 % value of \hsize that we use to typeset columns. | |
| 190 | |
| 191 % hsize = (fullhsize - (ncols-1)*barwidth - 2*(ncols-1)*hmargin) / ncols | |
| 192 | |
| 193 \newcount\tmpcnt | |
| 194 \tmpcnt\columnsperpage | |
| 195 \advance \tmpcnt by -1 | |
| 196 | |
| 197 \hsize=\fullhsize | |
| 198 | |
| 199 \temp=\barwidth | |
| 200 \multiply \temp by \tmpcnt | |
| 201 \advance \hsize by -\temp | |
| 202 | |
| 203 \multiply \tmpcnt by 2 | |
| 204 | |
| 205 \temp=\hmargin | |
| 206 \multiply \temp by \tmpcnt | |
| 207 \advance \hsize by -\temp | |
| 208 | |
| 209 \divide \hsize by \columnsperpage | |
| 210 | |
| 211 % Vertical size is easy -- same amount of space above and below. | |
| 212 % | |
| 213 % vsize = totalheight - (2 * vmargin) | |
| 214 | |
| 215 \vsize=\totalheight | |
| 216 \temp=\vmargin | |
| 217 \multiply \temp by 2 | |
| 218 \advance \vsize by -\temp | |
| 219 | |
| 220 % adjust the offsets so the margins are measured *from paper edge* | |
| 221 | |
| 222 \hoffset=-1in \advance \hoffset by \hmargin | |
| 223 \voffset=-1in \advance \voffset by \vmargin | |
| 224 | |
| 225 % Width of items in a section. | |
| 226 | |
| 227 % itmwid = (hsize - intersecwidth) * 1/3 | |
| 228 % dfnwid = (hsize - intersecwidth) * 2/3 | |
| 229 | |
| 230 % width of the item | |
| 231 | |
| 232 \temp=\hsize | |
| 233 \advance \temp by -\intersecwidth | |
| 234 \divide \temp by 3 | |
| 235 \itmwid=\temp | |
| 236 | |
| 237 % width of the corresponding definition | |
| 238 | |
| 239 \dfnwid=\hsize | |
| 240 \advance \dfnwid by -\itmwid | |
| 241 | |
| 242 % indentation for sub items, etc. | |
| 243 | |
| 244 \temp=\hsize \advance\temp by -1em | |
| 245 \idnwid=\temp | |
| 246 | |
| 247 % Width of items in an alt section. | |
| 248 | |
| 249 \altitmwid=\itmwid \advance \altitmwid by 0.35in | |
| 250 \altdfnwid=\dfnwid \advance \altdfnwid by -0.35in | |
| 251 | |
| 252 % Output macros. | |
| 253 % | |
| 254 % Strategy: | |
| 255 % | |
| 256 % * set each column in a box | |
| 257 % * append new columns in a global `holding' box, inserting | |
| 258 % intercolumn decorations as necessary. | |
| 259 % * when we fill a page, dump the saved box and the latest column, | |
| 260 % separated by the intercolumn decoration. | |
| 261 | |
| 262 \newbox\holdbox | |
| 263 \newcount\colno | |
| 264 \colno=0 | |
| 265 | |
| 266 \output={\relax | |
| 267 \global\advance\colno by 1 | |
| 268 \ifnum\colno=1 | |
| 269 \global\setbox\holdbox=\columnbox | |
| 270 \else | |
| 271 \ifnum\colno=\columnsperpage | |
| 272 \shipout\hbox to \fullhsize{\box\holdbox\vdecor\columnbox} | |
| 273 \advancepageno | |
| 274 \global\colno=0 | |
| 275 \else | |
| 276 \global\setbox\holdbox=\vbox{\hbox{\box\holdbox\vdecor\columnbox}} | |
| 277 \fi | |
| 278 \fi} | |
| 279 | |
| 280 \def\columnbox{\leftline{\pagebody}} | |
| 281 | |
| 282 \def\bye{\par\vfill | |
| 283 \supereject | |
| 284 \if R\lcr \null\vfill\eject \fi | |
| 285 \end} | |
| 286 | |
| 287 % ----- | |
| 288 % Fonts | |
| 289 % ----- | |
| 290 | |
| 291 \font\bbf=cmbx10 | |
| 292 \font\vbbf=cmbx12 | |
| 293 \font\smrm=cmr6 | |
| 294 \font\brm=cmr10 | |
| 295 \font\rm=cmr7 | |
| 296 \font\it=cmti7 | |
| 297 \font\tt=cmtt8 | |
| 298 | |
| 299 % We can afford to allow some slop | |
| 300 | |
| 301 \hfuzz=1pt | |
| 302 \vfuzz=1pt | |
| 303 \hyphenpenalty=5000 | |
| 304 \tolerance=2000 | |
| 305 \raggedright | |
| 306 \raggedbottom | |
| 307 \normalbaselineskip=9pt | |
| 308 \baselineskip=9pt | |
| 309 | |
| 310 \parindent=0pt | |
| 311 \parskip=0pt | |
| 312 \footline={\vbox to0pt{\hss}} | |
| 313 | |
| 314 \def\ctl#1{{\tt C-#1}} | |
| 315 \def\opt#1{{\brm[{\rm #1}]}} | |
| 316 \def\xtra#1{\noalign{\smallskip{\tt#1}}} | |
| 317 | |
| 318 % A normal section | |
| 319 | |
| 320 \long\def\sec#1;#2\endsec{\vskip \secskip | |
| 321 \halign{% | |
| 322 % | |
| 323 % column 1 (of halign): | |
| 324 % | |
| 325 \vtop{\hsize=\itmwid\tt ##\par\vskip \lskip }\hfil | |
| 326 % | |
| 327 % column 2 (of halign): | |
| 328 % | |
| 329 &\vtop{% | |
| 330 \hsize=\dfnwid | |
| 331 \hangafter=1 | |
| 332 \hangindent=\intersecwidth | |
| 333 \rm ##\par\vskip \lskip}\cr | |
| 334 % | |
| 335 % Tail of \long\def fills in halign body with \sec args: | |
| 336 % | |
| 337 \noalign{{\bbf #1}% | |
| 338 \vskip \lskip} | |
| 339 #2}} | |
| 340 | |
| 341 \long\def\widesec#1;#2\endsec{\vskip \secskip | |
| 342 \halign{% | |
| 343 % | |
| 344 % column 1 (of halign): | |
| 345 % | |
| 346 \vbox{\tt | |
| 347 ##\par\vskip \lskip }\cr | |
| 348 % | |
| 349 % Tail of \long\def fills in halign body with \sec args: | |
| 350 % | |
| 351 \noalign{{\bbf #1}\vskip 3\lskip} | |
| 352 #2}} | |
| 353 | |
| 354 % an alternate section format, used in some cases to make text fit better. | |
| 355 | |
| 356 \long\def\altsec#1;#2\endsec{\vskip \secskip | |
| 357 \halign{% | |
| 358 % | |
| 359 % column 1 (of halign): | |
| 360 % | |
| 361 \vtop{\hsize=\altitmwid\tt | |
| 362 ##\par\vskip \lskip}\hfil | |
| 363 % | |
| 364 % column 2 (of halign): | |
| 365 % | |
| 366 &\vtop{% | |
| 367 \hsize=\altdfnwid | |
| 368 \hangafter=1 | |
| 369 \hangindent=\intersecwidth | |
| 370 \rm ##\par\vskip \lskip}\cr | |
| 371 % | |
| 372 % Tail of \long\def fills in halign body with \sec args: | |
| 373 % | |
| 374 \noalign{{\bbf #1}\vskip \lskip} | |
| 375 #2}} | |
| 376 | |
| 377 % ------------------------------------- | |
| 378 % The actual text of the reference card | |
| 379 % ------------------------------------- | |
| 380 | |
| 381 {\vbbf Octave Quick Reference}\hfil{\smrm Octave Version \octaveversion}\qquad | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
382 \centerline{\smrm Copyright 1996-2022 The Octave Project Developers\qquad Permissions on back} |
| 2333 | 383 |
| 384 \sec Starting Octave; | |
| 385 octave&start interactive Octave session\cr | |
| 386 octave {\it file}&run Octave on commands in {\it file}\cr | |
| 7040 | 387 octave --eval {\it code}&Evaluate {\it code} using Octave\cr |
| 2333 | 388 octave --help&describe command line options\cr |
| 389 \endsec | |
| 390 | |
| 391 \sec Stopping Octave; | |
| 392 quit {\rm or} exit&exit Octave\cr | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
393 Ctrl-C&terminate current command and return to top-level prompt\cr |
| 2333 | 394 \endsec |
| 395 | |
| 396 \sec Getting Help; | |
| 397 help {\it command}&briefly describe {\it command}\cr | |
| 7040 | 398 doc&use Info to browse Octave manual\cr |
| 399 doc {\it command}&search for {\it command} in Octave manual\cr | |
| 400 lookfor {\it str}&search for {\it command} based on {\it str}\cr | |
| 2333 | 401 \endsec |
| 402 | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
403 \sec Command Completion and History; |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
404 TAB&complete a command or variable name\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
405 Alt-?&list possible completions\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
406 Ctrl-r, Ctrl-s&search command history\cr |
| 2333 | 407 \endsec |
| 408 | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
409 \sec Directory and Path Commands; |
| 2333 | 410 cd {\it dir}&change working directory to {\it dir}\cr |
| 411 pwd&print working directory\cr | |
| 412 ls \opt{{\it options}}&print directory listing\cr | |
| 413 getenv ({\it string})&return value of named environment variable\cr | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
414 what&list .m and .mat files in the current directory\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
415 path&display the current Octave function path.\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
416 pathdef&display the default path.\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
417 addpath ({\it dir})&add a directory to the path.\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
418 EXEC\_PATH&manipulate the Octave executable path.\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
419 \endsec |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
420 |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
421 \sec Package Management; |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
422 pkg install -forge&download and install package\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
423 pkg install &install an already downloaded package\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
424 pkg list&display installed packages.\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
425 pkg load / pkg unload &Load and unload an installed package.\cr |
| 2333 | 426 \endsec |
| 427 | |
| 428 \sec Matrices; | |
| 429 \omit\vbox{\rm\vskip0.25ex | |
| 430 Square brackets delimit literal matrices. Commas separate elements | |
| 431 on the same row. Semicolons separate rows. Commas may be replaced | |
| 432 by spaces, and semicolons may be replaced by one or more newlines. | |
| 7040 | 433 Elements of a matrix may be arbitrary expressions, assuming |
| 2333 | 434 all the dimensions agree.\vskip0.75ex}\span\cr |
| 435 [ {\it x}, {\it y}, ... ]&enter a row vector\cr | |
| 436 [ {\it x}; {\it y}; ... ]&enter a column vector\cr | |
| 437 [ {\it w}, {\it x}; {\it y}, {\it z} ]&enter a 2$\times$2 matrix\cr | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
438 rows&number of rows of matrix\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
439 columns&number of columns of matrix\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
440 zeros&create matrix of zeros\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
441 ones&create matrix of ones\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
442 eye&create identity matrix\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
443 diag&create diagonal matrix\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
444 rand randi randn&create matrix of random values\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
445 all&true if all elements nonzero\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
446 any&true if at least one element nonzero\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
447 nnz ({\it s})&Count nonzero elements of {\it s}.\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
448 sparse&create a sparse matrix\cr |
| 2333 | 449 \endsec |
| 450 | |
| 7040 | 451 \sec Multi-dimensional Arrays; |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
452 cat&concatenate variables along the specified dimension\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
453 reshape&change the shape of vector or matrix or array\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
454 squeeze&remove singleton dimensions\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
455 ndims&number of dimensions\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
456 permute, ipermute, shiftdim&permute the dimensions of an array, like a generalized transpose\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
457 circshift&rotate the array elements\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
458 meshgrid&create coordinate matrices useful for vectorization\cr |
| 7040 | 459 \endsec |
| 460 | |
| 2333 | 461 \sec Ranges; |
| 462 {\it base} : {\it limit}\cr | |
| 463 {\it base} : {\it incr} : {\it limit}\cr | |
| 464 \omit\hfill\vbox{\hsize=\idnwid\rm\vskip0.75ex | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
465 {\it incr} == 1 if not specified. Negative ranges allowed.}\span\cr |
| 2333 | 466 \endsec |
| 467 | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
468 \sec Numeric Types And Values; |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
469 \omit\vbox{\rm\vskip0.5ex |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
470 Integers saturate in Octave. They do not wrap around. |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
471 \vskip0.75ex}\span\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
472 int8, int16, int32, int64&Signed integers\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
473 uint8, uint16, uint32, uint64&Unsigned integers\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
474 single double&32-bit / 64-bitIEEE floating point\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
475 intmin, intmax, flintmax&Integer limits of given type\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
476 realmax, realmin&Floating point limits of given type\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
477 Inf, NaN, NA&IEEE infinity, NaN, missing value\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
478 eps&machine precision\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
479 pi, e&3.14159..., 2.71828...\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
480 i, j&$\sqrt{-1}$\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
481 \endsec |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
482 |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
483 \sec Strings; |
| 2333 | 484 \omit\vbox{\rm\vskip0.5ex |
| 485 A {\it string constant\/} consists of a sequence of characters | |
| 7040 | 486 enclosed in either double-quote or single-quote marks. Strings |
| 487 in double-quotes allow the use of the escape sequences below. | |
| 488 \vskip0.75ex}\span\cr | |
| 2333 | 489 \char'134\char'134&a literal backslash\cr |
| 490 \char'134 "&a literal double-quote character\cr | |
| 491 \char'134 '&a literal single-quote character\cr | |
| 492 \char'134 n&newline, ASCII code 10\cr | |
| 493 \char'134 t&horizontal tab, ASCII code 9\cr | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
494 sprintf, sscanf&formatted IO to/from string\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
495 strcmp&compare strings\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
496 strcat&concatenate strings\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
497 strfind, regexp&strings matching substrings or regular expressions\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
498 strrep, regexprep&match and replace sub-strings\cr |
| 2333 | 499 \endsec |
| 500 | |
| 501 \sec Index Expressions; | |
| 502 {\it var} ({\it idx})&select elements of a vector\cr | |
| 503 {\it var} ({\it idx1}, {\it idx2})&select elements of a matrix\cr | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
504 {\it var} ({\it [1 3]}, {\it :})&rows 1 and 3\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
505 {\it var} ({\it :}, {\it [2 end]})&the second and last columns\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
506 {\it var} ({\it 1:2:end}, {\it 2:2:end})&submatrix with odd rows and even columns\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
507 {\it var1} ({\it var2} == 0)&elements of {\it var1} corresponding to zero elements of {\it var2}\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
508 {\it var} ({:})&all elements as a column vector\cr |
| 2333 | 509 \endsec |
| 510 | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
511 \sec Cells and Structures; |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
512 % |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
513 % FIXME add classdef to this section? |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
514 % |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
515 {\it{var}}.{\it{field}} = ...&set a field of a structure.\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
516 {\it{var}}$\{${\it{idx}}$\}$ = ...&set an element of a cell array.\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
517 cellfun ({\it f}, {\it c})&apply a function to elements of cell array.\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
518 fieldnames ({\it s})&returns the fields of a structure.\cr |
| 2333 | 519 \endsec |
| 520 | |
| 7040 | 521 \sec Assignment Expressions; |
| 522 {\it var} = {\it expr}&assign expression to variable\cr | |
| 523 {\it var} ({\it idx}) = {\it expr}&assign expression to indexed variable\cr | |
| 524 {\it var} ({\it idx}) = []&delete the indexed elements.\cr | |
| 525 {\it var} $\{${\it idx}$\}$ = {\it expr}&assign elements of a cell array.\cr | |
| 526 \endsec | |
| 2333 | 527 |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
528 \sec Arithmetic Operators; |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
529 \omit \vbox{\rm\vskip0.75ex |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
530 If two operands are of different sizes, scalars and singleton dimensions are automatically expanded. Non-singleton dimensions need to match.\vskip0.75ex}\span\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
531 {\it x} + {\it y}, {\it x} - {\it y}&addition, subtraction\cr |
| 2333 | 532 {\it x} * {\it y}&matrix multiplication\cr |
| 533 {\it x} .* {\it y}&element by element multiplication\cr | |
| 534 {\it x} / {\it y}&right division, conceptually equivalent to | |
| 535 {\tt (inverse~(y')~*~x')'}\cr | |
| 536 {\it x} ./ {\it y}&element by element right division\cr | |
| 537 {\it x} \char'134{} {\it y}&left division, conceptually equivalent to | |
| 538 {\tt inverse~(x)~*~y}\cr | |
| 539 {\it x} .\char'134{} {\it y}&element by element left division\cr | |
| 540 {\it x} \char'136{} {\it y}&power operator\cr | |
| 541 {\it x} .\char'136{} {\it y}&element by element power operator\cr | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
542 +=, -=, *=, .*=, /=, ./=, \char'134{}=, .\char'134{}=, \char'136{}=, .\char'136{}=&in-place equivalents of the above operators\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
543 -{\it x}&negation\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
544 +{\it x}&unary plus (a no-op)\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
545 {\it x}'&complex conjugate transpose\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
546 {\it x}.'&transpose\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
547 ++{\it x}, --{\it x}&increment / decrement, return {\it new\/} value\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
548 {\it x}++, {\it x}--&increment / decrement, return {\it old\/} value\cr |
| 2333 | 549 \endsec |
| 550 | |
| 551 \sec Comparison and Boolean Operators; | |
| 552 \omit \vbox{\rm\vskip0.75ex | |
| 553 These operators work on an element-by-element basis. Both arguments | |
| 554 are always evaluated.\vskip0.75ex}\span\cr | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
555 < <= == >= >&less than, less than or equal to, equal to, greater than or equal to, greater than\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
556 % |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
557 % FIXME add ~= and ~. TeX mangles the tilde and escaping with \ or {} does not help. |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
558 % |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
559 !=¬ equal to\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
560 \&&logical AND\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
561 |&logical OR\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
562 !&logical NOT\cr |
| 2333 | 563 \endsec |
| 564 | |
| 565 \sec Short-circuit Boolean Operators; | |
| 566 \omit \vbox{\rm\vskip0.75ex | |
|
19593
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
567 Operators evaluate left-to-right. Operands are only evaluated if |
|
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
568 necessary, stopping once overall truth value can be determined. |
|
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
569 Operands are converted to scalars using the {\tt all} |
|
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
570 function.\vskip0.75ex}\span\cr |
| 2333 | 571 {\it x} \&\& {\it y}&true if both {\it x\/} and {\it y\/} are true\cr |
| 572 {\it x} || {\it y}&true if at least one of {\it x\/} or {\it y\/} is true\cr | |
| 573 \endsec | |
| 574 | |
| 575 \sec Operator Precedence; | |
| 576 \omit \vbox{\rm\vskip0.5ex | |
| 7040 | 577 Table of Octave operators, in order of increasing |
| 2333 | 578 precedence.\vskip0.75ex}\span\cr |
| 579 ;\ \ ,&statement separators\cr | |
| 580 =&assignment, groups left to right\cr | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
581 += -= *= /= etc &in-place operators\cr |
| 2333 | 582 ||\ \ \&\&&logical ``or'' and ``and''\cr |
| 583 |\ \ \&&element-wise ``or'' and ``and''\cr | |
| 584 < <= == >= > !=&relational operators\cr | |
| 585 :&colon\cr | |
| 586 +\ \ -&addition and subtraction\cr | |
| 587 * / \char'134\ \ .*\ \ ./\ \ .\char'134&multiplication and division\cr | |
| 588 '\ \ .'&transpose\cr | |
| 589 +\ \ -\ \ ++\ \ --\ \ !&unary minus, increment, logical ``not''\cr | |
| 590 \char'136\ \ .\char'136&exponentiation\cr | |
| 591 \endsec | |
| 592 | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
593 \sec General programming; |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
594 \omit \vbox{\rm\vskip0.5ex |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
595 endfor, endwhile, endif etc can all be replaced by end. |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
596 \vskip0.75ex}\span\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
597 for x = 1:10 |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
598 |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
599 endfor & for loop\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
600 |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
601 while (x <= 10) |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
602 |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
603 endwhile & while loop\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
604 |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
605 do |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
606 |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
607 until (x > 10) & do-until loop\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
608 |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
609 if (x < 5) |
| 2333 | 610 |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
611 elseif (x < 6) |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
612 |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
613 else |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
614 |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
615 endif & if-then-else\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
616 |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
617 break & exit innermost loop\cr |
| 7040 | 618 |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
619 continue & go to beginning of innermost loop\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
620 |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
621 return & return to calling function\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
622 |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
623 % |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
624 % FIXME: insert underscore for unwind_protect / unwind_protect_cleanup without TeX choking. |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
625 % |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
626 unwind protect & execute cleanup code always\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
627 |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
628 try catch & execute cleanup code only if exception occurs\cr |
| 7040 | 629 \endsec |
| 630 | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
631 \widesec Functions; |
| 2333 | 632 function \opt{{\it ret-list}} {\it function-name} |
| 633 \opt{\hskip0.2em({\it arg-list})\hskip0.2em}\cr | |
| 634 \quad{\it function-body}\cr | |
| 635 endfunction\cr\cr | |
| 636 {\rm {\it ret-list\/} may be a single identifier or a comma-separated | |
| 637 list of identifiers delimited by square-brackets.\vskip0.75ex}\cr | |
| 638 {\rm {\it arg-list\/} is a comma-separated list of identifiers and may | |
| 639 be empty.}\cr | |
| 640 \endsec | |
| 641 | |
| 7040 | 642 \sec Function Handles; |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
643 @{\it{func}}& define a function handle to {\it func}.\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
644 @({\it var1}, ...) {\it expr}&define an anonymous function\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
645 str2func func2str&convert function to/from string\cr |
| 7040 | 646 functions ({\it handle})&Return information about a function handle.\cr |
| 647 {\it handle} ({\it arg1}, ...)&Evaluate a function handle.\cr | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
648 feval &Evaluate a function handle or string\cr |
| 7040 | 649 \omit\vbox{\rm\vskip0.25ex |
| 650 Anonymous function handles take a copy of the variables in the | |
| 651 current workspace.\vskip0.75ex}\span\cr | |
| 652 \endsec | |
| 653 | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
654 \sec Global and Persistent Variables; |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
655 global {\it var1} = ...&global variables\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
656 persistent {\it var1} = ...&persistent / static variables\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
657 \omit\hfill\vbox{\rm\vskip0.25ex |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
658 Global variables may be accessed inside the body of a function |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
659 without having to be passed in the function parameter list provided |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
660 they are declared global when used.}\span\cr |
| 7040 | 661 \endsec |
| 662 | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
663 \sec Common Functions; |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
664 disp&display value of variable\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
665 printf&formatted output to {\tt stdout}\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
666 input, scanf&input from {\tt stdin}\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
667 who, whos&list current variables\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
668 clear {\it pattern}&clear variables matching pattern\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
669 exist&check existence of variable or function\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
670 find&return indices of nonzero elements\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
671 sort&return a sorted array\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
672 sortrows&sort whole rows in numerical or lexicographic order\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
673 sum, prod&sum, product of elements\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
674 mod, rem&remainder functions\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
675 min, max, range, mean, median, mode, std, var&basic statistics functions\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
676 cov ({\it x}, {\it y})&covariance\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
677 corrcoef ({\it x}, {\it y})&correlation coefficient\cr |
| 2333 | 678 \endsec |
| 679 | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
680 \sec Error Handling; |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
681 eval ({\it str})&evaluate {\it str} as a command\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
682 system ({\it cmd})&execute arbitrary shell command string\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
683 error ({\it message})&print message and return to top level\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
684 warning ({\it message})&print a warning message\cr |
| 2333 | 685 \endsec |
| 686 | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
687 \sec File I/O, Loading, Saving; |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
688 fopen, fclose & open and close file\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
689 fprintf, fscanf, textscan&formatted file I/O\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
690 fgets, fread&read from file\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
691 fputs, fwrite&write to file\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
692 fflush&flush pending output\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
693 feof&true if end of file\cr |
| 7040 | 694 |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
695 save, load &save or load variables to or from file\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
696 save -binary &save variables in binary format (faster)\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
697 dlmread dlmwrite&read and write delimited data\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
698 csvread csvwrite&read and write CSV files\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
699 xlsread xlswrite&read and write XLS spreadsheets\cr |
| 2333 | 700 \endsec |
| 701 | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
702 \sec Linear Algebra; |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
703 det & determinant\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
704 eig &eigenvalues and eigenvectors\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
705 inv &matrix inverse\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
706 norm &vector norm, matrix norm\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
707 rank &matrix rank\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
708 qr &QR factorization\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
709 chol &Cholesky factorization\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
710 svd &singular value decomposition\cr |
| 2333 | 711 \endsec |
| 712 | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
713 \sec Equations, ODEs, DAEs, Quadrature; |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
714 fsolve&solve nonlinear algebraic equations\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
715 lsode&integrate nonlinear ODEs\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
716 dassl&integrate nonlinear DAEs\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
717 quad&integrate nonlinear functions\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
718 \endsec |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
719 |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
720 \sec Sets; |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
721 setdiff&set difference\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
722 intersection&set intersection\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
723 union&set union\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
724 unique&discard duplicate elements\cr |
| 2333 | 725 \endsec |
| 726 | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
727 \sec Signal Processing; |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
728 fft, ifft({\it a})&FFT and inverse FFT\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
729 freqz &FIR filter frequency response\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
730 filter &filter by transfer function\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
731 conv, deconv &convolution, deconvolution\cr |
| 2333 | 732 \endsec |
| 733 | |
| 734 \sec Polynomials; | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
735 conv, deconv & polynomial multiplication and division\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
736 poly &characteristic polynomial of a matrix\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
737 polyder polyint&polynomial derivative or integral\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
738 polyfit polyval& fit polynomial to data and evaluate it\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
739 roots &polynomial roots\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
740 residue &partial fraction expansion\cr |
| 2333 | 741 \endsec |
| 742 | |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
743 \sec Image Processing; |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
744 colormap &set the current colormap\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
745 image, imagesc &display Octave image matrix, scaled\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
746 imread imwrite&load or save an image file\cr |
| 2333 | 747 \endsec |
| 748 | |
| 6548 | 749 \sec Plotting Functions; |
|
31264
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
750 plot plot3 &2D / 3D plot with linear axes\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
751 line &2D or 3D line\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
752 patch fill&2D patch, optionally colored\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
753 semilogx semilogy loglog&2D plot with logarithmic x-axis / y-axis / both axes\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
754 bar &bar charts\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
755 stairs &plot stairsteps\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
756 stem &plot a stem graph\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
757 hist &plot histogram\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
758 contour &contour plot\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
759 title &set plot title\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
760 axis &set axis ranges\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
761 xlabel ylabel zlabel &set axis labels\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
762 text &add text to a plot\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
763 legend &make a legend box\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
764 grid &set grid state\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
765 hold &set hold state\cr |
|
af3752d9a59f
doc: Update refcard.tex content from Octave 3 to Octave 8
Arun Giridhar <arungiridhar@gmail.com>
parents:
30564
diff
changeset
|
766 mesh trimesh surf &plot 3D surfaces\cr |
| 2333 | 767 \endsec |
| 768 | |
| 769 \vskip 0pt plus 2fill | |
| 770 \hrule width \hsize | |
| 771 \par\vskip10pt | |
| 772 {\smrm\parskip=6pt | |
|
30564
796f54d4ddbf
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
29358
diff
changeset
|
773 Edition \refcardedition\ for Octave Version \octaveversion. |
|
796f54d4ddbf
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
29358
diff
changeset
|
774 Copyright 1996-2022 The Octave Project Developers. The authors assume |
|
796f54d4ddbf
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
29358
diff
changeset
|
775 no responsibility for any errors on this card. |
| 2333 | 776 |
| 777 This card may be freely distributed under the terms of the GNU | |
| 778 General Public License. | |
| 779 | |
| 780 \TeX{} Macros for this card by Roland Pesch (pesch@cygnus.com), | |
| 781 originally for the GDB reference card | |
| 782 | |
| 783 Octave itself is free software; you are welcome to distribute copies of | |
| 784 it under the terms of the GNU General Public License. There is | |
| 785 absolutely no warranty for Octave. | |
| 786 } | |
| 787 | |
| 788 \end | |
| 789 | |
| 790 % For AUCTeX: | |
| 791 % | |
|
19593
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
792 % Local Variables: |
| 2333 | 793 % mode: tex |
| 794 % TeX-master: t | |
|
19593
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
795 % End: |