added help files for several mtx externals

svn path=/trunk/externals/iem/iemmatrix/; revision=5384

6 files changed, 317 insertions, 0 deletions

diff --git a/doc/mtx_cumsum-help.pd b/doc/mtx_cumsum-help.pd
new file mode 100644
index 0000000..d4288e2
--- /dev/null
+++ b/doc/mtx_cumsum-help.pd
@@ -0,0 +1,56 @@
+#N canvas 27 49 670 511 10;
+#X text 458 17 updated for;
+#X obj 546 17 iemmatrix 0.2;
+#X obj 595 43 matrix;
+#X text 465 42 see also help for;
+#X obj 12 189 t a a;
+#X msg 12 124 bang;
+#X msg 265 390 mode row;
+#X msg 265 364 mode column;
+#X msg 352 363 mode col;
+#X msg 418 363 mode :;
+#X obj 263 416 t a;
+#X obj 12 166 mtx_ones 3 4;
+#X obj 17 379 t a a;
+#X msg 17 335 bang;
+#X obj 17 360 mtx_ones 2 2;
+#X text 90 15 [mtx_cumsum];
+#X text 47 34 cumulative sum in row/col direction;
+#X obj 20 211 mtx_print original;
+#X obj 12 257 mtx_cumsum row;
+#X obj 12 285 mtx_print cumsum-row;
+#X obj 46 400 mtx_print original;
+#X obj 17 472 mtx_print cumsum;
+#X obj 117 257 mtx_cumsum col;
+#X obj 159 285 mtx_print cumsum-col;
+#X obj 410 466 mtx_diff;
+#X text 410 444 see also:;
+#X msg 298 336 direction -1;
+#X obj 17 443 mtx_cumsum row;
+#X obj 12 235 t a a a;
+#X obj 248 258 mtx_cumsum row -1;
+#X obj 310 285 mtx_print cumsum-col-reverse;
+#X text 18 63 you can calculate numerical integrals or ascending sequences
+of numbers with cumsum \; you can also do this into the reverse direction
+;
+#X connect 4 0 28 0;
+#X connect 4 1 17 0;
+#X connect 5 0 11 0;
+#X connect 6 0 10 0;
+#X connect 7 0 10 0;
+#X connect 8 0 10 0;
+#X connect 9 0 10 0;
+#X connect 10 0 27 0;
+#X connect 11 0 4 0;
+#X connect 12 0 27 0;
+#X connect 12 1 20 0;
+#X connect 13 0 14 0;
+#X connect 14 0 12 0;
+#X connect 18 0 19 0;
+#X connect 22 0 23 0;
+#X connect 26 0 10 0;
+#X connect 27 0 21 0;
+#X connect 28 0 18 0;
+#X connect 28 1 22 0;
+#X connect 28 2 29 0;
+#X connect 29 0 30 0;
diff --git a/doc/mtx_diff-help.pd b/doc/mtx_diff-help.pd
new file mode 100644
index 0000000..88103fe
--- /dev/null
+++ b/doc/mtx_diff-help.pd
@@ -0,0 +1,56 @@
+#N canvas 628 70 670 511 10;
+#X text 458 17 updated for;
+#X obj 546 17 iemmatrix 0.2;
+#X obj 595 43 matrix;
+#X text 465 42 see also help for;
+#X obj 12 189 t a a;
+#X msg 12 124 bang;
+#X msg 265 390 mode row;
+#X msg 265 364 mode column;
+#X msg 352 363 mode col;
+#X msg 418 363 mode :;
+#X obj 263 416 t a;
+#X obj 12 166 mtx_ones 3 4;
+#X obj 17 379 t a a;
+#X msg 17 335 bang;
+#X obj 17 360 mtx_ones 2 2;
+#X obj 20 211 mtx_print original;
+#X obj 12 285 mtx_print cumsum-row;
+#X obj 46 400 mtx_print original;
+#X obj 17 472 mtx_print cumsum;
+#X obj 159 285 mtx_print cumsum-col;
+#X text 410 444 see also:;
+#X text 90 15 [mtx_diff];
+#X obj 117 257 mtx_diff col;
+#X obj 17 443 mtx_diff;
+#X obj 410 466 mtx_cumsum;
+#X obj 12 257 mtx_diff row;
+#X text 47 34 first forward/backward difference;
+#X text 18 63 you can calculate the differences between matrix elements
+forwards/backwards \; this is useful for the numerical derivative of
+vectors/matrices.;
+#X obj 12 235 t a a a;
+#X obj 307 284 mtx_print cumsum-row-reverse;
+#X obj 265 256 mtx_diff col -1;
+#X msg 425 385 direction -1;
+#X connect 4 0 28 0;
+#X connect 4 1 15 0;
+#X connect 5 0 11 0;
+#X connect 6 0 10 0;
+#X connect 7 0 10 0;
+#X connect 8 0 10 0;
+#X connect 9 0 10 0;
+#X connect 10 0 23 0;
+#X connect 11 0 4 0;
+#X connect 12 0 23 0;
+#X connect 12 1 17 0;
+#X connect 13 0 14 0;
+#X connect 14 0 12 0;
+#X connect 22 0 19 0;
+#X connect 23 0 18 0;
+#X connect 25 0 16 0;
+#X connect 28 0 25 0;
+#X connect 28 1 22 0;
+#X connect 28 2 30 0;
+#X connect 30 0 29 0;
+#X connect 31 0 10 0;
diff --git a/doc/mtx_fill-help.pd b/doc/mtx_fill-help.pd
new file mode 100644
index 0000000..1f94506
--- /dev/null
+++ b/doc/mtx_fill-help.pd
@@ -0,0 +1,74 @@
+#N canvas 333 84 670 511 10;
+#X text 458 17 updated for;
+#X obj 546 17 iemmatrix 0.2;
+#X obj 595 43 matrix;
+#X text 465 42 see also help for;
+#X obj 62 208 mtx_fill;
+#X text 87 15 [mtx_fill];
+#X text 47 34 filling elements of a data matrix into specific positions
+of an other matrix;
+#X obj 136 117 mtx_zeros;
+#X obj 62 231 mtx_print;
+#X floatatom 232 110 5 0 0 0 - - -;
+#X obj 136 75 loadbang;
+#X msg 136 95 10 10;
+#X text 238 198 <-- if empty matrix: filling sub-matrix at start position
+;
+#X floatatom 281 110 5 0 0 0 - - -;
+#X text 234 92 row;
+#X text 289 93 col;
+#X msg 145 197 matrix \$1 \$2;
+#X obj 247 127 t b f;
+#X obj 245 147 pack 1 1;
+#X obj 245 167 t b l;
+#X msg 61 127 3 3;
+#X obj 62 148 mtx_rand;
+#X obj 62 166 mtx_* 10;
+#X obj 62 183 mtx_int;
+#X obj 84 438 mtx_fill;
+#X obj 149 333 mtx_zeros;
+#X obj 84 461 mtx_print;
+#X obj 149 291 loadbang;
+#X msg 149 311 10 10;
+#X text 25 76 1 submatrix;
+#X text 19 275 2 any positions;
+#X obj 246 333 mtx_rand;
+#X obj 246 374 mtx_find;
+#X obj 71 401 mtx_ones;
+#X msg 246 310 10 10;
+#X obj 70 340 mtx_size;
+#X obj 71 360 *;
+#X obj 246 395 t a a;
+#X msg 71 379 1 \$1;
+#X obj 246 354 mtx_> 0.8;
+#X connect 4 0 8 0;
+#X connect 7 0 4 1;
+#X connect 9 0 18 0;
+#X connect 10 0 11 0;
+#X connect 11 0 7 0;
+#X connect 13 0 17 0;
+#X connect 16 0 4 2;
+#X connect 17 0 18 0;
+#X connect 17 1 18 1;
+#X connect 18 0 19 0;
+#X connect 19 0 20 0;
+#X connect 19 1 16 0;
+#X connect 20 0 21 0;
+#X connect 21 0 22 0;
+#X connect 22 0 23 0;
+#X connect 23 0 4 0;
+#X connect 24 0 26 0;
+#X connect 25 0 24 1;
+#X connect 27 0 28 0;
+#X connect 28 0 25 0;
+#X connect 31 0 39 0;
+#X connect 32 0 37 0;
+#X connect 33 0 24 0;
+#X connect 34 0 31 0;
+#X connect 35 0 36 0;
+#X connect 35 1 36 1;
+#X connect 36 0 38 0;
+#X connect 37 0 35 0;
+#X connect 37 1 24 2;
+#X connect 38 0 33 0;
+#X connect 39 0 32 0;
diff --git a/doc/mtx_find-help.pd b/doc/mtx_find-help.pd
new file mode 100644
index 0000000..4cd835f
--- /dev/null
+++ b/doc/mtx_find-help.pd
@@ -0,0 +1,54 @@
+#N canvas 237 76 670 511 10;
+#X text 458 17 updated for;
+#X obj 546 17 iemmatrix 0.2;
+#X obj 595 43 matrix;
+#X text 465 42 see also help for;
+#X obj 41 208 t a a;
+#X text 504 412 see also:;
+#X text 89 15 [mtx_find];
+#X text 47 34 finding indices to nonzero matrix elements;
+#X obj 504 431 mtx_index;
+#X msg 41 181 matrix 1 5 0 1 0 1 0 0;
+#X obj 83 209 mtx_print original;
+#X obj 41 232 mtx_find;
+#X obj 41 258 mtx_print nonzero;
+#X text 33 60 you can use this e.g. in combination with logical conditions
+\; the result is a matrix \, if non-existent an empty matrix.;
+#X text 36 112 the matrix result is important when trying to find the
+first/last nonzero element in column or row direction \, it enables
+flexible use with [mtx_index].;
+#X msg 205 182 matrix 1 3 0 0 0;
+#X msg 281 206 2 3;
+#X obj 220 207 mtx_ones;
+#X obj 120 345 mtx_find col -1;
+#X obj 233 345 mtx_find col;
+#X obj 324 345 mtx_find row -1;
+#X obj 439 345 mtx_find row;
+#X obj 204 276 mtx_rand;
+#X msg 204 256 3 4;
+#X obj 204 315 t a a a a a;
+#X obj 288 314 mtx_print orig;
+#X obj 120 430 mtx_print last-in-col;
+#X obj 233 411 mtx_print first-in-col;
+#X obj 439 370 mtx_print first-in-col;
+#X obj 324 391 mtx_print last-in-row;
+#X obj 205 295 mtx_> 0.5;
+#X connect 4 0 11 0;
+#X connect 4 1 10 0;
+#X connect 9 0 4 0;
+#X connect 11 0 12 0;
+#X connect 15 0 4 0;
+#X connect 16 0 17 0;
+#X connect 17 0 4 0;
+#X connect 18 0 26 0;
+#X connect 19 0 27 0;
+#X connect 20 0 29 0;
+#X connect 21 0 28 0;
+#X connect 22 0 30 0;
+#X connect 23 0 22 0;
+#X connect 24 0 18 0;
+#X connect 24 1 19 0;
+#X connect 24 2 20 0;
+#X connect 24 3 21 0;
+#X connect 24 4 25 0;
+#X connect 30 0 24 0;
diff --git a/doc/mtx_index-help.pd b/doc/mtx_index-help.pd
new file mode 100644
index 0000000..7edb846
--- /dev/null
+++ b/doc/mtx_index-help.pd
@@ -0,0 +1,48 @@
+#N canvas 0 0 646 521 10;
+#X text 458 17 updated for;
+#X obj 546 17 iemmatrix 0.2;
+#X obj 595 43 matrix;
+#X text 465 42 see also help for;
+#X text 47 34 finding nonzero etry indices of a matrix;
+#X obj 81 170 t a a;
+#X text 441 320 see also:;
+#X text 89 15 [mtx_index];
+#X msg 81 135 matrix 1 5 -1 -2 -3 -4 -5;
+#X obj 275 168 t a a;
+#X obj 305 191 mtx_print right-indices;
+#X obj 111 193 mtx_print left-values;
+#X obj 81 237 mtx_print addressed-values;
+#X obj 81 214 mtx_index nan;
+#X text 185 215 <- invalid indices;
+#X msg 275 148 matrix 2 2 0 5 2 4;
+#X text 8 60 you can simultaneously address matrix elements you know
+the indices of \; the outlet matrix carries the shape of the indexing
+matrix \; 0 is not allowed as index \, so you can give an alternative
+value as creation argument (here nan).;
+#X obj 441 337 mtx_find;
+#X text 44 282 the indexing matrix can e.g. be the outlet of mtx_find
+based on logical conditions:;
+#X obj 89 325 mtx_rand;
+#X obj 89 347 t a a;
+#X obj 119 369 mtx_> 0.5;
+#X msg 51 323 2 3;
+#X obj 134 347 mtx_print random values;
+#X obj 119 391 mtx_find col;
+#X obj 89 413 mtx_index nan;
+#X obj 89 442 mtx_print result;
+#X text 200 411 finding the first nonzero entry in column;
+#X connect 5 0 13 0;
+#X connect 5 1 11 0;
+#X connect 8 0 5 0;
+#X connect 9 0 13 1;
+#X connect 9 1 10 0;
+#X connect 13 0 12 0;
+#X connect 15 0 9 0;
+#X connect 19 0 20 0;
+#X connect 20 0 25 0;
+#X connect 20 1 21 0;
+#X connect 20 1 23 0;
+#X connect 21 0 24 0;
+#X connect 22 0 19 0;
+#X connect 24 0 25 1;
+#X connect 25 0 26 0;
diff --git a/doc/mtx_slice-help.pd b/doc/mtx_slice-help.pd
new file mode 100644
index 0000000..b46a9a2
--- /dev/null
+++ b/doc/mtx_slice-help.pd
@@ -0,0 +1,29 @@
+#N canvas 333 84 670 511 10;
+#X text 458 17 updated for;
+#X obj 546 17 iemmatrix 0.2;
+#X obj 595 43 matrix;
+#X text 465 42 see also help for;
+#X text 89 15 [mtx_slice];
+#X text 47 34 slicing parts out of a matrix;
+#X text 33 60 you can use this to partition matrices;
+#X obj 156 264 mtx_slice;
+#X obj 156 127 mtx_ones;
+#X obj 156 147 mtx_cumsum :;
+#X obj 156 167 t a a;
+#X msg 156 107 3 4;
+#X obj 204 192 mtx_print left;
+#X obj 156 290 mtx_print slice;
+#X text 338 241 [list idx1_row idx1_col idx2_row idx2_col(;
+#X msg 214 241 list 2 2 end end;
+#X msg 193 222 list 2 2 3 4;
+#X text 313 263 the keyword 'end' is allowed;
+#X text 347 355 see also:;
+#X obj 347 374 mtx_fill;
+#X connect 7 0 13 0;
+#X connect 8 0 9 0;
+#X connect 9 0 10 0;
+#X connect 10 0 7 0;
+#X connect 10 1 12 0;
+#X connect 11 0 8 0;
+#X connect 15 0 7 1;
+#X connect 16 0 7 1;