OOP initial commit.
[Faustine.git] / documentation / Types.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <link rel="stylesheet" href="style.css" type="text/css">
5 <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
6 <link rel="Start" href="index.html">
7 <link rel="next" href="Parser.html">
8 <link rel="Up" href="index.html">
9 <link title="Index of types" rel=Appendix href="index_types.html">
10 <link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
11 <link title="Index of values" rel=Appendix href="index_values.html">
12 <link title="Index of modules" rel=Appendix href="index_modules.html">
13 <link title="Types" rel="Chapter" href="Types.html">
14 <link title="Parser" rel="Chapter" href="Parser.html">
15 <link title="Lexer" rel="Chapter" href="Lexer.html">
16 <link title="Value" rel="Chapter" href="Value.html">
17 <link title="Signal" rel="Chapter" href="Signal.html">
18 <link title="Faustexp" rel="Chapter" href="Faustexp.html">
19 <link title="Interpreter" rel="Chapter" href="Interpreter.html">
20 <link title="Preprocess" rel="Chapter" href="Preprocess.html">
21 <link title="Main" rel="Chapter" href="Main.html"><title>Types</title>
22 </head>
23 <body>
24 <div class="navbar">&nbsp;<a href="index.html">Up</a>
25 &nbsp;<a href="Parser.html">Next</a>
26 </div>
27 <center><h1>Module <a href="type_Types.html">Types</a></h1></center>
28 <br>
29 <pre><span class="keyword">module</span> Types: <code class="code">sig</code> <a href="Types.html">..</a> <code class="code">end</code></pre>type symbol, defines valid identifiers in faust expressions.<br>
30 <hr width="100%">
31 <br><code><span id="TYPEvalue"><span class="keyword">type</span> <code class="type"></code>value</span> = </code><table class="typetable">
32 <tr>
33 <td align="left" valign="top" >
34 <code><span class="keyword">|</span></code></td>
35 <td align="left" valign="top" >
36 <code><span class="constructor">N</span> <span class="keyword">of</span> <code class="type">int</code></code></td>
37
38 </tr>
39 <tr>
40 <td align="left" valign="top" >
41 <code><span class="keyword">|</span></code></td>
42 <td align="left" valign="top" >
43 <code><span class="constructor">R</span> <span class="keyword">of</span> <code class="type">float</code></code></td>
44
45 </tr>
46 <tr>
47 <td align="left" valign="top" >
48 <code><span class="keyword">|</span></code></td>
49 <td align="left" valign="top" >
50 <code><span class="constructor">Vec</span> <span class="keyword">of</span> <code class="type">int * (int -> <a href="Types.html#TYPEvalue">value</a>)</code></code></td>
51
52 </tr>
53 <tr>
54 <td align="left" valign="top" >
55 <code><span class="keyword">|</span></code></td>
56 <td align="left" valign="top" >
57 <code><span class="constructor">Zero</span></code></td>
58
59 </tr>
60 <tr>
61 <td align="left" valign="top" >
62 <code><span class="keyword">|</span></code></td>
63 <td align="left" valign="top" >
64 <code><span class="constructor">W</span></code></td>
65
66 </tr></table>
67
68
69 <br><code><span id="TYPEsymbol"><span class="keyword">type</span> <code class="type"></code>symbol</span> = </code><table class="typetable">
70 <tr>
71 <td align="left" valign="top" >
72 <code><span class="keyword">|</span></code></td>
73 <td align="left" valign="top" >
74 <code><span class="constructor">Add</span></code></td>
75
76 </tr>
77 <tr>
78 <td align="left" valign="top" >
79 <code><span class="keyword">|</span></code></td>
80 <td align="left" valign="top" >
81 <code><span class="constructor">Sup</span></code></td>
82
83 </tr>
84 <tr>
85 <td align="left" valign="top" >
86 <code><span class="keyword">|</span></code></td>
87 <td align="left" valign="top" >
88 <code><span class="constructor">Mul</span></code></td>
89
90 </tr>
91 <tr>
92 <td align="left" valign="top" >
93 <code><span class="keyword">|</span></code></td>
94 <td align="left" valign="top" >
95 <code><span class="constructor">Div</span></code></td>
96
97 </tr>
98 <tr>
99 <td align="left" valign="top" >
100 <code><span class="keyword">|</span></code></td>
101 <td align="left" valign="top" >
102 <code><span class="constructor">Pass</span></code></td>
103
104 </tr>
105 <tr>
106 <td align="left" valign="top" >
107 <code><span class="keyword">|</span></code></td>
108 <td align="left" valign="top" >
109 <code><span class="constructor">Stop</span></code></td>
110
111 </tr>
112 <tr>
113 <td align="left" valign="top" >
114 <code><span class="keyword">|</span></code></td>
115 <td align="left" valign="top" >
116 <code><span class="constructor">Mem</span></code></td>
117
118 </tr>
119 <tr>
120 <td align="left" valign="top" >
121 <code><span class="keyword">|</span></code></td>
122 <td align="left" valign="top" >
123 <code><span class="constructor">Delay</span></code></td>
124
125 </tr>
126 <tr>
127 <td align="left" valign="top" >
128 <code><span class="keyword">|</span></code></td>
129 <td align="left" valign="top" >
130 <code><span class="constructor">Floor</span></code></td>
131
132 </tr>
133 <tr>
134 <td align="left" valign="top" >
135 <code><span class="keyword">|</span></code></td>
136 <td align="left" valign="top" >
137 <code><span class="constructor">Int</span></code></td>
138
139 </tr>
140 <tr>
141 <td align="left" valign="top" >
142 <code><span class="keyword">|</span></code></td>
143 <td align="left" valign="top" >
144 <code><span class="constructor">Sin</span></code></td>
145
146 </tr>
147 <tr>
148 <td align="left" valign="top" >
149 <code><span class="keyword">|</span></code></td>
150 <td align="left" valign="top" >
151 <code><span class="constructor">Cos</span></code></td>
152
153 </tr>
154 <tr>
155 <td align="left" valign="top" >
156 <code><span class="keyword">|</span></code></td>
157 <td align="left" valign="top" >
158 <code><span class="constructor">Atan</span></code></td>
159
160 </tr>
161 <tr>
162 <td align="left" valign="top" >
163 <code><span class="keyword">|</span></code></td>
164 <td align="left" valign="top" >
165 <code><span class="constructor">Atantwo</span></code></td>
166
167 </tr>
168 <tr>
169 <td align="left" valign="top" >
170 <code><span class="keyword">|</span></code></td>
171 <td align="left" valign="top" >
172 <code><span class="constructor">Sqrt</span></code></td>
173
174 </tr>
175 <tr>
176 <td align="left" valign="top" >
177 <code><span class="keyword">|</span></code></td>
178 <td align="left" valign="top" >
179 <code><span class="constructor">Rdtable</span></code></td>
180
181 </tr>
182 <tr>
183 <td align="left" valign="top" >
184 <code><span class="keyword">|</span></code></td>
185 <td align="left" valign="top" >
186 <code><span class="constructor">Mod</span></code></td>
187
188 </tr>
189 <tr>
190 <td align="left" valign="top" >
191 <code><span class="keyword">|</span></code></td>
192 <td align="left" valign="top" >
193 <code><span class="constructor">Vectorize</span></code></td>
194
195 </tr>
196 <tr>
197 <td align="left" valign="top" >
198 <code><span class="keyword">|</span></code></td>
199 <td align="left" valign="top" >
200 <code><span class="constructor">Concat</span></code></td>
201
202 </tr>
203 <tr>
204 <td align="left" valign="top" >
205 <code><span class="keyword">|</span></code></td>
206 <td align="left" valign="top" >
207 <code><span class="constructor">Nth</span></code></td>
208
209 </tr>
210 <tr>
211 <td align="left" valign="top" >
212 <code><span class="keyword">|</span></code></td>
213 <td align="left" valign="top" >
214 <code><span class="constructor">Serialize</span></code></td>
215
216 </tr>
217 <tr>
218 <td align="left" valign="top" >
219 <code><span class="keyword">|</span></code></td>
220 <td align="left" valign="top" >
221 <code><span class="constructor">Larger</span></code></td>
222
223 </tr>
224 <tr>
225 <td align="left" valign="top" >
226 <code><span class="keyword">|</span></code></td>
227 <td align="left" valign="top" >
228 <code><span class="constructor">Smaller</span></code></td>
229
230 </tr>
231 <tr>
232 <td align="left" valign="top" >
233 <code><span class="keyword">|</span></code></td>
234 <td align="left" valign="top" >
235 <code><span class="constructor">Prefix</span></code></td>
236
237 </tr>
238 <tr>
239 <td align="left" valign="top" >
240 <code><span class="keyword">|</span></code></td>
241 <td align="left" valign="top" >
242 <code><span class="constructor">Selecttwo</span></code></td>
243
244 </tr>
245 <tr>
246 <td align="left" valign="top" >
247 <code><span class="keyword">|</span></code></td>
248 <td align="left" valign="top" >
249 <code><span class="constructor">Selectthree</span></code></td>
250
251 </tr></table>
252
253 <div class="info">
254 type symbol, defines valid identifiers in faust expressions.<br>
255 </div>
256
257 <pre><span id="EXCEPTIONSymbol_not_defined"><span class="keyword">exception</span> Symbol_not_defined</span></pre>
258 <pre><span id="VALsymbol_of_string"><span class="keyword">val</span> <a href="code_VALTypes.symbol_of_string.html">symbol_of_string</a></span> : <code class="type">string -> <a href="Types.html#TYPEsymbol">symbol</a></code></pre><pre><span id="TYPEsignal"><span class="keyword">type</span> <code class="type"></code>signal</span> = <code class="type">int * (int -> <a href="Types.html#TYPEvalue">value</a>)</code> </pre>
259
260 <br><code><span id="TYPEfaust_exp"><span class="keyword">type</span> <code class="type"></code>faust_exp</span> = </code><table class="typetable">
261 <tr>
262 <td align="left" valign="top" >
263 <code><span class="keyword">|</span></code></td>
264 <td align="left" valign="top" >
265 <code><span class="constructor">Const</span> <span class="keyword">of</span> <code class="type"><a href="Types.html#TYPEvalue">value</a></code></code></td>
266
267 </tr>
268 <tr>
269 <td align="left" valign="top" >
270 <code><span class="keyword">|</span></code></td>
271 <td align="left" valign="top" >
272 <code><span class="constructor">Ident</span> <span class="keyword">of</span> <code class="type"><a href="Types.html#TYPEsymbol">symbol</a></code></code></td>
273
274 </tr>
275 <tr>
276 <td align="left" valign="top" >
277 <code><span class="keyword">|</span></code></td>
278 <td align="left" valign="top" >
279 <code><span class="constructor">Par</span> <span class="keyword">of</span> <code class="type"><a href="Types.html#TYPEfaust_exp">faust_exp</a> * <a href="Types.html#TYPEfaust_exp">faust_exp</a></code></code></td>
280
281 </tr>
282 <tr>
283 <td align="left" valign="top" >
284 <code><span class="keyword">|</span></code></td>
285 <td align="left" valign="top" >
286 <code><span class="constructor">Seq</span> <span class="keyword">of</span> <code class="type"><a href="Types.html#TYPEfaust_exp">faust_exp</a> * <a href="Types.html#TYPEfaust_exp">faust_exp</a></code></code></td>
287
288 </tr>
289 <tr>
290 <td align="left" valign="top" >
291 <code><span class="keyword">|</span></code></td>
292 <td align="left" valign="top" >
293 <code><span class="constructor">Rec</span> <span class="keyword">of</span> <code class="type"><a href="Types.html#TYPEfaust_exp">faust_exp</a> * <a href="Types.html#TYPEfaust_exp">faust_exp</a></code></code></td>
294
295 </tr>
296 <tr>
297 <td align="left" valign="top" >
298 <code><span class="keyword">|</span></code></td>
299 <td align="left" valign="top" >
300 <code><span class="constructor">Split</span> <span class="keyword">of</span> <code class="type"><a href="Types.html#TYPEfaust_exp">faust_exp</a> * <a href="Types.html#TYPEfaust_exp">faust_exp</a></code></code></td>
301
302 </tr>
303 <tr>
304 <td align="left" valign="top" >
305 <code><span class="keyword">|</span></code></td>
306 <td align="left" valign="top" >
307 <code><span class="constructor">Merge</span> <span class="keyword">of</span> <code class="type"><a href="Types.html#TYPEfaust_exp">faust_exp</a> * <a href="Types.html#TYPEfaust_exp">faust_exp</a></code></code></td>
308
309 </tr></table>
310
311
312 <br><code><span id="TYPEdimension"><span class="keyword">type</span> <code class="type"></code>dimension</span> = </code><table class="typetable">
313 <tr>
314 <td align="left" valign="top" >
315 <code><span class="keyword">|</span></code></td>
316 <td align="left" valign="top" >
317 <code><span class="constructor">End</span> <span class="keyword">of</span> <code class="type">(int * int)</code></code></td>
318
319 </tr>
320 <tr>
321 <td align="left" valign="top" >
322 <code><span class="keyword">|</span></code></td>
323 <td align="left" valign="top" >
324 <code><span class="constructor">Tree</span> <span class="keyword">of</span> <code class="type">(int * int) * (<a href="Types.html#TYPEdimension">dimension</a> * <a href="Types.html#TYPEdimension">dimension</a>)</code></code></td>
325
326 </tr></table>
327
328
329 </body></html>