<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="Source to the Rust file `/Users/travis/.cargo/git/checkouts/ocl-21810c0a37a638dd/c345b5b/ocl/src/standard/pro_que.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>pro_que.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../../../dark.css">
<link rel="stylesheet" type="text/css" href="../../../main.css" id="themeStyle">
<script src="../../../storage.js"></script>
</head>
<body class="rustdoc source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">☰</div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../../../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../../../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
</pre><pre class="rust ">
<span class="doccomment">//! A convenient wrapper for `Program` and `Queue`.</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ops</span>::<span class="ident">Deref</span>;
<span class="kw">use</span> <span class="ident">error</span>::{<span class="ident">Error</span> <span class="kw">as</span> <span class="ident">OclError</span>, <span class="prelude-ty">Result</span> <span class="kw">as</span> <span class="ident">OclResult</span>};
<span class="kw">use</span> <span class="ident">core</span>::{<span class="ident">OclPrm</span>, <span class="ident">CommandQueueProperties</span>};
<span class="kw">use</span> <span class="ident">standard</span>::{<span class="ident">Platform</span>, <span class="ident">Device</span>, <span class="ident">Context</span>, <span class="ident">ProgramBuilder</span>, <span class="ident">Program</span>, <span class="ident">Queue</span>, <span class="ident">Kernel</span>, <span class="ident">Buffer</span>,
<span class="ident">MemLen</span>, <span class="ident">SpatialDims</span>, <span class="ident">WorkDims</span>, <span class="ident">DeviceSpecifier</span>, <span class="ident">KernelBuilder</span>, <span class="ident">BufferBuilder</span>};
<span class="kw">static</span> <span class="ident">DIMS_ERR_MSG</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span> <span class="op">=</span> <span class="string">"This 'ProQue' has not had any dimensions specified. Use
'ProQueBuilder::dims' during creation or 'ProQue::set_dims' after creation to specify."</span>;
<span class="kw">const</span> <span class="ident">DEBUG_PRINT</span>: <span class="ident">bool</span> <span class="op">=</span> <span class="bool-val">false</span>;
<span class="doccomment">/// An all-in-one chimera of the `Program`, `Queue`, `Context` and</span>
<span class="doccomment">/// (optionally) `SpatialDims` types.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Handy when you only need a single context, program, and queue for your</span>
<span class="doccomment">/// project or when using a unique context and program on each device.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// All `ProQue` functionality is also provided separately by the `Context`, `Queue`,</span>
<span class="doccomment">/// `Program`, and `SpatialDims` types.</span>
<span class="doccomment">///</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Creation</span>
<span class="doccomment">///</span>
<span class="doccomment">/// There are two ways to create a `ProQue`:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// 1. [Recommended] Use `ProQue::builder` or `ProQueBuilder::new()`.</span>
<span class="doccomment">/// 2. Call `::new` and pass pre-created components.</span>
<span class="doccomment">///</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Destruction</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Now handled automatically. Freely use, store, clone, discard, share among</span>
<span class="doccomment">/// threads... put some on your toast... whatever.</span>
<span class="doccomment">///</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">ProQue</span> {
<span class="ident">context</span>: <span class="ident">Context</span>,
<span class="ident">queue</span>: <span class="ident">Queue</span>,
<span class="ident">program</span>: <span class="ident">Program</span>,
<span class="ident">dims</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">SpatialDims</span><span class="op">></span>,
}
<span class="kw">impl</span> <span class="ident">ProQue</span> {
<span class="doccomment">/// Returns a new `ProQueBuilder`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is the recommended way to create a new `ProQue`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Calling `ProQueBuilder::build()` will return a new `ProQue`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">builder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span>() <span class="op">-></span> <span class="ident">ProQueBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="ident">ProQueBuilder</span>::<span class="ident">new</span>()
}
<span class="doccomment">/// Creates a new ProQue from individual parts.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Use `::builder` instead unless you know what you're doing. Creating</span>
<span class="doccomment">/// from components associated with different devices or contexts will</span>
<span class="doccomment">/// cause errors later on.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span><span class="op"><</span><span class="ident">D</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">SpatialDims</span><span class="op">>></span>(<span class="ident">context</span>: <span class="ident">Context</span>, <span class="ident">queue</span>: <span class="ident">Queue</span>, <span class="ident">program</span>: <span class="ident">Program</span>,
<span class="ident">dims</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">D</span><span class="op">></span>) <span class="op">-></span> <span class="ident">ProQue</span> {
<span class="ident">ProQue</span> {
<span class="ident">context</span>: <span class="ident">context</span>,
<span class="ident">queue</span>: <span class="ident">queue</span>,
<span class="ident">program</span>: <span class="ident">program</span>,
<span class="ident">dims</span>: <span class="ident">dims</span>.<span class="ident">map</span>(<span class="op">|</span><span class="ident">d</span><span class="op">|</span> <span class="ident">d</span>.<span class="ident">into</span>()),
}
}
<span class="comment">// /// Creates a kernel with pre-assigned dimensions.</span>
<span class="comment">// pub fn create_kernel(&self, name: &str) -> OclResult<Kernel> {</span>
<span class="comment">// let kernel = Kernel::new(name.to_string(), &self.program)?</span>
<span class="comment">// .queue(self.queue.clone());</span>
<span class="comment">// match self.dims {</span>
<span class="comment">// Some(d) => Ok(kernel.gws(d)),</span>
<span class="comment">// None => Ok(kernel),</span>
<span class="comment">// }</span>
<span class="comment">// }</span>
<span class="doccomment">/// Returns a new `KernelBuilder` with the name, program, default queue,</span>
<span class="doccomment">/// and global work size pre-configured.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Use `::arg` to specify arguments and `::build` to build the kernel.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ### Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust,ignore</span>
<span class="doccomment">/// let kernel = pro_que.kernel_builder("add")</span>
<span class="doccomment">/// .arg(&buffer)</span>
<span class="doccomment">/// .arg(&10.0f32)</span>
<span class="doccomment">/// .build()?;</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See [`KernelBuilder`] documentation for more</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`KernelBuilder`]: struct.KernelBuilder.html</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">kernel_builder</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">name</span>: <span class="ident">S</span>) <span class="op">-></span> <span class="ident">KernelBuilder</span>
<span class="kw">where</span> <span class="ident">S</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">kb</span> <span class="op">=</span> <span class="ident">Kernel</span>::<span class="ident">builder</span>();
<span class="ident">kb</span>.<span class="ident">name</span>(<span class="ident">name</span>);
<span class="ident">kb</span>.<span class="ident">program</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">program</span>);
<span class="ident">kb</span>.<span class="ident">queue</span>(<span class="self">self</span>.<span class="ident">queue</span>.<span class="ident">clone</span>());
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">d</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">dims</span> {
<span class="ident">kb</span>.<span class="ident">global_work_size</span>(<span class="ident">d</span>);
}
<span class="ident">kb</span>
}
<span class="doccomment">/// Returns a new buffer.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The default dimensions and queue from this `ProQue` will be used.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The buffer will be filled with zeros upon creation, blocking the</span>
<span class="doccomment">/// current thread until completion.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Use `Buffer::builder()` (or `BufferBuilder::new()`) for access to the</span>
<span class="doccomment">/// full range of buffer creation options.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Errors</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This `ProQue` must have been pre-configured with default dimensions.</span>
<span class="doccomment">/// If not, set them with `::set_dims`, or just create a buffer using</span>
<span class="doccomment">/// `Buffer::builder()` instead.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">create_buffer</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">OclPrm</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span><span class="ident">Buffer</span><span class="op"><</span><span class="ident">T</span><span class="op">>></span> {
<span class="kw">let</span> <span class="ident">len</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">dims_result</span>()<span class="question-mark">?</span>.<span class="ident">to_len</span>();
<span class="ident">Buffer</span>::<span class="op"><</span><span class="ident">T</span><span class="op">></span>::<span class="ident">builder</span>()
.<span class="ident">queue</span>(<span class="self">self</span>.<span class="ident">queue</span>.<span class="ident">clone</span>())
.<span class="ident">len</span>(<span class="ident">len</span>)
.<span class="ident">fill_val</span>(<span class="ident">Default</span>::<span class="ident">default</span>())
.<span class="ident">build</span>()
}
<span class="doccomment">/// Returns a new `BufferBuilder` with the default queue and length</span>
<span class="doccomment">/// pre-configured.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Use `.fill_val(Default::default())` to fill buffer with zeros.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Use `.build()` to create the buffer.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ### Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This `ProQue` must have been pre-configured with default dimensions.</span>
<span class="doccomment">/// If not, set them with `::set_dims`, or just create a buffer using</span>
<span class="doccomment">/// `Buffer::builder()` instead.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">buffer_builder</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">OclPrm</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">BufferBuilder</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">len</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">dims_result</span>()
.<span class="ident">expect</span>(<span class="string">"`ProQue` dimensions not specified. Please specify dimensions \
using `::set_dims` before calling this method."</span>)
.<span class="ident">to_len</span>();
<span class="ident">Buffer</span>::<span class="op"><</span><span class="ident">T</span><span class="op">></span>::<span class="ident">builder</span>()
.<span class="ident">queue</span>(<span class="self">self</span>.<span class="ident">queue</span>.<span class="ident">clone</span>())
.<span class="ident">len</span>(<span class="ident">len</span>)
}
<span class="doccomment">/// Sets the default dimensions used when creating buffers and kernels.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_dims</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">SpatialDims</span><span class="op">>></span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">dims</span>: <span class="ident">S</span>) {
<span class="self">self</span>.<span class="ident">dims</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">dims</span>.<span class="ident">into</span>());
}
<span class="doccomment">/// Returns the maximum workgroup size supported by the device associated</span>
<span class="doccomment">/// with this `ProQue`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [UNSTABLE]: Evaluate usefulness.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">max_wg_size</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">queue</span>.<span class="ident">device</span>().<span class="ident">max_wg_size</span>().<span class="ident">map_err</span>(<span class="ident">OclError</span>::<span class="ident">from</span>)
}
<span class="doccomment">/// Returns a reference to the queue associated with this ProQue.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">queue</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">Queue</span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">queue</span>
}
<span class="doccomment">/// Returns the contained context.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">context</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">Context</span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">context</span>
}
<span class="doccomment">/// Returns the current program build.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">program</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">Program</span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">program</span>
}
<span class="doccomment">/// Returns the current `dims` or panics.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [UNSTABLE]: Evaluate which 'dims' method to keep. Leaning towards this</span>
<span class="doccomment">/// version at the moment.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">dims</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">SpatialDims</span> {
<span class="self">self</span>.<span class="ident">dims_result</span>().<span class="ident">expect</span>(<span class="ident">DIMS_ERR_MSG</span>)
}
<span class="doccomment">/// Returns the current `dims` or an error.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [UNSTABLE]: Evaluate which 'dims' method to keep. Leaning towards the</span>
<span class="doccomment">/// above, panicking version at the moment.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">dims_result</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">SpatialDims</span><span class="op">></span> {
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">dims</span> {
<span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">dims</span>) <span class="op">=></span> <span class="prelude-val">Ok</span>(<span class="ident">dims</span>),
<span class="prelude-val">None</span> <span class="op">=></span> <span class="prelude-val">Err</span>(<span class="ident">DIMS_ERR_MSG</span>.<span class="ident">into</span>()),
}
}
}
<span class="kw">impl</span> <span class="ident">MemLen</span> <span class="kw">for</span> <span class="ident">ProQue</span> {
<span class="kw">fn</span> <span class="ident">to_len</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">usize</span> {
<span class="self">self</span>.<span class="ident">dims</span>().<span class="ident">to_len</span>()
}
<span class="kw">fn</span> <span class="ident">to_len_padded</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">incr</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="ident">usize</span> {
<span class="self">self</span>.<span class="ident">dims</span>().<span class="ident">to_len_padded</span>(<span class="ident">incr</span>)
}
<span class="kw">fn</span> <span class="ident">to_lens</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> [<span class="ident">usize</span>; <span class="number">3</span>] {
<span class="self">self</span>.<span class="ident">dims_result</span>().<span class="ident">expect</span>(<span class="string">"ocl::ProQue::to_lens()"</span>)
.<span class="ident">to_lens</span>().<span class="ident">expect</span>(<span class="string">"ocl::ProQue::to_lens()"</span>)
}
}
<span class="kw">impl</span> <span class="ident">WorkDims</span> <span class="kw">for</span> <span class="ident">ProQue</span> {
<span class="kw">fn</span> <span class="ident">dim_count</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">u32</span> {
<span class="self">self</span>.<span class="ident">dims_result</span>().<span class="ident">expect</span>(<span class="string">"ProQue::dim_count"</span>).<span class="ident">dim_count</span>()
}
<span class="kw">fn</span> <span class="ident">to_work_size</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span>[<span class="ident">usize</span>; <span class="number">3</span>]<span class="op">></span> {
<span class="self">self</span>.<span class="ident">dims_result</span>().<span class="ident">expect</span>(<span class="string">"ProQue::to_work_size"</span>).<span class="ident">to_work_size</span>()
}
<span class="kw">fn</span> <span class="ident">to_work_offset</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span>[<span class="ident">usize</span>; <span class="number">3</span>]<span class="op">></span> {
<span class="self">self</span>.<span class="ident">dims_result</span>().<span class="ident">expect</span>(<span class="string">"ProQue::to_work_offset"</span>).<span class="ident">to_work_offset</span>()
}
}
<span class="kw">impl</span> <span class="ident">Deref</span> <span class="kw">for</span> <span class="ident">ProQue</span> {
<span class="kw">type</span> <span class="ident">Target</span> <span class="op">=</span> <span class="ident">Queue</span>;
<span class="kw">fn</span> <span class="ident">deref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">Queue</span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">queue</span>
}
}
<span class="doccomment">/// A builder for `ProQue`.</span>
<span class="attribute">#[<span class="ident">must_use</span> <span class="op">=</span> <span class="string">"builders do nothing unless '::build' is called"</span>]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">ProQueBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="ident">platform</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Platform</span><span class="op">></span>,
<span class="ident">context</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Context</span><span class="op">></span>,
<span class="ident">device_spec</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">DeviceSpecifier</span><span class="op">></span>,
<span class="ident">program_builder</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">ProgramBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">>></span>,
<span class="ident">dims</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">SpatialDims</span><span class="op">></span>,
<span class="ident">queue_properties</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">CommandQueueProperties</span><span class="op">></span>,
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> <span class="ident">ProQueBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="doccomment">/// Returns a new `ProQueBuilder` with an empty / default configuration.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The minimum amount of configuration possible before calling `::build` is to</span>
<span class="doccomment">/// simply assign some source code using `::src`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For full configuration options, separately create a `Context` and</span>
<span class="doccomment">/// `ProgramBuilder` (do not `::build` the `ProgramBuilder`, its device</span>
<span class="doccomment">/// list must be set by this `ProQueBuilder` to assure consistency) then</span>
<span class="doccomment">/// pass them as arguments to the `::context` and `::prog_bldr` methods</span>
<span class="doccomment">/// respectively.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-></span> <span class="ident">ProQueBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="ident">ProQueBuilder</span> {
<span class="ident">platform</span>: <span class="prelude-val">None</span>,
<span class="ident">context</span>: <span class="prelude-val">None</span>,
<span class="ident">device_spec</span>: <span class="prelude-val">None</span>,
<span class="ident">program_builder</span>: <span class="prelude-val">None</span>,
<span class="ident">dims</span>: <span class="prelude-val">None</span>,
<span class="ident">queue_properties</span>: <span class="prelude-val">None</span>,
}
}
<span class="doccomment">/// Sets the platform to be used and returns the builder.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If context is set, this will panic upon building. Only one or the other</span>
<span class="doccomment">/// can be configured.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">platform</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">platform</span>: <span class="ident">Platform</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">ProQueBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">platform</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">platform</span>);
<span class="self">self</span>
}
<span class="doccomment">/// Sets the context and returns the `ProQueBuilder`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If platform is set, this will panic upon building. Only one or the other</span>
<span class="doccomment">/// can be configured.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">context</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">context</span>: <span class="ident">Context</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">ProQueBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">context</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">context</span>);
<span class="self">self</span>
}
<span class="doccomment">/// Sets a device or devices to be used and returns a `ProQueBuilder`</span>
<span class="doccomment">/// reference.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Must specify only a single device.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">device</span><span class="op"><</span><span class="ident">D</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">DeviceSpecifier</span><span class="op">>></span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">device_spec</span>: <span class="ident">D</span>)
<span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">ProQueBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span>
{
<span class="macro">assert</span><span class="macro">!</span>(<span class="self">self</span>.<span class="ident">device_spec</span>.<span class="ident">is_none</span>(), <span class="string">"ocl::ProQue::devices: Devices already specified"</span>);
<span class="self">self</span>.<span class="ident">device_spec</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">device_spec</span>.<span class="ident">into</span>());
<span class="self">self</span>
}
<span class="doccomment">/// Adds some source code to be compiled and returns the `ProQueBuilder`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Creates a `ProgramBuilder` if one has not already been added. Attempts</span>
<span class="doccomment">/// to call `::program_builder` after calling this method will cause a panic.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If you need a more complex build configuration or to add multiple</span>
<span class="doccomment">/// source files. Pass an *unbuilt* `ProgramBuilder` to the</span>
<span class="doccomment">/// `::program_builder` method (described below).</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">src</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">>></span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">src</span>: <span class="ident">S</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">ProQueBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">program_builder</span>.<span class="ident">is_some</span>() {
<span class="macro">panic</span><span class="macro">!</span>(<span class="string">"ocl::ProQueBuilder::src: Cannot set src if a 'ProgramBuilder' is already \
defined. Please use the '::program_builder' method for more complex build \
configurations."</span>);
} <span class="kw">else</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">pb</span> <span class="op">=</span> <span class="ident">Program</span>::<span class="ident">builder</span>();
<span class="ident">pb</span>.<span class="ident">src</span>(<span class="ident">src</span>);
<span class="self">self</span>.<span class="ident">program_builder</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">pb</span>);
}
<span class="self">self</span>
}
<span class="doccomment">/// Adds a pre-configured `ProgramBuilder` and returns the `ProQueBuilder`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This `ProQueBuilder` may not already contain a `ProgramBuilder`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// `program_builder` must not have any device indices configured (via its</span>
<span class="doccomment">/// `::device_idxs` method). `ProQueBuilder` will only build programs for</span>
<span class="doccomment">/// the device specified by `::device_idx` or the default device if none has</span>
<span class="doccomment">/// been specified.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">prog_bldr</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">program_builder</span>: <span class="ident">ProgramBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">ProQueBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="macro">assert</span><span class="macro">!</span>(<span class="self">self</span>.<span class="ident">program_builder</span>.<span class="ident">is_none</span>(), <span class="string">"ProQueBuilder::prog_bldr(): Cannot set the \
'ProgramBuilder' using this method after one has already been set or after '::src' has \
been called."</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">program_builder</span>.<span class="ident">get_device_spec</span>().<span class="ident">is_none</span>(), <span class="string">"ProQueBuilder::prog_bldr(): The \
'ProgramBuilder' passed may not have any device indices set as they will be unused. \
See 'ProQueBuilder' documentation for more information."</span>);
<span class="self">self</span>.<span class="ident">program_builder</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">program_builder</span>);
<span class="self">self</span>
}
<span class="doccomment">/// Sets the built-in dimensions.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is optional.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Use if you want to be able to call the `::create_kernel` or</span>
<span class="doccomment">/// `::create_buffer` methods on the `ProQue` created by this builder.</span>
<span class="doccomment">/// Dimensions can alternatively be set after building by using the</span>
<span class="doccomment">/// `ProQue::set_dims` method.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">dims</span><span class="op"><</span><span class="ident">D</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">SpatialDims</span><span class="op">>></span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">dims</span>: <span class="ident">D</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">ProQueBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">dims</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">dims</span>.<span class="ident">into</span>());
<span class="self">self</span>
}
<span class="doccomment">/// Sets the command queue properties.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Optional.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">queue_properties</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">props</span>: <span class="ident">CommandQueueProperties</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">ProQueBuilder</span><span class="op"><</span><span class="lifetime">'b</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">queue_properties</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">props</span>);
<span class="self">self</span>
}
<span class="doccomment">/// Returns a new `ProQue`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Errors</span>
<span class="doccomment">///</span>
<span class="doccomment">/// A `ProgramBuilder` or some source code must have been specified with</span>
<span class="doccomment">/// `::prog_bldr` or `::src` before building.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">build</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">OclResult</span><span class="op"><</span><span class="ident">ProQue</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">program_builder</span> <span class="op">=</span> <span class="kw">match</span> <span class="self">self</span>.<span class="ident">program_builder</span> {
<span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">program_builder</span>) <span class="op">=></span> <span class="ident">program_builder</span>,
<span class="prelude-val">None</span> <span class="op">=></span> <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="string">"ProQueBuilder::build(): No program builder or kernel source defined. \
OpenCL programs must have some source code to be compiled. Use '::src' to directly \
add source code or '::program_builder' for more complex builds. Please see the \
'ProQueBuilder' and 'ProgramBuilder' documentation for more information."</span>.<span class="ident">into</span>()),
};
<span class="comment">// If no platform is set or no context platform is set, use the first available:</span>
<span class="kw">let</span> <span class="ident">platform</span> <span class="op">=</span> <span class="kw">match</span> <span class="self">self</span>.<span class="ident">platform</span> {
<span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">plt</span>) <span class="op">=></span> {
<span class="macro">assert</span><span class="macro">!</span>(<span class="self">self</span>.<span class="ident">context</span>.<span class="ident">is_none</span>(), <span class="string">"ocl::ProQueBuilder::build: \
platform and context cannot both be set."</span>);
<span class="ident">plt</span>.<span class="ident">clone</span>()
},
<span class="prelude-val">None</span> <span class="op">=></span> <span class="kw">match</span> <span class="self">self</span>.<span class="ident">context</span> {
<span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">context</span>) <span class="op">=></span> {
<span class="kw">let</span> <span class="ident">plat</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">platform</span>()<span class="question-mark">?</span>;
<span class="kw">if</span> <span class="ident">DEBUG_PRINT</span> { <span class="macro">println</span><span class="macro">!</span>(<span class="string">"ProQue::build(): plat: {:?}, default: {:?}"</span>,
<span class="ident">plat</span>, <span class="ident">Platform</span>::<span class="ident">default</span>()); }
<span class="kw">match</span> <span class="ident">plat</span> {
<span class="prelude-val">Some</span>(<span class="ident">platform</span>) <span class="op">=></span> <span class="ident">platform</span>.<span class="ident">clone</span>(),
<span class="prelude-val">None</span> <span class="op">=></span> <span class="ident">Platform</span>::<span class="ident">default</span>(),
}
},
<span class="prelude-val">None</span> <span class="op">=></span> <span class="ident">Platform</span>::<span class="ident">default</span>(),
},
};
<span class="comment">// Resolve the device and ensure only one was specified.</span>
<span class="kw">let</span> <span class="ident">device</span> <span class="op">=</span> <span class="kw">match</span> <span class="self">self</span>.<span class="ident">device_spec</span> {
<span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">ds</span>) <span class="op">=></span> {
<span class="kw">let</span> <span class="ident">device_list</span> <span class="op">=</span> <span class="ident">ds</span>.<span class="ident">to_device_list</span>(<span class="prelude-val">Some</span>(<span class="ident">platform</span>))<span class="question-mark">?</span>;
<span class="kw">if</span> <span class="ident">device_list</span>.<span class="ident">len</span>() <span class="op">==</span> <span class="number">1</span> {
<span class="ident">device_list</span>[<span class="number">0</span>]
} <span class="kw">else</span> {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="macro">format</span><span class="macro">!</span>(<span class="string">"Invalid number of devices specified ({}). Each 'ProQue' \
can only be associated with a single device. Use 'Context', 'Program', and \
'Queue' separately for multi-device configurations."</span>,
<span class="ident">device_list</span>.<span class="ident">len</span>()).<span class="ident">into</span>());
}
},
<span class="prelude-val">None</span> <span class="op">=></span> <span class="ident">Device</span>::<span class="ident">first</span>(<span class="ident">platform</span>)<span class="question-mark">?</span>,
};
<span class="kw">if</span> <span class="ident">DEBUG_PRINT</span> { <span class="macro">println</span><span class="macro">!</span>(<span class="string">"ProQue::build(): device: {:?}"</span>, <span class="ident">device</span>); }
<span class="comment">// If no context was set, creates one using the above platform and the</span>
<span class="comment">// pre-set device index (default [0]).</span>
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="kw">match</span> <span class="self">self</span>.<span class="ident">context</span> {
<span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">ctx</span>) <span class="op">=></span> {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">ctx</span>.<span class="ident">devices</span>().<span class="ident">contains</span>(<span class="kw-2">&</span><span class="ident">device</span>));
<span class="ident">ctx</span>.<span class="ident">clone</span>()
}
<span class="prelude-val">None</span> <span class="op">=></span> {
<span class="ident">Context</span>::<span class="ident">builder</span>()
.<span class="ident">platform</span>(<span class="ident">platform</span>)
.<span class="ident">devices</span>(<span class="ident">device</span>)
.<span class="ident">build</span>()<span class="question-mark">?</span>
},
};
<span class="kw">if</span> <span class="ident">DEBUG_PRINT</span> { <span class="macro">println</span><span class="macro">!</span>(<span class="string">"ProQue::build(): context.devices(): {:?}"</span>, <span class="ident">context</span>.<span class="ident">devices</span>()); }
<span class="kw">let</span> <span class="ident">queue</span> <span class="op">=</span> <span class="ident">Queue</span>::<span class="ident">new</span>(<span class="kw-2">&</span><span class="ident">context</span>, <span class="ident">device</span>, <span class="self">self</span>.<span class="ident">queue_properties</span>)<span class="question-mark">?</span>;
<span class="comment">// println!("PROQUEBUILDER: About to load SRC_STRINGS.");</span>
<span class="kw">let</span> <span class="ident">src_strings</span> <span class="op">=</span> <span class="ident">program_builder</span>.<span class="ident">get_src_strings</span>().<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">e</span><span class="op">|</span> <span class="ident">e</span>.<span class="ident">to_string</span>())<span class="question-mark">?</span>;
<span class="comment">// println!("PROQUEBUILDER: About to load CMPLR_OPTS.");</span>
<span class="kw">let</span> <span class="ident">cmplr_opts</span> <span class="op">=</span> <span class="ident">program_builder</span>.<span class="ident">get_compiler_options</span>().<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">e</span><span class="op">|</span> <span class="ident">e</span>.<span class="ident">to_string</span>())<span class="question-mark">?</span>;
<span class="comment">// println!("PROQUEBUILDER: All done.");</span>
<span class="kw">let</span> <span class="ident">program</span> <span class="op">=</span> <span class="ident">Program</span>::<span class="ident">with_source</span>(
<span class="kw-2">&</span><span class="ident">context</span>,
<span class="kw-2">&</span><span class="ident">src_strings</span>,
<span class="prelude-val">Some</span>(<span class="kw-2">&</span>[<span class="ident">device</span>]),
<span class="kw-2">&</span><span class="ident">cmplr_opts</span>,
)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(<span class="ident">ProQue</span>::<span class="ident">new</span>(<span class="ident">context</span>, <span class="ident">queue</span>, <span class="ident">program</span>, <span class="self">self</span>.<span class="ident">dims</span>))
}
}
</pre>
</section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd>↑</kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd>↓</kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd>↹</kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>⏎</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../../";
window.currentCrate = "ocl";
</script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>