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">
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.11"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>ARM Compute Library: CLPhase 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="navtreedata.js"></script>
16 <script type="text/javascript" src="navtree.js"></script>
17 <script type="text/javascript">
18 $(document).ready(initResizable);
19 $(window).load(resizeHeight);
21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
22 <script type="text/javascript" src="search/searchdata.js"></script>
23 <script type="text/javascript" src="search/search.js"></script>
24 <script type="text/javascript">
25 $(document).ready(function() { init_search(); });
27 <script type="text/x-mathjax-config">
29 extensions: ["tex2jax.js"],
30 jax: ["input/TeX","output/HTML-CSS"],
32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
40 <tr style="height: 56px;">
41 <td style="padding-left: 0.5em;">
42 <div id="projectname">ARM Compute Library
43  <span id="projectnumber">17.03.1</span>
50 <!-- end header part -->
51 <!-- Generated by Doxygen 1.8.11 -->
52 <script type="text/javascript">
53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
55 <div id="navrow1" class="tabs">
57 <li><a href="index.xhtml"><span>Main Page</span></a></li>
58 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
59 <li class="current"><a href="annotated.xhtml"><span>Data Structures</span></a></li>
60 <li><a href="files.xhtml"><span>Files</span></a></li>
62 <div id="MSearchBox" class="MSearchBoxInactive">
64 <img id="MSearchSelect" src="search/mag_sel.png"
65 onmouseover="return searchBox.OnSearchSelectShow()"
66 onmouseout="return searchBox.OnSearchSelectHide()"
68 <input type="text" id="MSearchField" value="Search" accesskey="S"
69 onfocus="searchBox.OnSearchFieldFocus(true)"
70 onblur="searchBox.OnSearchFieldFocus(false)"
71 onkeyup="searchBox.OnSearchFieldChange(event)"/>
72 </span><span class="right">
73 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
79 <div id="navrow2" class="tabs2">
81 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
82 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
83 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
84 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
88 <div id="side-nav" class="ui-resizable side-nav-resizable">
90 <div id="nav-tree-contents">
91 <div id="nav-sync" class="sync"></div>
94 <div id="splitbar" style="-moz-user-select:none;"
95 class="ui-resizable-handle">
98 <script type="text/javascript">
99 $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_phase.xhtml','');});
101 <div id="doc-content">
102 <!-- window showing the filter options -->
103 <div id="MSearchSelectWindow"
104 onmouseover="return searchBox.OnSearchSelectShow()"
105 onmouseout="return searchBox.OnSearchSelectHide()"
106 onkeydown="return searchBox.OnSearchSelectKey(event)">
109 <!-- iframe showing the search results (closed by default) -->
110 <div id="MSearchResultsWindow">
111 <iframe src="javascript:void(0)" frameborder="0"
112 name="MSearchResults" id="MSearchResults">
117 <div class="summary">
118 <a href="#pub-methods">Public Member Functions</a> </div>
119 <div class="headertitle">
120 <div class="title">CLPhase Class Reference</div> </div>
122 <div class="contents">
124 <p>Basic function to execute an <a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml">CLMagnitudePhaseKernel</a>.
125 <a href="classarm__compute_1_1_c_l_phase.xhtml#details">More...</a></p>
127 <p><code>#include <<a class="el" href="_c_l_phase_8h_source.xhtml">CLPhase.h</a>></code></p>
128 <div class="dynheader">
129 Collaboration diagram for CLPhase:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_phase__coll__graph.svg" width="144" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
133 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
134 <table class="memberdecls">
135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
136 Public Member Functions</h2></td></tr>
137 <tr class="memitem:ac64385feb4cfd5ea1f7e2dc4414392aa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_phase.xhtml#ac64385feb4cfd5ea1f7e2dc4414392aa">configure</a> (const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *input1, const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *input2, <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *output, <a class="el" href="namespacearm__compute.xhtml#af00a42ecad444bbda75cde1b64bd7e72">PhaseType</a> phase_type=<a class="el" href="namespacearm__compute.xhtml#af00a42ecad444bbda75cde1b64bd7e72a6898b46a1cde8a1572e2722c44c5ab07">PhaseType::SIGNED</a>)</td></tr>
138 <tr class="memdesc:ac64385feb4cfd5ea1f7e2dc4414392aa"><td class="mdescLeft"> </td><td class="mdescRight">Initialise the kernel's inputs, output. <a href="#ac64385feb4cfd5ea1f7e2dc4414392aa">More...</a><br /></td></tr>
139 <tr class="separator:ac64385feb4cfd5ea1f7e2dc4414392aa"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_l_simple_function"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_l_simple_function')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_l_simple_function.xhtml">ICLSimpleFunction</a></td></tr>
141 <tr class="memitem:aa8149af857c4bface8ad712e418a63f1 inherit pub_methods_classarm__compute_1_1_i_c_l_simple_function"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_simple_function.xhtml#aa8149af857c4bface8ad712e418a63f1">ICLSimpleFunction</a> ()</td></tr>
142 <tr class="memdesc:aa8149af857c4bface8ad712e418a63f1 inherit pub_methods_classarm__compute_1_1_i_c_l_simple_function"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#aa8149af857c4bface8ad712e418a63f1">More...</a><br /></td></tr>
143 <tr class="separator:aa8149af857c4bface8ad712e418a63f1 inherit pub_methods_classarm__compute_1_1_i_c_l_simple_function"><td class="memSeparator" colspan="2"> </td></tr>
144 <tr class="memitem:ab5fd6e96c07aaaed2747c7e16ed5951e inherit pub_methods_classarm__compute_1_1_i_c_l_simple_function"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_simple_function.xhtml#ab5fd6e96c07aaaed2747c7e16ed5951e">run</a> () overridefinal</td></tr>
145 <tr class="memdesc:ab5fd6e96c07aaaed2747c7e16ed5951e inherit pub_methods_classarm__compute_1_1_i_c_l_simple_function"><td class="mdescLeft"> </td><td class="mdescRight">Run the kernels contained in the function. <a href="#ab5fd6e96c07aaaed2747c7e16ed5951e">More...</a><br /></td></tr>
146 <tr class="separator:ab5fd6e96c07aaaed2747c7e16ed5951e inherit pub_methods_classarm__compute_1_1_i_c_l_simple_function"><td class="memSeparator" colspan="2"> </td></tr>
147 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_function"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_function')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_function.xhtml">IFunction</a></td></tr>
148 <tr class="memitem:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_function.xhtml#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">~IFunction</a> ()=default</td></tr>
149 <tr class="memdesc:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">More...</a><br /></td></tr>
150 <tr class="separator:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2"> </td></tr>
152 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
153 <div class="textblock"><p>Basic function to execute an <a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml">CLMagnitudePhaseKernel</a>. </p>
155 <p>Definition at line <a class="el" href="_c_l_phase_8h_source.xhtml#l00035">35</a> of file <a class="el" href="_c_l_phase_8h_source.xhtml">CLPhase.h</a>.</p>
156 </div><h2 class="groupheader">Member Function Documentation</h2>
157 <a class="anchor" id="ac64385feb4cfd5ea1f7e2dc4414392aa"></a>
158 <div class="memitem">
159 <div class="memproto">
160 <table class="memname">
162 <td class="memname">void configure </td>
164 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> * </td>
165 <td class="paramname"><em>input1</em>, </td>
168 <td class="paramkey"></td>
170 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> * </td>
171 <td class="paramname"><em>input2</em>, </td>
174 <td class="paramkey"></td>
176 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> * </td>
177 <td class="paramname"><em>output</em>, </td>
180 <td class="paramkey"></td>
182 <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#af00a42ecad444bbda75cde1b64bd7e72">PhaseType</a> </td>
183 <td class="paramname"><em>phase_type</em> = <code><a class="el" href="namespacearm__compute.xhtml#af00a42ecad444bbda75cde1b64bd7e72a6898b46a1cde8a1572e2722c44c5ab07">PhaseType::SIGNED</a></code> </td>
191 </div><div class="memdoc">
193 <p>Initialise the kernel's inputs, output. </p>
194 <dl class="params"><dt>Parameters</dt><dd>
195 <table class="params">
196 <tr><td class="paramdir">[in]</td><td class="paramname">input1</td><td>First tensor input. Data types supported: S16. </td></tr>
197 <tr><td class="paramdir">[in]</td><td class="paramname">input2</td><td>Second tensor input. Data types supported: S16. </td></tr>
198 <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Output tensor. Data types supported: U8. </td></tr>
199 <tr><td class="paramdir">[in]</td><td class="paramname">phase_type</td><td>(Optional) Phase calculation type. Default: SIGNED. </td></tr>
206 <hr/>The documentation for this class was generated from the following file:<ul>
207 <li>arm_compute/runtime/CL/functions/<a class="el" href="_c_l_phase_8h_source.xhtml">CLPhase.h</a></li>
209 </div><!-- contents -->
210 </div><!-- doc-content -->
211 <!-- start footer part -->
212 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
214 <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_c_l_phase.xhtml">CLPhase</a></li>
215 <li class="footer">Generated on Fri Mar 24 2017 17:23:50 for ARM Compute Library by
216 <a href="http://www.doxygen.org/index.html">
217 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>