← Back to branch summary

~ubuntu-branches/debian/sid/octave3.0/sid

« back to all changes in this revision

Viewing changes to doc/interpreter/HTML/Rearranging-Matrices.html

  • Committer: Bazaar Package Importer
  • Author(s): Thomas Weber
  • Date: 2008-08-12 22:28:01 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080812222801-b3myaxymt2k5m709
Tags: 1:3.0.1-6lenny1
Allow libhdf5-openmpi-dev to satisfy Octave's hdf5 dependency (closes:
#494139)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/interpreter/HTML/Rearranging-Matrices.html
37
37
<p><a name="doc_002dfliplr"></a>
38
38
 
39
39
<div class="defun">
40
 
&mdash; Function File:  <b>fliplr</b> (<var>x</var>)<var><a name="index-fliplr-921"></a></var><br>
 
40
&mdash; Function File:  <b>fliplr</b> (<var>x</var>)<var><a name="index-fliplr-920"></a></var><br>
41
41
<blockquote><p>Return a copy of <var>x</var> with the order of the columns reversed.  For
42
42
example,
43
43
 
56
56
   <p><a name="doc_002dflipud"></a>
57
57
 
58
58
<div class="defun">
59
 
&mdash; Function File:  <b>flipud</b> (<var>x</var>)<var><a name="index-flipud-922"></a></var><br>
 
59
&mdash; Function File:  <b>flipud</b> (<var>x</var>)<var><a name="index-flipud-921"></a></var><br>
60
60
<blockquote><p>Return a copy of <var>x</var> with the order of the rows reversed.  For
61
61
example,
62
62
 
76
76
   <p><a name="doc_002dflipdim"></a>
77
77
 
78
78
<div class="defun">
79
 
&mdash; Function File:  <b>flipdim</b> (<var>x, dim</var>)<var><a name="index-flipdim-923"></a></var><br>
 
79
&mdash; Function File:  <b>flipdim</b> (<var>x, dim</var>)<var><a name="index-flipdim-922"></a></var><br>
80
80
<blockquote><p>Return a copy of <var>x</var> flipped about the dimension <var>dim</var>. 
81
81
For example
82
82
 
93
93
   <p><a name="doc_002drot90"></a>
94
94
 
95
95
<div class="defun">
96
 
&mdash; Function File:  <b>rot90</b> (<var>x, n</var>)<var><a name="index-rot90-924"></a></var><br>
 
96
&mdash; Function File:  <b>rot90</b> (<var>x, n</var>)<var><a name="index-rot90-923"></a></var><br>
97
97
<blockquote><p>Return a copy of <var>x</var> with the elements rotated counterclockwise in
98
98
90-degree increments.  The second argument is optional, and specifies
99
99
how many 90-degree rotations are to be applied (the default value is 1). 
123
123
   <p><a name="doc_002drotdim"></a>
124
124
 
125
125
<div class="defun">
126
 
&mdash; Function File:  <b>rotdim</b> (<var>x, n, plane</var>)<var><a name="index-rotdim-925"></a></var><br>
 
126
&mdash; Function File:  <b>rotdim</b> (<var>x, n, plane</var>)<var><a name="index-rotdim-924"></a></var><br>
127
127
<blockquote><p>Return a copy of <var>x</var> with the elements rotated counterclockwise in
128
128
90-degree increments.  The second argument is optional, and specifies
129
129
how many 90-degree rotations are to be applied (the default value is 1). 
155
155
   <p><a name="doc_002dcat"></a>
156
156
 
157
157
<div class="defun">
158
 
&mdash; Built-in Function:  <b>cat</b> (<var>dim, array1, array2, <small class="dots">...</small>, arrayN</var>)<var><a name="index-cat-926"></a></var><br>
 
158
&mdash; Built-in Function:  <b>cat</b> (<var>dim, array1, array2, <small class="dots">...</small>, arrayN</var>)<var><a name="index-cat-925"></a></var><br>
159
159
<blockquote><p>Return the concatenation of N-d array objects, <var>array1</var>,
160
160
<var>array2</var>, <small class="dots">...</small>, <var>arrayN</var> along dimension <var>dim</var>.
161
161
 
196
196
   <p><a name="doc_002dhorzcat"></a>
197
197
 
198
198
<div class="defun">
199
 
&mdash; Built-in Function:  <b>horzcat</b> (<var>array1, array2, <small class="dots">...</small>, arrayN</var>)<var><a name="index-horzcat-927"></a></var><br>
 
199
&mdash; Built-in Function:  <b>horzcat</b> (<var>array1, array2, <small class="dots">...</small>, arrayN</var>)<var><a name="index-horzcat-926"></a></var><br>
200
200
<blockquote><p>Return the horizontal concatenation of N-d array objects, <var>array1</var>,
201
201
<var>array2</var>, <small class="dots">...</small>, <var>arrayN</var> along dimension 2.
202
202
        <pre class="sp">
208
208
   <p><a name="doc_002dvertcat"></a>
209
209
 
210
210
<div class="defun">
211
 
&mdash; Built-in Function:  <b>vertcat</b> (<var>array1, array2, <small class="dots">...</small>, arrayN</var>)<var><a name="index-vertcat-928"></a></var><br>
 
211
&mdash; Built-in Function:  <b>vertcat</b> (<var>array1, array2, <small class="dots">...</small>, arrayN</var>)<var><a name="index-vertcat-927"></a></var><br>
212
212
<blockquote><p>Return the vertical concatenation of N-d array objects, <var>array1</var>,
213
213
<var>array2</var>, <small class="dots">...</small>, <var>arrayN</var> along dimension 1.
214
214
        <pre class="sp">
220
220
   <p><a name="doc_002dpermute"></a>
221
221
 
222
222
<div class="defun">
223
 
&mdash; Built-in Function:  <b>permute</b> (<var>a, perm</var>)<var><a name="index-permute-929"></a></var><br>
 
223
&mdash; Built-in Function:  <b>permute</b> (<var>a, perm</var>)<var><a name="index-permute-928"></a></var><br>
224
224
<blockquote><p>Return the generalized transpose for an N-d array object <var>a</var>. 
225
225
The permutation vector <var>perm</var> must contain the elements
226
226
<code>1:ndims(a)</code> (in any order, but each element must appear just once).
233
233
   <p><a name="doc_002dipermute"></a>
234
234
 
235
235
<div class="defun">
236
 
&mdash; Built-in Function:  <b>ipermute</b> (<var>a, iperm</var>)<var><a name="index-ipermute-930"></a></var><br>
 
236
&mdash; Built-in Function:  <b>ipermute</b> (<var>a, iperm</var>)<var><a name="index-ipermute-929"></a></var><br>
237
237
<blockquote><p>The inverse of the <code>permute</code> function.  The expression
238
238
 
239
239
     <pre class="example">          ipermute (permute (a, perm), perm)
248
248
   <p><a name="doc_002dreshape"></a>
249
249
 
250
250
<div class="defun">
251
 
&mdash; Built-in Function:  <b>reshape</b> (<var>a, m, n, <small class="dots">...</small></var>)<var><a name="index-reshape-931"></a></var><br>
252
 
&mdash; Built-in Function:  <b>reshape</b> (<var>a, siz</var>)<var><a name="index-reshape-932"></a></var><br>
 
251
&mdash; Built-in Function:  <b>reshape</b> (<var>a, m, n, <small class="dots">...</small></var>)<var><a name="index-reshape-930"></a></var><br>
 
252
&mdash; Built-in Function:  <b>reshape</b> (<var>a, siz</var>)<var><a name="index-reshape-931"></a></var><br>
253
253
<blockquote><p>Return a matrix with the given dimensions whose elements are taken
254
254
from the matrix <var>a</var>.  The elements of the matrix are accessed in
255
255
column-major order (like Fortran arrays are stored).
270
270
   <p><a name="doc_002dcircshift"></a>
271
271
 
272
272
<div class="defun">
273
 
&mdash; Function File: <var>y</var> = <b>circshift</b> (<var>x, n</var>)<var><a name="index-circshift-933"></a></var><br>
 
273
&mdash; Function File: <var>y</var> = <b>circshift</b> (<var>x, n</var>)<var><a name="index-circshift-932"></a></var><br>
274
274
<blockquote><p>Circularly shifts the values of the array <var>x</var>. <var>n</var> must be
275
275
a vector of integers no longer than the number of dimensions in
276
276
<var>x</var>. The values of <var>n</var> can be either positive or negative,
301
301
   <p><a name="doc_002dshiftdim"></a>
302
302
 
303
303
<div class="defun">
304
 
&mdash; Function File: <var>y</var> = <b>shiftdim</b> (<var>x, n</var>)<var><a name="index-shiftdim-934"></a></var><br>
305
 
&mdash; Function File: [<var>y</var>, <var>ns</var>] = <b>shiftdim</b> (<var>x</var>)<var><a name="index-shiftdim-935"></a></var><br>
 
304
&mdash; Function File: <var>y</var> = <b>shiftdim</b> (<var>x, n</var>)<var><a name="index-shiftdim-933"></a></var><br>
 
305
&mdash; Function File: [<var>y</var>, <var>ns</var>] = <b>shiftdim</b> (<var>x</var>)<var><a name="index-shiftdim-934"></a></var><br>
306
306
<blockquote><p>Shifts the dimension of <var>x</var> by <var>n</var>, where <var>n</var> must be
307
307
an integer scalar. When <var>n</var> is positive, the dimensions of
308
308
<var>x</var> are shifted to the left, with the leading dimensions
334
334
   <p><a name="doc_002dshift"></a>
335
335
 
336
336
<div class="defun">
337
 
&mdash; Function File:  <b>shift</b> (<var>x, b</var>)<var><a name="index-shift-936"></a></var><br>
338
 
&mdash; Function File:  <b>shift</b> (<var>x, b, dim</var>)<var><a name="index-shift-937"></a></var><br>
 
337
&mdash; Function File:  <b>shift</b> (<var>x, b</var>)<var><a name="index-shift-935"></a></var><br>
 
338
&mdash; Function File:  <b>shift</b> (<var>x, b, dim</var>)<var><a name="index-shift-936"></a></var><br>
339
339
<blockquote><p>If <var>x</var> is a vector, perform a circular shift of length <var>b</var> of
340
340
the elements of <var>x</var>.
341
341
 
347
347
   <p><a name="doc_002dsort"></a>
348
348
 
349
349
<div class="defun">
350
 
&mdash; Loadable Function: [<var>s</var>, <var>i</var>] = <b>sort</b> (<var>x</var>)<var><a name="index-sort-938"></a></var><br>
351
 
&mdash; Loadable Function: [<var>s</var>, <var>i</var>] = <b>sort</b> (<var>x, dim</var>)<var><a name="index-sort-939"></a></var><br>
352
 
&mdash; Loadable Function: [<var>s</var>, <var>i</var>] = <b>sort</b> (<var>x, mode</var>)<var><a name="index-sort-940"></a></var><br>
353
 
&mdash; Loadable Function: [<var>s</var>, <var>i</var>] = <b>sort</b> (<var>x, dim, mode</var>)<var><a name="index-sort-941"></a></var><br>
 
350
&mdash; Loadable Function: [<var>s</var>, <var>i</var>] = <b>sort</b> (<var>x</var>)<var><a name="index-sort-937"></a></var><br>
 
351
&mdash; Loadable Function: [<var>s</var>, <var>i</var>] = <b>sort</b> (<var>x, dim</var>)<var><a name="index-sort-938"></a></var><br>
 
352
&mdash; Loadable Function: [<var>s</var>, <var>i</var>] = <b>sort</b> (<var>x, mode</var>)<var><a name="index-sort-939"></a></var><br>
 
353
&mdash; Loadable Function: [<var>s</var>, <var>i</var>] = <b>sort</b> (<var>x, dim, mode</var>)<var><a name="index-sort-940"></a></var><br>
354
354
<blockquote><p>Return a copy of <var>x</var> with the elements arranged in increasing
355
355
order.  For matrices, <code>sort</code> orders the elements in each column.
356
356
 
391
391
   <p><a name="doc_002dsortrows"></a>
392
392
 
393
393
<div class="defun">
394
 
&mdash; Function File:  <b>sortrows</b> (<var>a, c</var>)<var><a name="index-sortrows-942"></a></var><br>
 
394
&mdash; Function File:  <b>sortrows</b> (<var>a, c</var>)<var><a name="index-sortrows-941"></a></var><br>
395
395
<blockquote><p>Sort the rows of the matrix <var>a</var> according to the order of the
396
396
columns specified in <var>c</var>.  If <var>c</var> is omitted, a
397
 
lexicographical sort is used. 
 
397
lexicographical sort is used. By default ascending order is used
 
398
however if elements of <var>c</var> are negative then the corrosponding
 
399
column is sorted in descending order. 
398
400
</p></blockquote></div>
399
401
 
400
402
   <p>Since the <code>sort</code> function does not allow sort keys to be specified,
415
417
   <p><a name="doc_002dswap"></a>
416
418
 
417
419
<div class="defun">
418
 
&mdash; Function File:  <b>swap</b> (<var>inputs</var>)<var><a name="index-swap-943"></a></var><br>
 
420
&mdash; Function File:  <b>swap</b> (<var>inputs</var>)<var><a name="index-swap-942"></a></var><br>
419
421
<blockquote><pre class="format">[a1,b1] = swap(a,b)
420
422
     interchange a and b
421
423
</pre>
424
426
   <p><a name="doc_002dswapcols"></a>
425
427
 
426
428
<div class="defun">
427
 
&mdash; Function File:  <b>swapcols</b> (<var>inputs</var>)<var><a name="index-swapcols-944"></a></var><br>
 
429
&mdash; Function File:  <b>swapcols</b> (<var>inputs</var>)<var><a name="index-swapcols-943"></a></var><br>
428
430
<blockquote><pre class="format"> function B = swapcols(A)
429
431
      permute columns of A into reverse order
430
432
</pre>
433
435
   <p><a name="doc_002dswaprows"></a>
434
436
 
435
437
<div class="defun">
436
 
&mdash; Function File:  <b>swaprows</b> (<var>inputs</var>)<var><a name="index-swaprows-945"></a></var><br>
 
438
&mdash; Function File:  <b>swaprows</b> (<var>inputs</var>)<var><a name="index-swaprows-944"></a></var><br>
437
439
<blockquote><pre class="format"> function B = swaprows(A)
438
440
      permute rows of A into reverse order
439
441
</pre>
442
444
   <p><a name="doc_002dtril"></a>
443
445
 
444
446
<div class="defun">
445
 
&mdash; Function File:  <b>tril</b> (<var>a, k</var>)<var><a name="index-tril-946"></a></var><br>
446
 
&mdash; Function File:  <b>triu</b> (<var>a, k</var>)<var><a name="index-triu-947"></a></var><br>
 
447
&mdash; Function File:  <b>tril</b> (<var>a, k</var>)<var><a name="index-tril-945"></a></var><br>
 
448
&mdash; Function File:  <b>triu</b> (<var>a, k</var>)<var><a name="index-triu-946"></a></var><br>
447
449
<blockquote><p>Return a new matrix formed by extracting the lower (<code>tril</code>)
448
450
or upper (<code>triu</code>) triangular part of the matrix <var>a</var>, and
449
451
setting all other elements to zero.  The second argument is optional,
484
486
   <p><a name="doc_002dvec"></a>
485
487
 
486
488
<div class="defun">
487
 
&mdash; Function File:  <b>vec</b> (<var>x</var>)<var><a name="index-vec-948"></a></var><br>
 
489
&mdash; Function File:  <b>vec</b> (<var>x</var>)<var><a name="index-vec-947"></a></var><br>
488
490
<blockquote><p>Return the vector obtained by stacking the columns of the matrix <var>x</var>
489
491
one above the other. 
490
492
</p></blockquote></div>
492
494
   <p><a name="doc_002dvech"></a>
493
495
 
494
496
<div class="defun">
495
 
&mdash; Function File:  <b>vech</b> (<var>x</var>)<var><a name="index-vech-949"></a></var><br>
 
497
&mdash; Function File:  <b>vech</b> (<var>x</var>)<var><a name="index-vech-948"></a></var><br>
496
498
<blockquote><p>Return the vector obtained by eliminating all supradiagonal elements of
497
499
the square matrix <var>x</var> and stacking the result one column above the
498
500
other. 
501
503
   <p><a name="doc_002dprepad"></a>
502
504
 
503
505
<div class="defun">
504
 
&mdash; Function File:  <b>prepad</b> (<var>x, l, c</var>)<var><a name="index-prepad-950"></a></var><br>
505
 
&mdash; Function File:  <b>postpad</b> (<var>x, l, c</var>)<var><a name="index-postpad-951"></a></var><br>
506
 
&mdash; Function File:  <b>postpad</b> (<var>x, l, c, dim</var>)<var><a name="index-postpad-952"></a></var><br>
 
506
&mdash; Function File:  <b>prepad</b> (<var>x, l, c</var>)<var><a name="index-prepad-949"></a></var><br>
 
507
&mdash; Function File:  <b>postpad</b> (<var>x, l, c</var>)<var><a name="index-postpad-950"></a></var><br>
 
508
&mdash; Function File:  <b>postpad</b> (<var>x, l, c, dim</var>)<var><a name="index-postpad-951"></a></var><br>
507
509
<blockquote>
508
510
        <p>Prepends (appends) the scalar value <var>c</var> to the vector <var>x</var>
509
511
until it is of length <var>l</var>.  If the third argument is not
521
523
   <p><a name="doc_002dblkdiag"></a>
522
524
 
523
525
<div class="defun">
524
 
&mdash; Function File:  <b>blkdiag</b> (<var>a, b, c, <small class="dots">...</small></var>)<var><a name="index-blkdiag-953"></a></var><br>
 
526
&mdash; Function File:  <b>blkdiag</b> (<var>a, b, c, <small class="dots">...</small></var>)<var><a name="index-blkdiag-952"></a></var><br>
525
527
<blockquote><p>Build a block diagonal matrix from <var>a</var>, <var>b</var>, <var>c</var>, <small class="dots">...</small>. 
526
528
All the arguments must be numeric and are two-dimensional matrices or
527
529
scalars.