File: viennacl-info_8cpp-example.html

package info (click to toggle)
viennacl 1.7.1%2Bdfsg1-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid, trixie
  • size: 114,428 kB
  • sloc: sh: 454,206; cpp: 109,088; ansic: 2,103; perl: 104; makefile: 22
file content (243 lines) | stat: -rw-r--r-- 19,508 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>ViennaCL - The Vienna Computing Library: viennacl-info.cpp</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">ViennaCL - The Vienna Computing Library
   &#160;<span id="projectnumber">1.7.1</span>
   </div>
   <div id="projectbrief">Free open-source GPU-accelerated linear algebra and solver library.</div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('viennacl-info_8cpp-example.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<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>Classes</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>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">viennacl-info.cpp</div>  </div>
</div><!--header-->
<div class="contents">
<p>This tutorial prints informations about the OpenCL backend and therefore only works with OpenCL enabled. See the <a class="el" href="classviennacl_1_1ocl_1_1device.html" title="A class representing a compute device (e.g. a GPU) ">viennacl::ocl::device</a> class for full information about which information can be queried from devices.</p>
<p>We start with including required headers: </p>
<div class="fragment"><div class="line"><span class="comment">// include necessary system headers</span></div>
<div class="line"><span class="preprocessor">#include &lt;iostream&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;cstdlib&gt;</span></div>
<div class="line"></div>
<div class="line"><span class="comment">//include ViennaCL headers</span></div>
<div class="line"><span class="preprocessor">#include &quot;<a class="code" href="device_8hpp.html">viennacl/ocl/device.hpp</a>&quot;</span></div>
<div class="line"><span class="preprocessor">#include &quot;<a class="code" href="platform_8hpp.html">viennacl/ocl/platform.hpp</a>&quot;</span></div>
<div class="line"><span class="preprocessor">#include &quot;<a class="code" href="device__specific_2builtin__database_2common_8hpp.html">viennacl/device_specific/builtin_database/common.hpp</a>&quot;</span></div>
</div><!-- fragment --><p> In the <a class="el" href="tests_2src_2bisect_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a> routine we iterate over all OpenCL platforms and print the full device information for each OpenCL device found. </p>
<div class="fragment"><div class="line"><span class="keywordtype">int</span> <a name="a0"></a><a class="code" href="tests_2src_2bisect_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>()</div>
<div class="line">{</div>
</div><!-- fragment --><p> Retrieve the platforms and iterate: </p>
<div class="fragment"><div class="line"><span class="keyword">typedef</span> std::vector&lt; viennacl::ocl::platform &gt; platforms_type;</div>
<div class="line">platforms_type platforms = <a name="a1"></a><a class="code" href="namespaceviennacl_1_1ocl.html#ae1e931f6efd155240b33ca440dfcfef5">viennacl::ocl::get_platforms</a>();</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">bool</span> is_first_element = <span class="keyword">true</span>;</div>
<div class="line"><span class="keywordflow">for</span> (platforms_type::iterator platform_iter  = platforms.begin();</div>
<div class="line">                              platform_iter != platforms.end();</div>
<div class="line">                            ++platform_iter)</div>
<div class="line">{</div>
<div class="line">  <span class="keyword">typedef</span> std::vector&lt;viennacl::ocl::device&gt; devices_type;</div>
<div class="line">  devices_type devices = platform_iter-&gt;devices(CL_DEVICE_TYPE_ALL);</div>
</div><!-- fragment --><p> Print some platform information </p>
<div class="fragment"><div class="line">std::cout &lt;&lt; <span class="stringliteral">&quot;# =========================================&quot;</span> &lt;&lt; std::endl;</div>
<div class="line">std::cout &lt;&lt; <span class="stringliteral">&quot;#         Platform Information             &quot;</span> &lt;&lt; std::endl;</div>
<div class="line">std::cout &lt;&lt; <span class="stringliteral">&quot;# =========================================&quot;</span> &lt;&lt; std::endl;</div>
<div class="line"></div>
<div class="line">std::cout &lt;&lt; <span class="stringliteral">&quot;#&quot;</span> &lt;&lt; std::endl;</div>
<div class="line">std::cout &lt;&lt; <span class="stringliteral">&quot;# Vendor and version: &quot;</span> &lt;&lt; platform_iter-&gt;info() &lt;&lt; std::endl;</div>
<div class="line">std::cout &lt;&lt; <span class="stringliteral">&quot;#&quot;</span> &lt;&lt; std::endl;</div>
<div class="line"></div>
<div class="line"><span class="keywordflow">if</span> (is_first_element)</div>
<div class="line">{</div>
<div class="line">  std::cout &lt;&lt; <span class="stringliteral">&quot;# ViennaCL uses this OpenCL platform by default.&quot;</span> &lt;&lt; std::endl;</div>
<div class="line">  is_first_element = <span class="keyword">false</span>;</div>
<div class="line">}</div>
</div><!-- fragment --><p> Traverse the devices and print all information available using the convenience member function full_info(): </p>
<div class="fragment"><div class="line">    std::cout &lt;&lt; <span class="stringliteral">&quot;# &quot;</span> &lt;&lt; std::endl;</div>
<div class="line">    std::cout &lt;&lt; <span class="stringliteral">&quot;# Available Devices: &quot;</span> &lt;&lt; std::endl;</div>
<div class="line">    std::cout &lt;&lt; <span class="stringliteral">&quot;# &quot;</span> &lt;&lt; std::endl;</div>
<div class="line">    <span class="keywordflow">for</span> (devices_type::iterator iter = devices.begin(); iter != devices.end(); iter++)</div>
<div class="line">    {</div>
<div class="line">      std::cout &lt;&lt; std::endl;</div>
<div class="line"></div>
<div class="line">      std::cout &lt;&lt; <span class="stringliteral">&quot;  -----------------------------------------&quot;</span> &lt;&lt; std::endl;</div>
<div class="line">      std::cout &lt;&lt; iter-&gt;full_info();</div>
<div class="line">      std::cout &lt;&lt; <span class="stringliteral">&quot;ViennaCL Device Architecture:  &quot;</span> &lt;&lt; iter-&gt;architecture_family() &lt;&lt; std::endl;</div>
<div class="line">      std::cout &lt;&lt; <span class="stringliteral">&quot;ViennaCL Database Mapped Name: &quot;</span> &lt;&lt; <a name="a2"></a><a class="code" href="namespaceviennacl_1_1device__specific_1_1builtin__database.html#a95ff5245e4bc95912528d86219bb8bde">viennacl::device_specific::builtin_database::get_mapped_device_name</a>(iter-&gt;name(), iter-&gt;vendor_id()) &lt;&lt; std::endl;</div>
<div class="line">      std::cout &lt;&lt; <span class="stringliteral">&quot;  -----------------------------------------&quot;</span> &lt;&lt; std::endl;</div>
<div class="line">    }</div>
<div class="line">    std::cout &lt;&lt; std::endl;</div>
<div class="line">    std::cout &lt;&lt; <span class="stringliteral">&quot;###########################################&quot;</span> &lt;&lt; std::endl;</div>
<div class="line">    std::cout &lt;&lt; std::endl;</div>
<div class="line">  }</div>
<div class="line"></div>
<div class="line">  <span class="keywordflow">return</span> EXIT_SUCCESS;</div>
<div class="line">}</div>
</div><!-- fragment --> <h2>Full Example Code</h2>
<div class="fragment"><div class="line"><span class="comment">/* =========================================================================</span></div>
<div class="line"><span class="comment">   Copyright (c) 2010-2016, Institute for Microelectronics,</span></div>
<div class="line"><span class="comment">                            Institute for Analysis and Scientific Computing,</span></div>
<div class="line"><span class="comment">                            TU Wien.</span></div>
<div class="line"><span class="comment">   Portions of this software are copyright by UChicago Argonne, LLC.</span></div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">                            -----------------</span></div>
<div class="line"><span class="comment">                  ViennaCL - The Vienna Computing Library</span></div>
<div class="line"><span class="comment">                            -----------------</span></div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">   Project Head:    Karl Rupp                   rupp@iue.tuwien.ac.at</span></div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">   (A list of authors and contributors can be found in the PDF manual)</span></div>
<div class="line"><span class="comment"></span></div>
<div class="line"><span class="comment">   License:         MIT (X11), see file LICENSE in the base directory</span></div>
<div class="line"><span class="comment">============================================================================= */</span></div>
<div class="line"></div>
<div class="line"><span class="comment">// include necessary system headers</span></div>
<div class="line"><span class="preprocessor">#include &lt;iostream&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;cstdlib&gt;</span></div>
<div class="line"></div>
<div class="line"><span class="comment">//include ViennaCL headers</span></div>
<div class="line"><span class="preprocessor">#include &quot;<a class="code" href="device_8hpp.html">viennacl/ocl/device.hpp</a>&quot;</span></div>
<div class="line"><span class="preprocessor">#include &quot;<a class="code" href="platform_8hpp.html">viennacl/ocl/platform.hpp</a>&quot;</span></div>
<div class="line"><span class="preprocessor">#include &quot;<a class="code" href="device__specific_2builtin__database_2common_8hpp.html">viennacl/device_specific/builtin_database/common.hpp</a>&quot;</span></div>
<div class="line"></div>
<div class="line"><span class="keywordtype">int</span> <a class="code" href="tests_2src_2bisect_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>()</div>
<div class="line">{</div>
<div class="line">  <span class="keyword">typedef</span> std::vector&lt; viennacl::ocl::platform &gt; platforms_type;</div>
<div class="line">  platforms_type platforms = <a class="code" href="namespaceviennacl_1_1ocl.html#ae1e931f6efd155240b33ca440dfcfef5">viennacl::ocl::get_platforms</a>();</div>
<div class="line"></div>
<div class="line">  <span class="keywordtype">bool</span> is_first_element = <span class="keyword">true</span>;</div>
<div class="line">  <span class="keywordflow">for</span> (platforms_type::iterator platform_iter  = platforms.begin();</div>
<div class="line">                                platform_iter != platforms.end();</div>
<div class="line">                              ++platform_iter)</div>
<div class="line">  {</div>
<div class="line">    <span class="keyword">typedef</span> std::vector&lt;viennacl::ocl::device&gt; devices_type;</div>
<div class="line">    devices_type devices = platform_iter-&gt;devices(CL_DEVICE_TYPE_ALL);</div>
<div class="line"></div>
<div class="line">    std::cout &lt;&lt; <span class="stringliteral">&quot;# =========================================&quot;</span> &lt;&lt; std::endl;</div>
<div class="line">    std::cout &lt;&lt; <span class="stringliteral">&quot;#         Platform Information             &quot;</span> &lt;&lt; std::endl;</div>
<div class="line">    std::cout &lt;&lt; <span class="stringliteral">&quot;# =========================================&quot;</span> &lt;&lt; std::endl;</div>
<div class="line"></div>
<div class="line">    std::cout &lt;&lt; <span class="stringliteral">&quot;#&quot;</span> &lt;&lt; std::endl;</div>
<div class="line">    std::cout &lt;&lt; <span class="stringliteral">&quot;# Vendor and version: &quot;</span> &lt;&lt; platform_iter-&gt;info() &lt;&lt; std::endl;</div>
<div class="line">    std::cout &lt;&lt; <span class="stringliteral">&quot;#&quot;</span> &lt;&lt; std::endl;</div>
<div class="line"></div>
<div class="line">    <span class="keywordflow">if</span> (is_first_element)</div>
<div class="line">    {</div>
<div class="line">      std::cout &lt;&lt; <span class="stringliteral">&quot;# ViennaCL uses this OpenCL platform by default.&quot;</span> &lt;&lt; std::endl;</div>
<div class="line">      is_first_element = <span class="keyword">false</span>;</div>
<div class="line">    }</div>
<div class="line"></div>
<div class="line"></div>
<div class="line">    std::cout &lt;&lt; <span class="stringliteral">&quot;# &quot;</span> &lt;&lt; std::endl;</div>
<div class="line">    std::cout &lt;&lt; <span class="stringliteral">&quot;# Available Devices: &quot;</span> &lt;&lt; std::endl;</div>
<div class="line">    std::cout &lt;&lt; <span class="stringliteral">&quot;# &quot;</span> &lt;&lt; std::endl;</div>
<div class="line">    <span class="keywordflow">for</span> (devices_type::iterator iter = devices.begin(); iter != devices.end(); iter++)</div>
<div class="line">    {</div>
<div class="line">      std::cout &lt;&lt; std::endl;</div>
<div class="line"></div>
<div class="line">      std::cout &lt;&lt; <span class="stringliteral">&quot;  -----------------------------------------&quot;</span> &lt;&lt; std::endl;</div>
<div class="line">      std::cout &lt;&lt; iter-&gt;full_info();</div>
<div class="line">      std::cout &lt;&lt; <span class="stringliteral">&quot;ViennaCL Device Architecture:  &quot;</span> &lt;&lt; iter-&gt;architecture_family() &lt;&lt; std::endl;</div>
<div class="line">      std::cout &lt;&lt; <span class="stringliteral">&quot;ViennaCL Database Mapped Name: &quot;</span> &lt;&lt; <a class="code" href="namespaceviennacl_1_1device__specific_1_1builtin__database.html#a95ff5245e4bc95912528d86219bb8bde">viennacl::device_specific::builtin_database::get_mapped_device_name</a>(iter-&gt;name(), iter-&gt;vendor_id()) &lt;&lt; std::endl;</div>
<div class="line">      std::cout &lt;&lt; <span class="stringliteral">&quot;  -----------------------------------------&quot;</span> &lt;&lt; std::endl;</div>
<div class="line">    }</div>
<div class="line">    std::cout &lt;&lt; std::endl;</div>
<div class="line">    std::cout &lt;&lt; <span class="stringliteral">&quot;###########################################&quot;</span> &lt;&lt; std::endl;</div>
<div class="line">    std::cout &lt;&lt; std::endl;</div>
<div class="line">  }</div>
<div class="line"></div>
<div class="line">  <span class="keywordflow">return</span> EXIT_SUCCESS;</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"></div>
<div class="line"></div>
</div><!-- fragment --> </div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated on Wed Jan 20 2016 22:32:38 for ViennaCL - The Vienna Computing Library by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>