arm_compute v18.01
Change-Id: I9bfa178c2e38bfd5fc812e62aab6760d87748e05
diff --git a/documentation/neon__scale_8cpp.xhtml b/documentation/neon__scale_8cpp.xhtml
index 100277d..374c62d 100644
--- a/documentation/neon__scale_8cpp.xhtml
+++ b/documentation/neon__scale_8cpp.xhtml
@@ -40,7 +40,7 @@
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Compute Library
-  <span id="projectnumber">17.12</span>
+  <span id="projectnumber">18.01</span>
</div>
</td>
</tr>
@@ -127,14 +127,12 @@
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
-<tr class="memitem:a8311a04cc09fb45ff5126dc74b6c6dcb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="neon__scale_8cpp.xhtml#a8311a04cc09fb45ff5126dc74b6c6dcb">main_neon_scale</a> (int argc, const char **argv)</td></tr>
-<tr class="separator:a8311a04cc09fb45ff5126dc74b6c6dcb"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:a217dbf8b442f20279ea00b898af96f52"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="neon__scale_8cpp.xhtml#a217dbf8b442f20279ea00b898af96f52">main</a> (int argc, const char **argv)</td></tr>
-<tr class="memdesc:a217dbf8b442f20279ea00b898af96f52"><td class="mdescLeft"> </td><td class="mdescRight">Main program for convolution test. <a href="#a217dbf8b442f20279ea00b898af96f52">More...</a><br /></td></tr>
-<tr class="separator:a217dbf8b442f20279ea00b898af96f52"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a3c04138a5bfe5d72780bb7e82a18e627"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="neon__scale_8cpp.xhtml#a3c04138a5bfe5d72780bb7e82a18e627">main</a> (int argc, char **argv)</td></tr>
+<tr class="memdesc:a3c04138a5bfe5d72780bb7e82a18e627"><td class="mdescLeft"> </td><td class="mdescRight">Main program for convolution test. <a href="#a3c04138a5bfe5d72780bb7e82a18e627">More...</a><br /></td></tr>
+<tr class="separator:a3c04138a5bfe5d72780bb7e82a18e627"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
-<a class="anchor" id="a217dbf8b442f20279ea00b898af96f52"></a>
+<a class="anchor" id="a3c04138a5bfe5d72780bb7e82a18e627"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -147,7 +145,7 @@
<tr>
<td class="paramkey"></td>
<td></td>
- <td class="paramtype">const char ** </td>
+ <td class="paramtype">char ** </td>
<td class="paramname"><em>argv</em> </td>
</tr>
<tr>
@@ -167,57 +165,8 @@
</dd>
</dl>
-<p>Definition at line <a class="el" href="neon__scale_8cpp_source.xhtml#l00087">87</a> of file <a class="el" href="neon__scale_8cpp_source.xhtml">neon_scale.cpp</a>.</p>
-
-<p>References <a class="el" href="neon__scale_8cpp_source.xhtml#l00032">main_neon_scale()</a>, and <a class="el" href="utils_2_utils_8cpp_source.xhtml#l00069">arm_compute::utils::run_example()</a>.</p>
-<div class="fragment"><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> {</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">return</span> <a class="code" href="namespacearm__compute_1_1utils.xhtml#a4c9395db2c8b8d0c336656a7b58fca3e">utils::run_example</a>(argc, argv, <a class="code" href="neon__scale_8cpp.xhtml#a8311a04cc09fb45ff5126dc74b6c6dcb">main_neon_scale</a>);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> }</div><div class="ttc" id="namespacearm__compute_1_1utils_xhtml_a4c9395db2c8b8d0c336656a7b58fca3e"><div class="ttname"><a href="namespacearm__compute_1_1utils.xhtml#a4c9395db2c8b8d0c336656a7b58fca3e">arm_compute::utils::run_example</a></div><div class="ttdeci">int run_example(int argc, const char **argv, example &func)</div><div class="ttdoc">Run an example and handle the potential exceptions it throws. </div><div class="ttdef"><b>Definition:</b> <a href="utils_2_utils_8cpp_source.xhtml#l00069">Utils.cpp:69</a></div></div>
-<div class="ttc" id="neon__scale_8cpp_xhtml_a8311a04cc09fb45ff5126dc74b6c6dcb"><div class="ttname"><a href="neon__scale_8cpp.xhtml#a8311a04cc09fb45ff5126dc74b6c6dcb">main_neon_scale</a></div><div class="ttdeci">void main_neon_scale(int argc, const char **argv)</div><div class="ttdef"><b>Definition:</b> <a href="neon__scale_8cpp_source.xhtml#l00032">neon_scale.cpp:32</a></div></div>
-</div><!-- fragment -->
-</div>
-</div>
-<a class="anchor" id="a8311a04cc09fb45ff5126dc74b6c6dcb"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void main_neon_scale </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>argc</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char ** </td>
- <td class="paramname"><em>argv</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
-</div><div class="memdoc">
-
-<p>Definition at line <a class="el" href="neon__scale_8cpp_source.xhtml#l00032">32</a> of file <a class="el" href="neon__scale_8cpp_source.xhtml">neon_scale.cpp</a>.</p>
-
-<p>References <a class="el" href="classarm__compute_1_1_n_e_scale.xhtml#aca08ed3f0e23d0eb32f60dc8a468bb4b">NEScale::configure()</a>, <a class="el" href="validation_2_n_e_o_n_2_g_e_m_m_8cpp_source.xhtml#l00118">arm_compute::test::validation::dst</a>, <a class="el" href="utils_2_utils_8h_source.xhtml#l00296">PPMLoader::fill_image()</a>, <a class="el" href="utils_2_utils_8h_source.xhtml#l00279">PPMLoader::init_image()</a>, <a class="el" href="utils_2_utils_8h_source.xhtml#l00268">PPMLoader::is_open()</a>, <a class="el" href="namespacearm__compute.xhtml#a966a9c417ce5e94dca08d9b5e745c0c9a7f5ccbc3d30c2cd3fd04d567946cbde2">arm_compute::NEAREST_NEIGHBOR</a>, <a class="el" href="utils_2_utils_8h_source.xhtml#l00248">PPMLoader::open()</a>, <a class="el" href="classarm__compute_1_1_n_e_scale.xhtml#ad1717410afd0be936c6213a63c8005fb">NEScale::run()</a>, <a class="el" href="utils_2_utils_8h_source.xhtml#l00639">arm_compute::utils::save_to_ppm()</a>, <a class="el" href="_n_e_o_n_2_pixel_wise_multiplication_8cpp_source.xhtml#l00176">arm_compute::test::validation::scale</a>, <a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58a6669348b484e3008dca2bfa8e85e40b5">arm_compute::U8</a>, and <a class="el" href="namespacearm__compute.xhtml#a15a05537a472ee742404821851529327a0db45d2a4141101bdfe48e3314cfbca3">arm_compute::UNDEFINED</a>.</p>
-
-<p>Referenced by <a class="el" href="neon__scale_8cpp_source.xhtml#l00087">main()</a>.</p>
-<div class="fragment"><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="classarm__compute_1_1utils_1_1_p_p_m_loader.xhtml">PPMLoader</a> ppm;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <a class="code" href="struct_image.xhtml">Image</a> src, <a class="code" href="namespacearm__compute_1_1test_1_1validation.xhtml#adbf67dcee294e673cf796f1ed8aeb6a4">dst</a>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordflow">if</span>(argc < 2)</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="comment">// Print help</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  std::cout << <span class="stringliteral">"Usage: ./build/neon_scale[input_image.ppm]\n\n"</span>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  std::cout << <span class="stringliteral">"No input_image provided, creating a dummy 640x480 image\n"</span>;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// Create an empty grayscale 640x480 image</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  src.allocator()->init(<a class="code" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a>(640, 480, Format::U8));</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  }</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  ppm.<a class="code" href="classarm__compute_1_1utils_1_1_p_p_m_loader.xhtml#a36e58f3e64f3851ebac7a9556b4704ed">open</a>(argv[1]);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  ppm.<a class="code" href="classarm__compute_1_1utils_1_1_p_p_m_loader.xhtml#a69f2a0e263d4f77d1e166de9cd2746f7">init_image</a>(src, Format::U8);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  }</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  constexpr <span class="keywordtype">int</span> scale_factor = 2;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a> dst_tensor_info(src.info()->dimension(0) / scale_factor, src.info()->dimension(1) / scale_factor, Format::U8);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// Configure the destination image</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  dst.allocator()->init(dst_tensor_info);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// Create and initialize a Scale function object:</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="classarm__compute_1_1_n_e_scale.xhtml">NEScale</a> <a class="code" href="namespacearm__compute_1_1test_1_1validation.xhtml#acec6d8ad52a28972fa74e071c1a63b6a">scale</a>;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  scale.<a class="code" href="classarm__compute_1_1_n_e_scale.xhtml#aca08ed3f0e23d0eb32f60dc8a468bb4b">configure</a>(&src, &dst, InterpolationPolicy::NEAREST_NEIGHBOR, BorderMode::UNDEFINED);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment">// Allocate all the images</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  src.allocator()->allocate();</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  dst.allocator()->allocate();</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">// Fill the input image with the content of the PPM image if a filename was provided:</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">if</span>(ppm.<a class="code" href="classarm__compute_1_1utils_1_1_p_p_m_loader.xhtml#a2f57f54d8c03b615bb31eee091d8a88a">is_open</a>())</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  {</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  ppm.<a class="code" href="classarm__compute_1_1utils_1_1_p_p_m_loader.xhtml#a1672610b872bef30d0dc2333a0ffc402">fill_image</a>(src);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  }</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">// Run the scale operation:</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  scale.<a class="code" href="classarm__compute_1_1_n_e_scale.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a>();</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// Save the result to file:</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">if</span>(ppm.<a class="code" href="classarm__compute_1_1utils_1_1_p_p_m_loader.xhtml#a2f57f54d8c03b615bb31eee091d8a88a">is_open</a>())</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  {</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">const</span> std::string output_filename = std::string(argv[1]) + <span class="stringliteral">"_out.ppm"</span>;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="namespacearm__compute_1_1utils.xhtml#a301d0b7bfd70f73fc1924f4281938d08">save_to_ppm</a>(dst, output_filename);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> }</div><div class="ttc" id="classarm__compute_1_1utils_1_1_p_p_m_loader_xhtml_a1672610b872bef30d0dc2333a0ffc402"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_p_p_m_loader.xhtml#a1672610b872bef30d0dc2333a0ffc402">arm_compute::utils::PPMLoader::fill_image</a></div><div class="ttdeci">void fill_image(T &image)</div><div class="ttdoc">Fill an image with the content of the currently open PPM file. </div><div class="ttdef"><b>Definition:</b> <a href="utils_2_utils_8h_source.xhtml#l00296">Utils.h:296</a></div></div>
-<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 &tensor, const std::string &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#l00639">Utils.h:639</a></div></div>
-<div class="ttc" id="classarm__compute_1_1_n_e_scale_xhtml"><div class="ttname"><a href="classarm__compute_1_1_n_e_scale.xhtml">arm_compute::NEScale</a></div><div class="ttdoc">Basic function to run NEScaleKernel. </div><div class="ttdef"><b>Definition:</b> <a href="_n_e_scale_8h_source.xhtml#l00040">NEScale.h:40</a></div></div>
-<div class="ttc" id="classarm__compute_1_1utils_1_1_p_p_m_loader_xhtml_a36e58f3e64f3851ebac7a9556b4704ed"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_p_p_m_loader.xhtml#a36e58f3e64f3851ebac7a9556b4704ed">arm_compute::utils::PPMLoader::open</a></div><div class="ttdeci">void open(const std::string &ppm_filename)</div><div class="ttdoc">Open a PPM file and reads its metadata (Width, height) </div><div class="ttdef"><b>Definition:</b> <a href="utils_2_utils_8h_source.xhtml#l00248">Utils.h:248</a></div></div>
-<div class="ttc" id="classarm__compute_1_1utils_1_1_p_p_m_loader_xhtml_a2f57f54d8c03b615bb31eee091d8a88a"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_p_p_m_loader.xhtml#a2f57f54d8c03b615bb31eee091d8a88a">arm_compute::utils::PPMLoader::is_open</a></div><div class="ttdeci">bool is_open()</div><div class="ttdoc">Return true if a PPM file is currently open. </div><div class="ttdef"><b>Definition:</b> <a href="utils_2_utils_8h_source.xhtml#l00268">Utils.h:268</a></div></div>
-<div class="ttc" id="namespacearm__compute_1_1test_1_1validation_xhtml_adbf67dcee294e673cf796f1ed8aeb6a4"><div class="ttname"><a href="namespacearm__compute_1_1test_1_1validation.xhtml#adbf67dcee294e673cf796f1ed8aeb6a4">arm_compute::test::validation::dst</a></div><div class="ttdeci">Tensor dst</div><div class="ttdef"><b>Definition:</b> <a href="validation_2_n_e_o_n_2_g_e_m_m_8cpp_source.xhtml#l00118">GEMM.cpp:118</a></div></div>
-<div class="ttc" id="struct_image_xhtml"><div class="ttname"><a href="struct_image.xhtml">Image</a></div><div class="ttdoc">Structure to hold Image information. </div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00140">helpers.h:140</a></div></div>
-<div class="ttc" id="classarm__compute_1_1_n_e_scale_xhtml_aca08ed3f0e23d0eb32f60dc8a468bb4b"><div class="ttname"><a href="classarm__compute_1_1_n_e_scale.xhtml#aca08ed3f0e23d0eb32f60dc8a468bb4b">arm_compute::NEScale::configure</a></div><div class="ttdeci">void configure(ITensor *input, ITensor *output, InterpolationPolicy policy, BorderMode border_mode, PixelValue constant_border_value=PixelValue(), SamplingPolicy sampling_policy=SamplingPolicy::CENTER)</div><div class="ttdoc">Initialize the function&#39;s source, destination, interpolation type and border_mode. </div></div>
-<div class="ttc" id="classarm__compute_1_1_n_e_scale_xhtml_ad1717410afd0be936c6213a63c8005fb"><div class="ttname"><a href="classarm__compute_1_1_n_e_scale.xhtml#ad1717410afd0be936c6213a63c8005fb">arm_compute::NEScale::run</a></div><div class="ttdeci">void run() override</div><div class="ttdoc">Run the kernels contained in the function. </div></div>
-<div class="ttc" id="namespacearm__compute_1_1test_1_1validation_xhtml_acec6d8ad52a28972fa74e071c1a63b6a"><div class="ttname"><a href="namespacearm__compute_1_1test_1_1validation.xhtml#acec6d8ad52a28972fa74e071c1a63b6a">arm_compute::test::validation::scale</a></div><div class="ttdeci">scale</div><div class="ttdef"><b>Definition:</b> <a href="_n_e_o_n_2_pixel_wise_multiplication_8cpp_source.xhtml#l00176">PixelWiseMultiplication.cpp:176</a></div></div>
-<div class="ttc" id="classarm__compute_1_1_tensor_info_xhtml"><div class="ttname"><a href="classarm__compute_1_1_tensor_info.xhtml">arm_compute::TensorInfo</a></div><div class="ttdoc">Store the tensor&#39;s metadata. </div><div class="ttdef"><b>Definition:</b> <a href="_tensor_info_8h_source.xhtml#l00044">TensorInfo.h:44</a></div></div>
-<div class="ttc" id="classarm__compute_1_1utils_1_1_p_p_m_loader_xhtml_a69f2a0e263d4f77d1e166de9cd2746f7"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_p_p_m_loader.xhtml#a69f2a0e263d4f77d1e166de9cd2746f7">arm_compute::utils::PPMLoader::init_image</a></div><div class="ttdeci">void init_image(T &image, arm_compute::Format format)</div><div class="ttdoc">Initialise an image&#39;s metadata with the dimensions of the PPM file currently open. </div><div class="ttdef"><b>Definition:</b> <a href="utils_2_utils_8h_source.xhtml#l00279">Utils.h:279</a></div></div>
-<div class="ttc" id="classarm__compute_1_1utils_1_1_p_p_m_loader_xhtml"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_p_p_m_loader.xhtml">arm_compute::utils::PPMLoader</a></div><div class="ttdoc">Class to load the content of a PPM file into an Image. </div><div class="ttdef"><b>Definition:</b> <a href="utils_2_utils_8h_source.xhtml#l00237">Utils.h:237</a></div></div>
-</div><!-- fragment -->
+<p>Definition at line <a class="el" href="neon__scale_8cpp_source.xhtml#l00100">100</a> of file <a class="el" href="neon__scale_8cpp_source.xhtml">neon_scale.cpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> {</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordflow">return</span> utils::run_example<NEONScaleExample>(argc, argv);</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> }</div></div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
@@ -226,7 +175,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d28a4824dc47e487b107a5db32ef43c4.xhtml">examples</a></li><li class="navelem"><a class="el" href="neon__scale_8cpp.xhtml">neon_scale.cpp</a></li>
- <li class="footer">Generated on Thu Dec 14 2017 23:48:33 for Compute Library by
+ <li class="footer">Generated on Wed Jan 24 2018 14:30:42 for 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>