arm_compute v17.04
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_pyramid_info.xhtml
index 6f55d43..1520559 100644 (file)
@@ -40,7 +40,7 @@
  <tr style="height: 56px;">
   <td style="padding-left: 0.5em;">
    <div id="projectname">ARM Compute Library
-   &#160;<span id="projectnumber">17.03.1</span>
+   &#160;<span id="projectnumber">17.04</span>
    </div>
   </td>
  </tr>
@@ -146,6 +146,12 @@ Public Member Functions</h2></td></tr>
 <tr class="memitem:a09f1ed0da3ccc973d44d1156aff150f9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a09f1ed0da3ccc973d44d1156aff150f9">operator=</a> (<a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> &amp;&amp;)=default</td></tr>
 <tr class="memdesc:a09f1ed0da3ccc973d44d1156aff150f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a09f1ed0da3ccc973d44d1156aff150f9">More...</a><br /></td></tr>
 <tr class="separator:a09f1ed0da3ccc973d44d1156aff150f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a6365834dc65fb5cc59cd17aea308db13"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a6365834dc65fb5cc59cd17aea308db13">PyramidInfo</a> (size_t <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a14af062b9f957e61e4efe171fe7065a3">num_levels</a>, float <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#ac0960069e9d05e0ee93ef010ce63913a">scale</a>, size_t <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a20646dd69e82674924c6e5eb1458eefa">width</a>, size_t <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#ac0e3c6ba1d3f8a8e50aa3e3897210a2b">height</a>, <a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a> <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a0c875a3203d902e2ad6bc3045355e69e">format</a>)</td></tr>
+<tr class="memdesc:a6365834dc65fb5cc59cd17aea308db13"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create pyramid info for 2D tensors.  <a href="#a6365834dc65fb5cc59cd17aea308db13">More...</a><br /></td></tr>
+<tr class="separator:a6365834dc65fb5cc59cd17aea308db13"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae79dbf996c991c72eee4f1d9122152ef"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#ae79dbf996c991c72eee4f1d9122152ef">PyramidInfo</a> (size_t <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a14af062b9f957e61e4efe171fe7065a3">num_levels</a>, float <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#ac0960069e9d05e0ee93ef010ce63913a">scale</a>, const <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;<a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#af3374fa8fcc6d226dc2b82317ab4d079">tensor_shape</a>, <a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a> <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a0c875a3203d902e2ad6bc3045355e69e">format</a>)</td></tr>
+<tr class="memdesc:ae79dbf996c991c72eee4f1d9122152ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create pyramid info using <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml" title="Shape of a tensor. ">TensorShape</a>.  <a href="#ae79dbf996c991c72eee4f1d9122152ef">More...</a><br /></td></tr>
+<tr class="separator:ae79dbf996c991c72eee4f1d9122152ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a741486bedb7b0966b1d4e6e7c6cccf60"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a741486bedb7b0966b1d4e6e7c6cccf60">init</a> (size_t <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a14af062b9f957e61e4efe171fe7065a3">num_levels</a>, float <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#ac0960069e9d05e0ee93ef010ce63913a">scale</a>, size_t <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a20646dd69e82674924c6e5eb1458eefa">width</a>, size_t <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#ac0e3c6ba1d3f8a8e50aa3e3897210a2b">height</a>, <a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a> <a class="el" href="classarm__compute_1_1_pyramid_info.xhtml#a0c875a3203d902e2ad6bc3045355e69e">format</a>)</td></tr>
 <tr class="memdesc:a741486bedb7b0966b1d4e6e7c6cccf60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize pyramid's metadata for 2D tensors.  <a href="#a741486bedb7b0966b1d4e6e7c6cccf60">More...</a><br /></td></tr>
 <tr class="separator:a741486bedb7b0966b1d4e6e7c6cccf60"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -270,6 +276,111 @@ Public Member Functions</h2></td></tr>
 
 </div>
 </div>
+<a class="anchor" id="a6365834dc65fb5cc59cd17aea308db13"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> </td>
+          <td>(</td>
+          <td class="paramtype">size_t&#160;</td>
+          <td class="paramname"><em>num_levels</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">float&#160;</td>
+          <td class="paramname"><em>scale</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">size_t&#160;</td>
+          <td class="paramname"><em>width</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">size_t&#160;</td>
+          <td class="paramname"><em>height</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a>&#160;</td>
+          <td class="paramname"><em>format</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Create pyramid info for 2D tensors. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[in]</td><td class="paramname">num_levels</td><td>The number of pyramid levels. This is required to be a non-zero value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">scale</td><td>Used to indicate the scale between the pyramid levels. This is required to be a non-zero positive value. </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>The width of the 2D tensor at 0th pyramid level </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>The height of the 2D tensor at 0th pyramid level </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>The format of all 2D tensors in the pyramid NV12, NV21, IYUV, UYVY and YUYV formats are not supported. </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<a class="anchor" id="ae79dbf996c991c72eee4f1d9122152ef"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a> </td>
+          <td>(</td>
+          <td class="paramtype">size_t&#160;</td>
+          <td class="paramname"><em>num_levels</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">float&#160;</td>
+          <td class="paramname"><em>scale</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;&#160;</td>
+          <td class="paramname"><em>tensor_shape</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a>&#160;</td>
+          <td class="paramname"><em>format</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Create pyramid info using <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml" title="Shape of a tensor. ">TensorShape</a>. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[in]</td><td class="paramname">num_levels</td><td>The number of pyramid levels. This is required to be a non-zero value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">scale</td><td>Used to indicate the scale between the pyramid levels. This is required to be a non-zero positive value. </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">tensor_shape</td><td>It specifies the size for each dimension of the tensor 0th pyramid level in number of elements </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>The format of all tensors in the pyramid </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
 <h2 class="groupheader">Member Function Documentation</h2>
 <a class="anchor" id="a0c875a3203d902e2ad6bc3045355e69e"></a>
 <div class="memitem">
@@ -545,7 +656,7 @@ Public Member Functions</h2></td></tr>
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_pyramid_info.xhtml">PyramidInfo</a></li>
-    <li class="footer">Generated on Fri Mar 24 2017 17:23:51 for ARM Compute Library by
+    <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
   </ul>