Install, Readme and Changes files updated. Documentation removed.
[Faustine.git] / documentation / Value.html
diff --git a/documentation/Value.html b/documentation/Value.html
deleted file mode 100644 (file)
index d434f5d..0000000
+++ /dev/null
@@ -1,193 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-<head>
-<link rel="stylesheet" href="style.css" type="text/css">
-<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
-<link rel="Start" href="index.html">
-<link rel="previous" href="Lexer.html">
-<link rel="next" href="Signal.html">
-<link rel="Up" href="index.html">
-<link title="Index of types" rel=Appendix href="index_types.html">
-<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
-<link title="Index of values" rel=Appendix href="index_values.html">
-<link title="Index of modules" rel=Appendix href="index_modules.html">
-<link title="Types" rel="Chapter" href="Types.html">
-<link title="Parser" rel="Chapter" href="Parser.html">
-<link title="Lexer" rel="Chapter" href="Lexer.html">
-<link title="Value" rel="Chapter" href="Value.html">
-<link title="Signal" rel="Chapter" href="Signal.html">
-<link title="Faustexp" rel="Chapter" href="Faustexp.html">
-<link title="Interpreter" rel="Chapter" href="Interpreter.html">
-<link title="Preprocess" rel="Chapter" href="Preprocess.html">
-<link title="Main" rel="Chapter" href="Main.html"><title>Value</title>
-</head>
-<body>
-<div class="navbar"><a href="Lexer.html">Previous</a>
-&nbsp;<a href="index.html">Up</a>
-&nbsp;<a href="Signal.html">Next</a>
-</div>
-<center><h1>Module <a href="type_Value.html">Value</a></h1></center>
-<br>
-<pre><span class="keyword">module</span> Value: <code class="code">sig</code> <a href="Value.html">..</a> <code class="code">end</code></pre>Module: Value     
-       Description: basic data type in the vectorial faust interpreter.<br>
-<b>Author(s):</b> WANG Haisheng        
-       Created: 31/05/2013     Modified: 03/06/2013<br>
-<hr width="100%">
-<pre><span id="EXCEPTIONConvert_Error"><span class="keyword">exception</span> Convert_Error</span> <span class="keyword">of</span> <code class="type">string</code></pre>
-<div class="info">
-Exception raised in convertions between float/int and type 'Value'.<br>
-</div>
-<pre><span id="EXCEPTIONValue_operation"><span class="keyword">exception</span> Value_operation</span> <span class="keyword">of</span> <code class="type">string</code></pre>
-<div class="info">
-Exception raised in type 'Value' operations.<br>
-</div>
-<br><code><span id="TYPEvalue_macro"><span class="keyword">type</span> <code class="type"></code>value_macro</span> = </code><table class="typetable">
-<tr>
-<td align="left" valign="top" >
-<code><span class="keyword">|</span></code></td>
-<td align="left" valign="top" >
-<code><span class="constructor">Faust_Max_int</span></code></td>
-
-</tr>
-<tr>
-<td align="left" valign="top" >
-<code><span class="keyword">|</span></code></td>
-<td align="left" valign="top" >
-<code><span class="constructor">Faust_Min_int</span></code></td>
-
-</tr>
-<tr>
-<td align="left" valign="top" >
-<code><span class="keyword">|</span></code></td>
-<td align="left" valign="top" >
-<code><span class="constructor">Faust_Bits_int</span></code></td>
-
-</tr></table>
-
-<div class="info">
-Macro constants of the file.<br>
-</div>
-
-<pre><span id="VALvalue_macro_to_int"><span class="keyword">val</span> <a href="code_VALValue.value_macro_to_int.html">value_macro_to_int</a></span> : <code class="type"><a href="Value.html#TYPEvalue_macro">value_macro</a> -> int</code></pre><div class="info">
-val value_macro_to_value : value_macro -&gt; int.<br>
-</div>
-<pre><span id="VALreturn_N"><span class="keyword">val</span> <a href="code_VALValue.return_N.html">return_N</a></span> : <code class="type">int -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val return_N : int -&gt; value, convert from int to value N.<br>
-</div>
-<pre><span id="VALreturn_R"><span class="keyword">val</span> <a href="code_VALValue.return_R.html">return_R</a></span> : <code class="type">float -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val return_R : float -&gt; value, convert from float to value R.<br>
-</div>
-<pre><span id="VALreturn_Vec"><span class="keyword">val</span> <a href="code_VALValue.return_Vec.html">return_Vec</a></span> : <code class="type">int * (int -> <a href="Types.html#TYPEvalue">Types.value</a>) -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val return_Vec : int * (int -&gt; value) -&gt; value, convert (size, vec) to value Vec.<br>
-</div>
-<pre><span id="VALfail"><span class="keyword">val</span> <a href="code_VALValue.fail.html">fail</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val fail, return value W.<br>
-</div>
-<pre><span id="VALtake_off_N"><span class="keyword">val</span> <a href="code_VALValue.take_off_N.html">take_off_N</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> int</code></pre><div class="info">
-val take_off_N : value -&gt; int, convert from value N to int. 
-Attention: Zero and W are converted to 0.<br>
-</div>
-<pre><span id="VALtake_off_R"><span class="keyword">val</span> <a href="code_VALValue.take_off_R.html">take_off_R</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> float</code></pre><div class="info">
-val take_off_R : value -&gt; float, convert from value R to float. 
-Attention: Zero and W are converted to 0.0, int converted to float.<br>
-</div>
-<pre><span id="VALconvert_back_R"><span class="keyword">val</span> <a href="code_VALValue.convert_back_R.html">convert_back_R</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> float array</code></pre><div class="info">
-val convert_back_r : value -&gt; float array, 
-return a float array of size 1 if v is N|R|Zero|W, a float array of size n if v is Vec.<br>
-</div>
-<pre><span id="VALstring_of_value"><span class="keyword">val</span> <a href="code_VALValue.string_of_value.html">string_of_value</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> string</code></pre><div class="info">
-val string_of_value : value -&gt; string, converts value to following 
-strings "N i" | "R f" | "Vec" | "Zero" | "W".<br>
-</div>
-<pre><span id="VALprint_value_list"><span class="keyword">val</span> <a href="code_VALValue.print_value_list.html">print_value_list</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> list -> unit</code></pre><div class="info">
-val print_value_list: value list -&gt; unit, prints to console the value list.<br>
-</div>
-<pre><span id="VALfactory_add_memory"><span class="keyword">val</span> <a href="code_VALValue.factory_add_memory.html">factory_add_memory</a></span> : <code class="type">(int -> 'a) -> int -> int -> 'a</code></pre><div class="info">
-val factory_add_memory : (int -&gt; 'b) -&gt; int -&gt; (int -&gt; 'b),
-<code class="code">factory_add_memory f n</code> adds a memory of size n to fun f.<br>
-</div>
-<pre><span id="VALv_memory"><span class="keyword">val</span> <a href="code_VALValue.v_memory.html">v_memory</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val v_memory : value -&gt; value, returns value Vec with memory.<br>
-</div>
-<pre><span id="VALv_list_memory"><span class="keyword">val</span> <a href="code_VALValue.v_list_memory.html">v_list_memory</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> list -> <a href="Types.html#TYPEvalue">Types.value</a> list</code></pre><div class="info">
-val v_list_memory : value list -&gt; value list, returns value list with memory.<br>
-</div>
-<pre><span id="VALmake_vector"><span class="keyword">val</span> <a href="code_VALValue.make_vector.html">make_vector</a></span> : <code class="type">int -> (int -> <a href="Types.html#TYPEvalue">Types.value</a>) -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val make_vector : int -&gt; (int -&gt; value) -&gt; value,
-<code class="code">make_vector size vec</code>, return a value Vec of (size, vec).<br>
-</div>
-<pre><span id="VALnormalize"><span class="keyword">val</span> <a href="code_VALValue.normalize.html">normalize</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val normalize: value -&gt; value, normalize value to bounded <code class="code">-2147483648,2147483647</code>.<br>
-</div>
-<pre><span id="VALv_add"><span class="keyword">val</span> <a href="code_VALValue.v_add.html">v_add</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val v_add : value -&gt; value -&gt; value, value addition, recursive for value.Vec.<br>
-</div>
-<pre><span id="VAL(+~)"><span class="keyword">val</span> <a href="code_VALValue.(_plus__tilde_).html">(+~)</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val (+~) : value -&gt; value -&gt; value, operator of v_add.<br>
-</div>
-<pre><span id="VALv_neg"><span class="keyword">val</span> <a href="code_VALValue.v_neg.html">v_neg</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val v_neg : value -&gt; value, v_neg v = -v.<br>
-</div>
-<pre><span id="VALv_sub"><span class="keyword">val</span> <a href="code_VALValue.v_sub.html">v_sub</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val v_sub : value -&gt; value -&gt; value, returns (v1 - v2).<br>
-</div>
-<pre><span id="VAL(-~)"><span class="keyword">val</span> <a href="code_VALValue.(_minus__tilde_).html">(-~)</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val (-~) : value -&gt; value -&gt; value, operator of v_sub.<br>
-</div>
-<pre><span id="VALv_mul"><span class="keyword">val</span> <a href="code_VALValue.v_mul.html">v_mul</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val v_mul : value -&gt; value -&gt; value, returns (v1 * v2), recursive for value.Vec.<br>
-</div>
-<pre><span id="VAL( *~ )"><span class="keyword">val</span> <a href="code_VALValue.( _star__tilde_ ).html">( *~ )</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val ( *~ ) : value -&gt; value -&gt; value, operator of v_mul.<br>
-</div>
-<pre><span id="VALv_recip"><span class="keyword">val</span> <a href="code_VALValue.v_recip.html">v_recip</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val v_recip : value -&gt; value, v_recip v = 1./.v.<br>
-</div>
-<pre><span id="VALv_div"><span class="keyword">val</span> <a href="code_VALValue.v_div.html">v_div</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val v_div : value -&gt; value -&gt; value, value division, returns (v1/.v2).<br>
-</div>
-<pre><span id="VAL(/~)"><span class="keyword">val</span> <a href="code_VALValue.(_slash__tilde_).html">(/~)</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val (/~) : value -&gt; value -&gt; value, operator of v_div.<br>
-</div>
-<pre><span id="VALv_zero"><span class="keyword">val</span> <a href="code_VALValue.v_zero.html">v_zero</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val v_zero : value -&gt; value, Attention: N i -&gt; N 0 | R f -&gt; R 0. | Zero -&gt; Zero | W -&gt; R 0., 
-and recursive for value.Vec.<br>
-</div>
-<pre><span id="VALv_floor"><span class="keyword">val</span> <a href="code_VALValue.v_floor.html">v_floor</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val v_floor : value -&gt; value, returns floor of float, converts int to float, Zero to 0.,
- error to error, recursive for value.Vec.<br>
-</div>
-<pre><span id="VALv_int"><span class="keyword">val</span> <a href="code_VALValue.v_int.html">v_int</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val v_int : value -&gt; value, converts value to value.N, error to error, recursive for value.Vec.<br>
-</div>
-<pre><span id="VALv_sin"><span class="keyword">val</span> <a href="code_VALValue.v_sin.html">v_sin</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val v_sin : value -&gt; value, returns sin(v), recursive for value.Vec.<br>
-</div>
-<pre><span id="VALv_cos"><span class="keyword">val</span> <a href="code_VALValue.v_cos.html">v_cos</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val v_cos : value -&gt; value, returns cos(v), recursive for value.Vec.<br>
-</div>
-<pre><span id="VALv_atan"><span class="keyword">val</span> <a href="code_VALValue.v_atan.html">v_atan</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val v_atan : value -&gt; value, returns atan(v), recursive for value.Vec.<br>
-</div>
-<pre><span id="VALv_atantwo"><span class="keyword">val</span> <a href="code_VALValue.v_atantwo.html">v_atantwo</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val v_atantwo : value -&gt; value, returns atantwo(v), recursive for value.Vec.<br>
-</div>
-<pre><span id="VALv_sqrt"><span class="keyword">val</span> <a href="code_VALValue.v_sqrt.html">v_sqrt</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val v_sqrt : value -&gt; value, returns sqrt(v), recursive for value.Vec.<br>
-</div>
-<pre><span id="VALv_mod"><span class="keyword">val</span> <a href="code_VALValue.v_mod.html">v_mod</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val v_mod : value -&gt; value -&gt; value, returns (v1 % v2), recursive for value.Vec.<br>
-</div>
-<pre><span id="VALv_larger_than_zero"><span class="keyword">val</span> <a href="code_VALValue.v_larger_than_zero.html">v_larger_than_zero</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val v_larger_than_zero : value -&gt; value, primitive comparison between value and zero, 
-returns value.N 1 if true, value.N 0 if false.<br>
-</div>
-<pre><span id="VALv_sup"><span class="keyword">val</span> <a href="code_VALValue.v_sup.html">v_sup</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val v_sup : value -&gt; value -&gt; value, comparison of two values, returns value.N 1 if (v1 &gt; v2), 
-value.N 0 else.<br>
-</div>
-<pre><span id="VALv_inf"><span class="keyword">val</span> <a href="code_VALValue.v_inf.html">v_inf</a></span> : <code class="type"><a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a> -> <a href="Types.html#TYPEvalue">Types.value</a></code></pre><div class="info">
-val v_inf : value -&gt; value -&gt; value, comparison of two values, returns value.N 1 if (v1 &lt; v2), 
-value.N 0 else.<br>
-</div>
-</body></html>
\ No newline at end of file