1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
---
title: matrix
description: store/create/manipulate a 2d matrix
categories:
- object
pdcategory: General
aliases:
- mtx
see_also:
- mtx_ones
- mtx_zeros
- mtx_diag
- mtx_diegg
- mtx_eye
- mtx_egg
- mtx_col
- mtx_element
- mtx_row
inlets:
1st:
- type: matrix
description: store and output the matrix
- type: bang
description: output the stored matrix
2nd:
- type: matrix
description: store the matrix
outlets:
1st:
- type: matrix
description: the stored matrix
# FIXXME: arguments <symbol> is not a second argument but an alternative
# we need a better way to express this
arguments:
- type: <float> <float>
description: number of rows & number of columns
- type: <symbol>
description: file name to read matrix from
---
## matrix store
{{< pdobj mtx >}} stores a single matrix, just like {{< pdobj float >}} stores a single number.
You can also save the stored matrix to a file via the message {{< pdmsg write "<fname>" >}}
to the matrix, or load a matrix via {{< pdmsg read "<fname>" >}} from a file.
## matrix creation
It can also be used to create special matrices using the following messages:
| message | result | related object |
|---------|--------------------------|--------------------------|
| `zeros` | all zeros | {{< pdobj mtx_zeros >}} |
| `ones` | all ones | {{< pdobj mtx_ones >}} |
| `eye` | identity matrix | {{< pdobj mtx_eye >}} |
| `egg` | backward identity matrix | {{< pdobj mtx_egg >}} |
| `diag` | diagonal matrix | {{< pdobj mtx_diag >}} |
| `diegg` | backward diagonal matrix | {{< pdobj mtx_diegg >}} |
| `size` | silently resize matrix | {{< pdobj mtx_resize >}} |
## matrix manipulation
Finally you can query and change the contents of a matrix:
| message | result | related object |
|-----------|-------------------------|---------------------------|
| `row` | get/set *n*th row | {{< pdobj mtx_row >}} |
| `col` | get/set *m*th column | {{< pdobj mtx_col >}} |
| `element` | get/set element *(n,m)* | {{< pdobj mtx_element >}} |
# the {{<pdmsg matrix >}} message
The {{< pdobj matrix >}} object understands (and emits) {{<pdmsg matrix >}} messages.
This message describes a 2d matrix and has the form
> {{<pdmsg matrix "<int:rows>" "<int:columns>" "<list[float]:entries>" "..." >}}
The *entries* are a list of \\(rows * columns\\) float atoms in row-major order.
E.g.
$$
\texttt{[matrix\quad 3 2\quad 10 20 \thinspace 30 40 \thinspace 50 60(}
\to
\begin{pmatrix}
10 & 20 \cr
30 & 40 \cr
50 & 60
\end{pmatrix}
$$
|
