git @ Cat's Eye Technologies pibfi / master doc / pibfi_tape_tuple.html
master

Tree @master (Download .tar.gz)

pibfi_tape_tuple.html @master — raw · history · blame 

 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Module pibfi_tape_tuple</title>

</head>
<body bgcolor="white">
<h1>Module pibfi_tape_tuple</h1>
<ul><li>
<a href="#index">Function index</a></li><li>
<a href="#exported">Exported functions</a></li></ul>

<h2>Description</h2>
Tuple backend for tape ADT for <code>pibfi</code>.
 

<h2><a name="index">Function Index</a></h2>

<table width="100%" border="1"><tr><th colspan="2" align="left">Exported Functions</th></tr>
<tr><td><a href="#decrement-2">decrement/2</a></td><td>Decrements the value at the current position on the tape N times.</td></tr>
<tr><td><a href="#head-1">head/1</a></td><td/></tr>
<tr><td><a href="#increment-2">increment/2</a></td><td>Increments the value at the current position on the tape N times.</td></tr>
<tr><td><a href="#left-2">left/2</a></td><td>Moves the read/write head N positions left on the tape.</td></tr>
<tr><td><a href="#new-1">new/1</a></td><td>Creates and returns a new tuple-backed tape.</td></tr>
<tr><td><a href="#peek-2">peek/2</a></td><td/></tr>
<tr><td><a href="#poke-3">poke/3</a></td><td/></tr>
<tr><td><a href="#read-1">read/1</a></td><td>Returns the value at the current position on the tape.</td></tr>
<tr><td><a href="#right-2">right/2</a></td><td>Moves the read/write head N positions right on the tape.</td></tr>
<tr><td><a href="#write-2">write/2</a></td><td>Places the given value at the current position on the tape.</td></tr>
</table>

<h2><a name="exported">Exported Functions</a></h2>

<h3><a name="decrement-2">decrement/2</a></h3>

<p><code>decrement(<a href="#type-tape">tape()</a>, N::integer()) -> <a href="#type-tape">tape()</a></code></p>
<p>Decrements the value at the current position on the tape N times.</p>

<h3><a name="head-1">head/1</a></h3>

<p><code>head(Arg1) -> term()</code></p>
<p> </p>

<h3><a name="increment-2">increment/2</a></h3>

<p><code>increment(<a href="#type-tape">tape()</a>, N::integer()) -> <a href="#type-tape">tape()</a></code></p>
<p>Increments the value at the current position on the tape N times.</p>

<h3><a name="left-2">left/2</a></h3>

<p><code>left(<a href="#type-tape">tape()</a>, N::integer()) -> {<a href="#type-tape">tape()</a>, integer()}</code></p>
<p>Moves the read/write head N positions left on the tape.</p>

<h3><a name="new-1">new/1</a></h3>

<p><code>new([<a href="#type-option">option()</a>]) -> <a href="#type-tape">tape()</a><ul><li><a name="type-option">option()</a> = {atom(), term()}</li><li><a name="type-tape">tape()</a> = <a href="#type-tape">tape()</a></li></ul></code></p>
<p>Creates and returns a new tuple-backed tape.</p>

<h3><a name="peek-2">peek/2</a></h3>

<p><code>peek(Arg1, Arg2) -> term()</code></p>
<p> </p>

<h3><a name="poke-3">poke/3</a></h3>

<p><code>poke(Arg1, Arg2, Arg3) -> term()</code></p>
<p> </p>

<h3><a name="read-1">read/1</a></h3>

<p><code>read(<a href="#type-tape">tape()</a>) -> integer()</code></p>
<p>Returns the value at the current position on the tape.</p>

<h3><a name="right-2">right/2</a></h3>

<p><code>right(<a href="#type-tape">tape()</a>, N::integer()) -> {<a href="#type-tape">tape()</a>, integer()}</code></p>
<p>Moves the read/write head N positions right on the tape.</p>

<h3><a name="write-2">write/2</a></h3>

<p><code>write(<a href="#type-tape">tape()</a>, integer()) -> {<a href="#type-tape">tape()</a>, integer()}</code></p>
<p>Places the given value at the current position on the tape.</p></body>
</html>