arm_compute v17.04
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_access_window_vertical.xhtml
index 42e76ca..3b8efd4 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>
@@ -154,11 +154,14 @@ Public Member Functions</h2></td></tr>
 <tr class="separator:a21ab33d8ab185c1321f4c213335e6802 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a32733393d362ac5cd19a588bb248e5c6 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#a32733393d362ac5cd19a588bb248e5c6">~AccessWindowRectangle</a> ()=default</td></tr>
 <tr class="separator:a32733393d362ac5cd19a588bb248e5c6 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a6609a604373f053cdba95d701dc22958 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#a6609a604373f053cdba95d701dc22958">set_valid_region</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;window, <a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a> input_valid_region)</td></tr>
-<tr class="memdesc:a6609a604373f053cdba95d701dc22958 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the valid region based on access pattern and valid region of the inputs.  <a href="#a6609a604373f053cdba95d701dc22958">More...</a><br /></td></tr>
-<tr class="separator:a6609a604373f053cdba95d701dc22958 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a2164fd5c171ac4beb159f077210d369c inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#a2164fd5c171ac4beb159f077210d369c">set_valid_region</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;window, <a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a> input_valid_region, bool border_undefined, <a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> border_size) override</td></tr>
-<tr class="separator:a2164fd5c171ac4beb159f077210d369c inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a718cd06814abc688b1abdc729ed3a71b inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#a718cd06814abc688b1abdc729ed3a71b">set_valid_region</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;window, const <a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a> &amp;input_valid_region, bool border_undefined=false, const <a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> &amp;border_size=<a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a>(0))</td></tr>
+<tr class="memdesc:a718cd06814abc688b1abdc729ed3a71b inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the valid region based on access pattern, valid region of the inputs and border mode.  <a href="#a718cd06814abc688b1abdc729ed3a71b">More...</a><br /></td></tr>
+<tr class="separator:a718cd06814abc688b1abdc729ed3a71b inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a982d6e438dabc0d759d01464fe939cfd inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#a982d6e438dabc0d759d01464fe939cfd">compute_valid_region</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;window, const <a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a> &amp;input_valid_region) const </td></tr>
+<tr class="memdesc:a982d6e438dabc0d759d01464fe939cfd inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the valid region based on access pattern, valid region of the inputs and border mode.  <a href="#a982d6e438dabc0d759d01464fe939cfd">More...</a><br /></td></tr>
+<tr class="separator:a982d6e438dabc0d759d01464fe939cfd inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae80edc371ba9f02d756aed720040878b inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#ae80edc371ba9f02d756aed720040878b">compute_valid_region</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;window, <a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a> input_valid_region, bool border_undefined, <a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> border_size) const override</td></tr>
+<tr class="separator:ae80edc371ba9f02d756aed720040878b inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a7ad9fe991410dc3550f6c4fd6e87a708 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#a7ad9fe991410dc3550f6c4fd6e87a708">update_window_if_needed</a> (<a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;window) const override</td></tr>
 <tr class="memdesc:a7ad9fe991410dc3550f6c4fd6e87a708 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shrink the window if padding is not large enough.  <a href="#a7ad9fe991410dc3550f6c4fd6e87a708">More...</a><br /></td></tr>
 <tr class="separator:a7ad9fe991410dc3550f6c4fd6e87a708 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -172,7 +175,7 @@ Public Member Functions</h2></td></tr>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>Implementation of a column access pattern. </p>
 
-<p>Definition at line <a class="el" href="_i_access_window_8h_source.xhtml#l00174">174</a> of file <a class="el" href="_i_access_window_8h_source.xhtml">IAccessWindow.h</a>.</p>
+<p>Definition at line <a class="el" href="_i_access_window_8h_source.xhtml#l00184">184</a> of file <a class="el" href="_i_access_window_8h_source.xhtml">IAccessWindow.h</a>.</p>
 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 <a class="anchor" id="aeee936a7e64982bb0304daa9a80905ef"></a>
 <div class="memitem">
@@ -230,11 +233,11 @@ Public Member Functions</h2></td></tr>
   </dd>
 </dl>
 
-<p>Definition at line <a class="el" href="_i_access_window_8h_source.xhtml#l00186">186</a> of file <a class="el" href="_i_access_window_8h_source.xhtml">IAccessWindow.h</a>.</p>
+<p>Definition at line <a class="el" href="_i_access_window_8h_source.xhtml#l00196">196</a> of file <a class="el" href="_i_access_window_8h_source.xhtml">IAccessWindow.h</a>.</p>
 
 <p>References <a class="el" href="_error_8h_source.xhtml#l00100">ARM_COMPUTE_ERROR_ON</a>.</p>
-<div class="fragment"><div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;        : <a class="code" href="classarm__compute_1_1_access_window_rectangle.xhtml#ab188c1e89be24e1f21b045bc8818d706">AccessWindowRectangle</a>(info, 0, y, 1, height, 1.f, scale_y)</div><div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;    {</div><div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;        <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(height &lt; 0);</div><div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;        <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(scale_y &lt; 0);</div><div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;    }</div><div class="ttc" id="_error_8h_xhtml_a54a6080c9f4df1f908e57a9bbb46f5da"><div class="ttname"><a href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON(cond)</div><div class="ttdoc">If the condition is true then an error message is printed and an exception thrown. </div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00100">Error.h:100</a></div></div>
-<div class="ttc" id="classarm__compute_1_1_access_window_rectangle_xhtml_ab188c1e89be24e1f21b045bc8818d706"><div class="ttname"><a href="classarm__compute_1_1_access_window_rectangle.xhtml#ab188c1e89be24e1f21b045bc8818d706">arm_compute::AccessWindowRectangle::AccessWindowRectangle</a></div><div class="ttdeci">AccessWindowRectangle(TensorInfo *info, int x, int y, int width, int height)</div><div class="ttdoc">Constructor for a rectangular access pattern. </div><div class="ttdef"><b>Definition:</b> <a href="_i_access_window_8h_source.xhtml#l00113">IAccessWindow.h:113</a></div></div>
+<div class="fragment"><div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;        : <a class="code" href="classarm__compute_1_1_access_window_rectangle.xhtml#ab188c1e89be24e1f21b045bc8818d706">AccessWindowRectangle</a>(info, 0, y, 1, height, 1.f, scale_y)</div><div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;    {</div><div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;        <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(height &lt; 0);</div><div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;        <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(scale_y &lt; 0);</div><div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;    }</div><div class="ttc" id="_error_8h_xhtml_a54a6080c9f4df1f908e57a9bbb46f5da"><div class="ttname"><a href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON(cond)</div><div class="ttdoc">If the condition is true then an error message is printed and an exception thrown. </div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00100">Error.h:100</a></div></div>
+<div class="ttc" id="classarm__compute_1_1_access_window_rectangle_xhtml_ab188c1e89be24e1f21b045bc8818d706"><div class="ttname"><a href="classarm__compute_1_1_access_window_rectangle.xhtml#ab188c1e89be24e1f21b045bc8818d706">arm_compute::AccessWindowRectangle::AccessWindowRectangle</a></div><div class="ttdeci">AccessWindowRectangle(TensorInfo *info, int x, int y, int width, int height)</div><div class="ttdoc">Constructor for a rectangular access pattern. </div><div class="ttdef"><b>Definition:</b> <a href="_i_access_window_8h_source.xhtml#l00115">IAccessWindow.h:115</a></div></div>
 </div><!-- fragment -->
 </div>
 </div>
@@ -247,7 +250,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_access_window_vertical.xhtml">AccessWindowVertical</a></li>
-    <li class="footer">Generated on Fri Mar 24 2017 17:23:50 for ARM Compute Library by
+    <li class="footer">Generated on Wed Apr 12 2017 14:26:05 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>