documentation/classarm__compute_1_1graph__utils_1_1_p_p_m_writer.xhtml

   1 <!-- HTML header for doxygen 1.8.9.1-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7 <meta name="generator" content="Doxygen 1.8.6"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>Compute Library: PPMWriter Class Reference</title>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <script type="text/javascript" src="jquery.js"></script>
  12 <script type="text/javascript" src="dynsections.js"></script>
  13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18   $(window).load(resizeHeight);
  19 </script>
  20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(function() { searchBox.OnSelectItem(0); });
  24 </script>
  25 <script type="text/x-mathjax-config">
  26   MathJax.Hub.Config({
  27     extensions: ["tex2jax.js"],
  28     jax: ["input/TeX","output/HTML-CSS"],
  29 });
  30 </script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  31 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  32 </head>
  33 <body>
  34 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  35 <div id="titlearea">
  36 <table cellspacing="0" cellpadding="0">
  37  <tbody>
  38  <tr style="height: 56px;">
  39   <td style="padding-left: 0.5em;">
  40    <div id="projectname">Compute Library
  41    &#160;<span id="projectnumber">17.09</span>
  42    </div>
  43   </td>
  44  </tr>
  45  </tbody>
  46 </table>
  47 </div>
  48 <!-- end header part -->
  49 <!-- Generated by Doxygen 1.8.6 -->
  50 <script type="text/javascript">
  51 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  52 </script>
  53   <div id="navrow1" class="tabs">
  54     <ul class="tablist">
  55       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  56       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  57       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  58       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  59       <li><a href="files.xhtml"><span>Files</span></a></li>
  60       <li>
  61         <div id="MSearchBox" class="MSearchBoxInactive">
  62         <span class="left">
  63           <img id="MSearchSelect" src="search/mag_sel.png"
  64                onmouseover="return searchBox.OnSearchSelectShow()"
  65                onmouseout="return searchBox.OnSearchSelectHide()"
  66                alt=""/>
  67           <input type="text" id="MSearchField" value="Search" accesskey="S"
  68                onfocus="searchBox.OnSearchFieldFocus(true)"
  69                onblur="searchBox.OnSearchFieldFocus(false)"
  70                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  71           </span><span class="right">
  72             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  73           </span>
  74         </div>
  75       </li>
  76     </ul>
  77   </div>
  78   <div id="navrow2" class="tabs2">
  79     <ul class="tablist">
  80       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  81       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  82       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  83       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  84     </ul>
  85   </div>
  86 </div><!-- top -->
  87 <div id="side-nav" class="ui-resizable side-nav-resizable">
  88   <div id="nav-tree">
  89     <div id="nav-tree-contents">
  90       <div id="nav-sync" class="sync"></div>
  91     </div>
  92   </div>
  93   <div id="splitbar" style="-moz-user-select:none;"
  94        class="ui-resizable-handle">
  95   </div>
  96 </div>
  97 <script type="text/javascript">
  98 $(document).ready(function(){initNavTree('classarm__compute_1_1graph__utils_1_1_p_p_m_writer.xhtml','');});
  99 </script>
 100 <div id="doc-content">
 101 <!-- window showing the filter options -->
 102 <div id="MSearchSelectWindow"
 103      onmouseover="return searchBox.OnSearchSelectShow()"
 104      onmouseout="return searchBox.OnSearchSelectHide()"
 105      onkeydown="return searchBox.OnSearchSelectKey(event)">
 106 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
 107
 108 <!-- iframe showing the search results (closed by default) -->
 109 <div id="MSearchResultsWindow">
 110 <iframe src="javascript:void(0)" frameborder="0"
 111         name="MSearchResults" id="MSearchResults">
 112 </iframe>
 113 </div>
 114
 115 <div class="header">
 116   <div class="summary">
 117 <a href="#pub-methods">Public Member Functions</a>  </div>
 118   <div class="headertitle">
 119 <div class="title">PPMWriter Class Reference</div>  </div>
 120 </div><!--header-->
 121 <div class="contents">
 122
 123 <p>PPM writer class.
 124  <a href="classarm__compute_1_1graph__utils_1_1_p_p_m_writer.xhtml#details">More...</a></p>
 125
 126 <p><code>#include &lt;<a class="el" href="_graph_utils_8h_source.xhtml">GraphUtils.h</a>&gt;</code></p>
 127 <div class="dynheader">
 128 Collaboration diagram for PPMWriter:</div>
 129 <div class="dyncontent">
 130 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1graph__utils_1_1_p_p_m_writer__coll__graph.svg" width="132" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 131 </div>
 132 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 133 <table class="memberdecls">
 134 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 135 Public Member Functions</h2></td></tr>
 136 <tr class="memitem:a9ea94bf5b7d00ddb836df1b8dcedb93a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1graph__utils_1_1_p_p_m_writer.xhtml#a9ea94bf5b7d00ddb836df1b8dcedb93a">PPMWriter</a> (std::string name, unsigned int maximum=1)</td></tr>
 137 <tr class="memdesc:a9ea94bf5b7d00ddb836df1b8dcedb93a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a9ea94bf5b7d00ddb836df1b8dcedb93a">More...</a><br/></td></tr>
 138 <tr class="separator:a9ea94bf5b7d00ddb836df1b8dcedb93a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 <tr class="memitem:a9f9290f4260c1d4ed6096988cf1423a8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1graph__utils_1_1_p_p_m_writer.xhtml#a9f9290f4260c1d4ed6096988cf1423a8">PPMWriter</a> (<a class="el" href="classarm__compute_1_1graph__utils_1_1_p_p_m_writer.xhtml">PPMWriter</a> &amp;&amp;)=default</td></tr>
 140 <tr class="memdesc:a9f9290f4260c1d4ed6096988cf1423a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allows instances to move constructed.  <a href="#a9f9290f4260c1d4ed6096988cf1423a8">More...</a><br/></td></tr>
 141 <tr class="separator:a9f9290f4260c1d4ed6096988cf1423a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <tr class="memitem:ab469d593b4bc92e1d1132a03de0aedca"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1graph__utils_1_1_p_p_m_writer.xhtml#ab469d593b4bc92e1d1132a03de0aedca">access_tensor</a> (<a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> &amp;tensor) override</td></tr>
 143 <tr class="memdesc:ab469d593b4bc92e1d1132a03de0aedca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented to access a given tensor.  <a href="#ab469d593b4bc92e1d1132a03de0aedca">More...</a><br/></td></tr>
 144 <tr class="separator:ab469d593b4bc92e1d1132a03de0aedca"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 <tr class="inherit_header pub_methods_classarm__compute_1_1graph_1_1_i_tensor_accessor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1graph_1_1_i_tensor_accessor')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1graph_1_1_i_tensor_accessor.xhtml">ITensorAccessor</a></td></tr>
 146 <tr class="memitem:a3c7f21c2eb00ab7ae1c18b1418c0d9c6 inherit pub_methods_classarm__compute_1_1graph_1_1_i_tensor_accessor"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1graph_1_1_i_tensor_accessor.xhtml#a3c7f21c2eb00ab7ae1c18b1418c0d9c6">~ITensorAccessor</a> ()=default</td></tr>
 147 <tr class="memdesc:a3c7f21c2eb00ab7ae1c18b1418c0d9c6 inherit pub_methods_classarm__compute_1_1graph_1_1_i_tensor_accessor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default virtual destructor.  <a href="#a3c7f21c2eb00ab7ae1c18b1418c0d9c6">More...</a><br/></td></tr>
 148 <tr class="separator:a3c7f21c2eb00ab7ae1c18b1418c0d9c6 inherit pub_methods_classarm__compute_1_1graph_1_1_i_tensor_accessor"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 </table>
 150 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 151 <div class="textblock"><p>PPM writer class. </p>
 152
 153 <p>Definition at line <a class="el" href="_graph_utils_8h_source.xhtml#l00035">35</a> of file <a class="el" href="_graph_utils_8h_source.xhtml">GraphUtils.h</a>.</p>
 154 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 155 <a class="anchor" id="a9ea94bf5b7d00ddb836df1b8dcedb93a"></a>
 156 <div class="memitem">
 157 <div class="memproto">
 158       <table class="memname">
 159         <tr>
 160           <td class="memname"><a class="el" href="classarm__compute_1_1graph__utils_1_1_p_p_m_writer.xhtml">PPMWriter</a> </td>
 161           <td>(</td>
 162           <td class="paramtype">std::string&#160;</td>
 163           <td class="paramname"><em>name</em>, </td>
 164         </tr>
 165         <tr>
 166           <td class="paramkey"></td>
 167           <td></td>
 168           <td class="paramtype">unsigned int&#160;</td>
 169           <td class="paramname"><em>maximum</em> = <code>1</code>&#160;</td>
 170         </tr>
 171         <tr>
 172           <td></td>
 173           <td>)</td>
 174           <td></td><td></td>
 175         </tr>
 176       </table>
 177 </div><div class="memdoc">
 178
 179 <p>Constructor. </p>
 180 <dl class="params"><dt>Parameters</dt><dd>
 181   <table class="params">
 182     <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>PPM file name </td></tr>
 183     <tr><td class="paramdir">[in]</td><td class="paramname">maximum</td><td>Maximum elements to access </td></tr>
 184   </table>
 185   </dd>
 186 </dl>
 187
 188 <p>Definition at line <a class="el" href="_graph_utils_8cpp_source.xhtml#l00040">40</a> of file <a class="el" href="_graph_utils_8cpp_source.xhtml">GraphUtils.cpp</a>.</p>
 189 <div class="fragment"><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    : _name(std::move(name)), _iterator(0), _maximum(maximum)</div>
 190 <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;{</div>
 191 <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;}</div>
 192 </div><!-- fragment -->
 193 </div>
 194 </div>
 195 <a class="anchor" id="a9f9290f4260c1d4ed6096988cf1423a8"></a>
 196 <div class="memitem">
 197 <div class="memproto">
 198 <table class="mlabels">
 199   <tr>
 200   <td class="mlabels-left">
 201       <table class="memname">
 202         <tr>
 203           <td class="memname"><a class="el" href="classarm__compute_1_1graph__utils_1_1_p_p_m_writer.xhtml">PPMWriter</a> </td>
 204           <td>(</td>
 205           <td class="paramtype"><a class="el" href="classarm__compute_1_1graph__utils_1_1_p_p_m_writer.xhtml">PPMWriter</a> &amp;&amp;&#160;</td>
 206           <td class="paramname"></td><td>)</td>
 207           <td></td>
 208         </tr>
 209       </table>
 210   </td>
 211   <td class="mlabels-right">
 212 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 213   </tr>
 214 </table>
 215 </div><div class="memdoc">
 216
 217 <p>Allows instances to move constructed. </p>
 218
 219 </div>
 220 </div>
 221 <h2 class="groupheader">Member Function Documentation</h2>
 222 <a class="anchor" id="ab469d593b4bc92e1d1132a03de0aedca"></a>
 223 <div class="memitem">
 224 <div class="memproto">
 225 <table class="mlabels">
 226   <tr>
 227   <td class="mlabels-left">
 228       <table class="memname">
 229         <tr>
 230           <td class="memname">bool access_tensor </td>
 231           <td>(</td>
 232           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> &amp;&#160;</td>
 233           <td class="paramname"><em>tensor</em></td><td>)</td>
 234           <td></td>
 235         </tr>
 236       </table>
 237   </td>
 238   <td class="mlabels-right">
 239 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 240   </tr>
 241 </table>
 242 </div><div class="memdoc">
 243
 244 <p>Interface to be implemented to access a given tensor. </p>
 245 <dl class="params"><dt>Parameters</dt><dd>
 246   <table class="params">
 247     <tr><td class="paramdir">[in]</td><td class="paramname">tensor</td><td><a class="el" href="classarm__compute_1_1_tensor.xhtml" title="Basic implementation of the tensor interface. ">Tensor</a> to be accessed</td></tr>
 248   </table>
 249   </dd>
 250 </dl>
 251 <dl class="section return"><dt>Returns</dt><dd>True if access is successful else false </dd></dl>
 252
 253 <p>Implements <a class="el" href="classarm__compute_1_1graph_1_1_i_tensor_accessor.xhtml#a497873c25847d7b4f60f37a1a3aa7665">ITensorAccessor</a>.</p>
 254
 255 <p>Definition at line <a class="el" href="_graph_utils_8cpp_source.xhtml#l00045">45</a> of file <a class="el" href="_graph_utils_8cpp_source.xhtml">GraphUtils.cpp</a>.</p>
 256
 257 <p>References <a class="el" href="utils_2_utils_8h_source.xhtml#l00281">arm_compute::utils::save_to_ppm()</a>.</p>
 258 <div class="fragment"><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;{</div>
 259 <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    std::stringstream ss;</div>
 260 <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    ss &lt;&lt; _name &lt;&lt; _iterator &lt;&lt; <span class="stringliteral">&quot;.ppm&quot;</span>;</div>
 261 <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <span class="keywordflow">if</span>(dynamic_cast&lt;Tensor *&gt;(&amp;tensor) != <span class="keyword">nullptr</span>)</div>
 262 <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    {</div>
 263 <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;        <a class="code" href="namespacearm__compute_1_1utils.xhtml#a301d0b7bfd70f73fc1924f4281938d08">arm_compute::utils::save_to_ppm</a>(dynamic_cast&lt;Tensor &amp;&gt;(tensor), ss.str());</div>
 264 <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    }</div>
 265 <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="preprocessor">#ifdef ARM_COMPUTE_CL</span></div>
 266 <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="preprocessor"></span>    <span class="keywordflow">else</span> <span class="keywordflow">if</span>(dynamic_cast&lt;CLTensor *&gt;(&amp;tensor) != <span class="keyword">nullptr</span>)</div>
 267 <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    {</div>
 268 <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;        <a class="code" href="namespacearm__compute_1_1utils.xhtml#a301d0b7bfd70f73fc1924f4281938d08">arm_compute::utils::save_to_ppm</a>(dynamic_cast&lt;CLTensor &amp;&gt;(tensor), ss.str());</div>
 269 <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    }</div>
 270 <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* ARM_COMPUTE_CL */</span><span class="preprocessor"></span></div>
 271 <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="preprocessor"></span></div>
 272 <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    _iterator++;</div>
 273 <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    <span class="keywordflow">if</span>(_maximum == 0)</div>
 274 <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    {</div>
 275 <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
 276 <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    }</div>
 277 <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    <span class="keywordflow">return</span> _iterator &lt; _maximum;</div>
 278 <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;}</div>
 279 <div class="ttc" id="namespacearm__compute_1_1utils_xhtml_a301d0b7bfd70f73fc1924f4281938d08"><div class="ttname"><a href="namespacearm__compute_1_1utils.xhtml#a301d0b7bfd70f73fc1924f4281938d08">arm_compute::utils::save_to_ppm</a></div><div class="ttdeci">void save_to_ppm(T &amp;tensor, const std::string &amp;ppm_filename)</div><div class="ttdoc">Template helper function to save a tensor image to a PPM file. </div><div class="ttdef"><b>Definition:</b> <a href="utils_2_utils_8h_source.xhtml#l00281">Utils.h:281</a></div></div>
 280 </div><!-- fragment -->
 281 </div>
 282 </div>
 283 <hr/>The documentation for this class was generated from the following files:<ul>
 284 <li>utils/<a class="el" href="_graph_utils_8h_source.xhtml">GraphUtils.h</a></li>
 285 <li>utils/<a class="el" href="_graph_utils_8cpp_source.xhtml">GraphUtils.cpp</a></li>
 286 </ul>
 287 </div><!-- contents -->
 288 </div><!-- doc-content -->
 289 <!-- start footer part -->
 290 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 291   <ul>
 292     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1graph__utils.xhtml">graph_utils</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1graph__utils_1_1_p_p_m_writer.xhtml">PPMWriter</a></li>
 293     <li class="footer">Generated on Thu Sep 28 2017 14:37:58 for Compute Library by
 294     <a href="http://www.doxygen.org/index.html">
 295     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
 296   </ul>
 297 </div>
 298 </body>
 299 </html>