Skip to content

Commit 536ceac

Browse files
committed
Update queue docs (addressing monome#296)
1 parent 772b900 commit 536ceac

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

docs/ops/queue.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
## Queue
2-
These operators manage a first in, first out, queue of values. The queue can
3-
hold up to 16 values. The length of the queue can be dynamically changed and
4-
the contents will be preserved. There is also an averaging operator which is
5-
useful for smoothing input values.
62

7-
The queue has a maximum size of 64 elements, with a dynamic length marker,
8-
set by `Q.N`.
3+
These operators manage a first in, first out, queue of values. The length of
4+
the queue can be dynamically changed up to a maximum size of 64 elements.
5+
A fixed length can be set with the `Q.N` operator, or the queue can grow and
6+
shrink automatically by setting `Q.GRW 1`. The queue contents will be preserved
7+
when the length is shortened the length.
8+
9+
Queues also offer operators that do math on the entire queue (the `Q.AVG` operator
10+
is particularly useful for smoothing input values) or copy the queue to and from
11+
a tracker pattern.
912

1013
Most operators manipulates the elements up to (and including) length. Exceptions are `Q.I i x` and `Q.P2`.
1114

1215
Examples, only first 8 elements shown for clarity:
1316
By default all elements of the queue have a value of `0` and the length is set to 1.
1417
```
15-
Q.N "length" ->|
18+
Q.N "length" ->|
1619
element nb: 1 | 2 3 4 5 6 7 8
1720
value 0 | 0 0 0 0 0 0 0
1821
```

0 commit comments

Comments
 (0)