<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>FAUST compiler: doc_sharing.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<h1>doc_sharing.cpp</h1><a href="doc__sharing_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/************************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> ************************************************************************</span>
<a name="l00003"></a>00003 <span class="comment"> FAUST compiler</span>
<a name="l00004"></a>00004 <span class="comment"> Copyright (C) 2003-2004 GRAME, Centre National de Creation Musicale</span>
<a name="l00005"></a>00005 <span class="comment"> ---------------------------------------------------------------------</span>
<a name="l00006"></a>00006 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00007"></a>00007 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00008"></a>00008 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00009"></a>00009 <span class="comment"> (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"></span>
<a name="l00011"></a>00011 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00014"></a>00014 <span class="comment"> GNU General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment"> You should have received a copy of the GNU General Public License</span>
<a name="l00017"></a>00017 <span class="comment"> along with this program; if not, write to the Free Software</span>
<a name="l00018"></a>00018 <span class="comment"> Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00019"></a>00019 <span class="comment"> ************************************************************************</span>
<a name="l00020"></a>00020 <span class="comment"> ************************************************************************/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="comment">/*****************************************************************************</span>
<a name="l00025"></a>00025 <span class="comment">******************************************************************************</span>
<a name="l00026"></a>00026 <span class="comment"> FAUST SIGNAL COMPILER</span>
<a name="l00027"></a>00027 <span class="comment"> Y. Orlarey, (c) Grame 2002</span>
<a name="l00028"></a>00028 <span class="comment">------------------------------------------------------------------------------</span>
<a name="l00029"></a>00029 <span class="comment">Compile a list of FAUST signals into a LaTeX equation.</span>
<a name="l00030"></a>00030 <span class="comment"></span>
<a name="l00031"></a>00031 <span class="comment"> History :</span>
<a name="l00032"></a>00032 <span class="comment"> ---------</span>
<a name="l00033"></a>00033 <span class="comment"> 2002-02-08 : First version (of sharing.cpp)</span>
<a name="l00034"></a>00034 <span class="comment"> 2009-08-18 : Doc version (Karim Barkati)</span>
<a name="l00035"></a>00035 <span class="comment"></span>
<a name="l00036"></a>00036 <span class="comment">******************************************************************************</span>
<a name="l00037"></a>00037 <span class="comment">*****************************************************************************/</span>
<a name="l00038"></a>00038
<a name="l00039"></a>00039
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="preprocessor">#include <stdio.h></span>
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="comment">//#include "compile_vect.hh"</span>
<a name="l00044"></a>00044 <span class="comment">//#include "compile_scal.hh"</span>
<a name="l00045"></a>00045 <span class="comment">//#include "doc_compile_vect.hh"</span>
<a name="l00046"></a>00046 <span class="preprocessor">#include "<a class="code" href="doc__compile_8hh.html">doc_compile.hh</a>"</span>
<a name="l00047"></a>00047 <span class="preprocessor">#include "<a class="code" href="sigtype_8hh.html">sigtype.hh</a>"</span>
<a name="l00048"></a>00048 <span class="preprocessor">#include "<a class="code" href="sigtyperules_8hh.html">sigtyperules.hh</a>"</span>
<a name="l00049"></a>00049 <span class="preprocessor">#include "<a class="code" href="sigprint_8hh.html">sigprint.hh</a>"</span>
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="comment">//#include "doc_sharing.hh"</span>
<a name="l00052"></a>00052
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <span class="comment">/*****************************************************************************</span>
<a name="l00055"></a>00055 <span class="comment">******************************************************************************</span>
<a name="l00056"></a>00056 <span class="comment"></span>
<a name="l00057"></a>00057 <span class="comment"> SHARING ANALYSIS</span>
<a name="l00058"></a>00058 <span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment">******************************************************************************</span>
<a name="l00060"></a>00060 <span class="comment">*****************************************************************************/</span>
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="comment">//------------------------------------------------------------------------------</span>
<a name="l00063"></a>00063 <span class="comment">// Create a specific property key for the sharing count of subtrees of t</span>
<a name="l00064"></a>00064 <span class="comment">//------------------------------------------------------------------------------</span>
<a name="l00065"></a>00065
<a name="l00066"></a><a class="code" href="classDocCompiler.html#ad8fa6d8cefba3c723a6c1021c372ad6a">00066</a> <span class="keywordtype">int</span> <a class="code" href="classDocCompiler.html#ad8fa6d8cefba3c723a6c1021c372ad6a">DocCompiler::getSharingCount</a>(<a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> sig)
<a name="l00067"></a>00067 <span class="comment">//int getSharingCount(Tree sig, int count)</span>
<a name="l00068"></a>00068 {
<a name="l00069"></a>00069 <span class="comment">//cerr << "getSharingCount of : " << *sig << " = ";</span>
<a name="l00070"></a>00070 <a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> c;
<a name="l00071"></a>00071 <span class="keywordflow">if</span> (<a class="code" href="list_8cpp.html#a665745948013d012bb123e9577c094bd">getProperty</a>(sig, <a class="code" href="classDocCompiler.html#a992ee2f6af8cd6b52e5e7a7924b64e6f">fSharingKey</a>, c)) {
<a name="l00072"></a>00072 <span class="comment">//cerr << c->node().getInt() << endl;</span>
<a name="l00073"></a>00073 <span class="keywordflow">return</span> c-><a class="code" href="classCTree.html#a8de786fec095c8304b9ffa7c1c316237" title="return the content of the tree">node</a>().<a class="code" href="classNode.html#a0ac89402d0e51d19bed062529a375efe">getInt</a>();
<a name="l00074"></a>00074 } <span class="keywordflow">else</span> {
<a name="l00075"></a>00075 <span class="comment">//cerr << 0 << endl;</span>
<a name="l00076"></a>00076 <span class="keywordflow">return</span> 0;
<a name="l00077"></a>00077 }
<a name="l00078"></a>00078 }
<a name="l00079"></a>00079
<a name="l00080"></a>00080
<a name="l00081"></a><a class="code" href="classDocCompiler.html#abc3e5be0bf658306b0597f2fff53a105">00081</a> <span class="keywordtype">void</span> <a class="code" href="classDocCompiler.html#abc3e5be0bf658306b0597f2fff53a105">DocCompiler::setSharingCount</a>(<a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> sig, <span class="keywordtype">int</span> count)
<a name="l00082"></a>00082 <span class="comment">//void setSharingCount(Tree sig, int count)</span>
<a name="l00083"></a>00083 {
<a name="l00084"></a>00084 <span class="comment">//cerr << "setSharingCount of : " << *sig << " <- " << count << endl;</span>
<a name="l00085"></a>00085 <a class="code" href="list_8cpp.html#a5ead5a3e91af18d8f94e0974990a3c5a">setProperty</a>(sig, <a class="code" href="classDocCompiler.html#a992ee2f6af8cd6b52e5e7a7924b64e6f">fSharingKey</a>, <a class="code" href="tree_8hh.html#a61c13e9361cfa80bbb3cd6ce60a8f595">tree</a>(count));
<a name="l00086"></a>00086 }
<a name="l00087"></a>00087
<a name="l00088"></a>00088
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="comment">//------------------------------------------------------------------------------</span>
<a name="l00091"></a>00091 <span class="comment">// Create a specific property key for the sharing count of subtrees of t</span>
<a name="l00092"></a>00092 <span class="comment">//------------------------------------------------------------------------------</span>
<a name="l00093"></a>00093
<a name="l00094"></a>00094
<a name="l00095"></a>00095
<a name="l00096"></a><a class="code" href="classDocCompiler.html#ab8102d957e24d02aaa4b0cdb2e702dd3">00096</a> <span class="keywordtype">void</span> <a class="code" href="classDocCompiler.html#ab8102d957e24d02aaa4b0cdb2e702dd3">DocCompiler::sharingAnalysis</a>(<a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> t)
<a name="l00097"></a>00097 <span class="comment">//void sharingAnalysis(Tree t)</span>
<a name="l00098"></a>00098 {
<a name="l00099"></a>00099 <a class="code" href="classDocCompiler.html#a992ee2f6af8cd6b52e5e7a7924b64e6f">fSharingKey</a> = <a class="code" href="shlysis_8cpp.html#a827cae6cc8102ab89e60ae2996fbdbf4" title="Create a specific property key for the sharing count of subtrees of t.">shprkey</a>(t);
<a name="l00100"></a>00100 <span class="keywordflow">if</span> (<a class="code" href="list_8hh.html#a8bdd73641276e0c0f999f504348eacc1">isList</a>(t)) {
<a name="l00101"></a>00101 <span class="keywordflow">while</span> (<a class="code" href="list_8hh.html#a8bdd73641276e0c0f999f504348eacc1">isList</a>(t)) {
<a name="l00102"></a>00102 <a class="code" href="classDocCompiler.html#a7a06f13dc4cb45281f7c2549921c7ce1">sharingAnnotation</a>(<a class="code" href="sigtype_8hh.html#a726ca809ffd3d67ab4b8476646f26635a415bf3edc164c8f259f328ff6dc0529a">kSamp</a>, <a class="code" href="list_8hh.html#a067ad6f83087b420a1c44e48e56be389">hd</a>(t));
<a name="l00103"></a>00103 t = <a class="code" href="list_8hh.html#a4075748f5c7156306ec898795313a2e0">tl</a>(t);
<a name="l00104"></a>00104 }
<a name="l00105"></a>00105 } <span class="keywordflow">else</span> {
<a name="l00106"></a>00106 <a class="code" href="classDocCompiler.html#a7a06f13dc4cb45281f7c2549921c7ce1">sharingAnnotation</a>(<a class="code" href="sigtype_8hh.html#a726ca809ffd3d67ab4b8476646f26635a415bf3edc164c8f259f328ff6dc0529a">kSamp</a>, t);
<a name="l00107"></a>00107 }
<a name="l00108"></a>00108 }
<a name="l00109"></a>00109
<a name="l00110"></a>00110
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="comment">//------------------------------------------------------------------------------</span>
<a name="l00113"></a>00113 <span class="comment">// Create a specific property key for the sharing count of subtrees of t</span>
<a name="l00114"></a>00114 <span class="comment">//------------------------------------------------------------------------------</span>
<a name="l00115"></a>00115
<a name="l00116"></a>00116
<a name="l00117"></a><a class="code" href="classDocCompiler.html#a7a06f13dc4cb45281f7c2549921c7ce1">00117</a> <span class="keywordtype">void</span> <a class="code" href="classDocCompiler.html#a7a06f13dc4cb45281f7c2549921c7ce1">DocCompiler::sharingAnnotation</a>(<span class="keywordtype">int</span> vctxt, <a class="code" href="classCTree.html" title="A CTree = (Node x [CTree]) is a Node associated with a list of subtrees called branches...">Tree</a> sig)
<a name="l00118"></a>00118 <span class="comment">//void sharingAnnotation(int vctxt, Tree sig)</span>
<a name="l00119"></a>00119 {
<a name="l00120"></a>00120 <span class="comment">//cerr << "START sharing annotation of " << *sig << endl;</span>
<a name="l00121"></a>00121 <span class="keywordtype">int</span> count = <a class="code" href="classDocCompiler.html#ad8fa6d8cefba3c723a6c1021c372ad6a">getSharingCount</a>(sig);
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="keywordflow">if</span> (count > 0) {
<a name="l00124"></a>00124 <span class="comment">// it is not our first visit</span>
<a name="l00125"></a>00125 <a class="code" href="classDocCompiler.html#abc3e5be0bf658306b0597f2fff53a105">setSharingCount</a>(sig, count+1);
<a name="l00126"></a>00126
<a name="l00127"></a>00127 } <span class="keywordflow">else</span> {
<a name="l00128"></a>00128 <span class="comment">// it is our first visit,</span>
<a name="l00129"></a>00129 <span class="keywordtype">int</span> v = <a class="code" href="sigtyperules_8cpp.html#a1f41188e4150f54b2fb2caf28a948785" title="retrieve the type annotation of sig">getSigType</a>(sig)->variability();
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="comment">// check "time sharing" cases</span>
<a name="l00132"></a>00132 <span class="keywordflow">if</span> (v < vctxt) {
<a name="l00133"></a>00133 <a class="code" href="classDocCompiler.html#abc3e5be0bf658306b0597f2fff53a105">setSharingCount</a>(sig, 2); <span class="comment">// time sharing occurence : slower expression in faster context</span>
<a name="l00134"></a>00134 } <span class="keywordflow">else</span> {
<a name="l00135"></a>00135 <a class="code" href="classDocCompiler.html#abc3e5be0bf658306b0597f2fff53a105">setSharingCount</a>(sig, 1); <span class="comment">// regular occurence</span>
<a name="l00136"></a>00136 }
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <span class="comment">// Annotate the sub signals</span>
<a name="l00139"></a>00139 vector<Tree> subsig;
<a name="l00140"></a>00140 <span class="keywordtype">int</span> n = <a class="code" href="signals_8hh.html#ae5dd2bb17d8df90f5561bb8084b3f10f" title="Extract the sub signals of a signal expression, that is not necesseraly all the subtrees...">getSubSignals</a>(sig, subsig);
<a name="l00141"></a>00141 <span class="keywordflow">if</span> (n>0 && ! <a class="code" href="signals_8cpp.html#a771720237ca174a55a6823cc6623d602">isSigGen</a>(sig)) {
<a name="l00142"></a>00142 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i=0; i<n; i++) <a class="code" href="classDocCompiler.html#a7a06f13dc4cb45281f7c2549921c7ce1">sharingAnnotation</a>(v, subsig[i]);
<a name="l00143"></a>00143 }
<a name="l00144"></a>00144 }
<a name="l00145"></a>00145 <span class="comment">//cerr << "END sharing annotation of " << *sig << endl;</span>
<a name="l00146"></a>00146 }
<a name="l00147"></a>00147
<a name="l00148"></a>00148
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Apr 28 23:59:58 2010 for FAUST compiler by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
