RONCC
/
HPC-Tools-for-Quantum-Computing


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260
							<!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="API documentation for the Rust `ProQue` struct in crate `ocl`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, ProQue">

    <title>ocl::ProQue - Rust</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 struct">
    <!--[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">&#9776;</div>
        
        <p class='location'>Struct ProQue</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.builder">builder</a><a href="#method.new">new</a><a href="#method.kernel_builder">kernel_builder</a><a href="#method.create_buffer">create_buffer</a><a href="#method.buffer_builder">buffer_builder</a><a href="#method.set_dims">set_dims</a><a href="#method.max_wg_size">max_wg_size</a><a href="#method.queue">queue</a><a href="#method.context">context</a><a href="#method.program">program</a><a href="#method.dims">dims</a><a href="#method.dims_result">dims_result</a></div><a class="sidebar-title" href="#deref-methods">Methods from Deref&lt;Target=Queue&gt;</a><div class="sidebar-links"><a href="#method.flush">flush</a><a href="#method.finish">finish</a><a href="#method.enqueue_marker">enqueue_marker</a><a href="#method.as_core">as_core</a><a href="#method.context">context</a><a href="#method.device">device</a><a href="#method.device_version">device_version</a><a href="#method.info">info</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-MemLen">MemLen</a><a href="#impl-WorkDims">WorkDims</a><a href="#impl-Deref">Deref</a></div></div><p class='location'><a href='index.html'>ocl</a></p><script>window.sidebarCurrent = {name: 'ProQue', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></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">
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>ocl</a>::<wbr><a class="struct" href=''>ProQue</a></span><span class='out-of-band'><span id='render-detail'>
                   <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
                       [<span class='inner'>&#x2212;</span>]
                   </a>
               </span><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#39-44' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct ProQue { /* fields omitted */ }</pre><div class='docblock'><p>An all-in-one chimera of the <code>Program</code>, <code>Queue</code>, <code>Context</code> and
(optionally) <code>SpatialDims</code> types.</p>
<p>Handy when you only need a single context, program, and queue for your
project or when using a unique context and program on each device.</p>
<p>All <code>ProQue</code> functionality is also provided separately by the <code>Context</code>, <code>Queue</code>,
<code>Program</code>, and <code>SpatialDims</code> types.</p>
<h1 id="creation" class="section-header"><a href="#creation">Creation</a></h1>
<p>There are two ways to create a <code>ProQue</code>:</p>
<ol>
<li>[Recommended] Use <code>ProQue::builder</code> or <code>ProQueBuilder::new()</code>.</li>
<li>Call <code>::new</code> and pass pre-created components.</li>
</ol>
<h1 id="destruction" class="section-header"><a href="#destruction">Destruction</a></h1>
<p>Now handled automatically. Freely use, store, clone, discard, share among
threads... put some on your toast... whatever.</p>
</div>
                    <h2 id='methods' class='small-section-header'>
                      Methods<a href='#methods' class='anchor'></a>
                    </h2>
                <h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../ocl/struct.ProQue.html" title="struct ocl::ProQue">ProQue</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#46-207' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.builder' class="method"><span id='builder.v' class='invisible'><code>pub fn <a href='#method.builder' class='fnname'>builder</a>&lt;'b&gt;() -&gt; <a class="struct" href="../ocl/builders/struct.ProQueBuilder.html" title="struct ocl::builders::ProQueBuilder">ProQueBuilder</a>&lt;'b&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#52-54' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a new <code>ProQueBuilder</code>.</p>
<p>This is the recommended way to create a new <code>ProQue</code>.</p>
<p>Calling <code>ProQueBuilder::build()</code> will return a new <code>ProQue</code>.</p>
</div><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>&lt;D:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>&gt;&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;context: <a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;queue: <a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;program: <a class="struct" href="../ocl/struct.Program.html" title="struct ocl::Program">Program</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;dims: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;D&gt;<br>) -&gt; <a class="struct" href="../ocl/struct.ProQue.html" title="struct ocl::ProQue">ProQue</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#62-70' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Creates a new ProQue from individual parts.</p>
<p>Use <code>::builder</code> instead unless you know what you're doing. Creating
from components associated with different devices or contexts will
cause errors later on.</p>
</div><h4 id='method.kernel_builder' class="method"><span id='kernel_builder.v' class='invisible'><code>pub fn <a href='#method.kernel_builder' class='fnname'>kernel_builder</a>&lt;S&gt;(&amp;self, name: S) -&gt; <a class="struct" href="../ocl/builders/struct.KernelBuilder.html" title="struct ocl::builders::KernelBuilder">KernelBuilder</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#99-111' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a new <code>KernelBuilder</code> with the name, program, default queue,
and global work size pre-configured.</p>
<p>Use <code>::arg</code> to specify arguments and <code>::build</code> to build the kernel.</p>
<h3 id="example" class="section-header"><a href="#example">Example</a></h3>
<div class='information'><div class='tooltip ignore'>ⓘ<span class='tooltiptext'>This example is not tested</span></div></div><pre class="rust rust-example-rendered ignore">
<span class="kw">let</span> <span class="ident">kernel</span> <span class="op">=</span> <span class="ident">pro_que</span>.<span class="ident">kernel_builder</span>(<span class="string">&quot;add&quot;</span>)
   .<span class="ident">arg</span>(<span class="kw-2">&amp;</span><span class="ident">buffer</span>)
   .<span class="ident">arg</span>(<span class="kw-2">&amp;</span><span class="number">10.0f32</span>)
   .<span class="ident">build</span>()<span class="question-mark">?</span>;</pre>
<p>See <a href="struct.KernelBuilder.html"><code>KernelBuilder</code></a> documentation for more</p>
</div><h4 id='method.create_buffer' class="method"><span id='create_buffer.v' class='invisible'><code>pub fn <a href='#method.create_buffer' class='fnname'>create_buffer</a>&lt;T:&nbsp;<a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt;(&amp;self) -&gt; <a class="type" href="../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a>&lt;<a class="struct" href="../ocl/struct.Buffer.html" title="struct ocl::Buffer">Buffer</a>&lt;T&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#129-136' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a new buffer.</p>
<p>The default dimensions and queue from this <code>ProQue</code> will be used.</p>
<p>The buffer will be filled with zeros upon creation, blocking the
current thread until completion.</p>
<p>Use <code>Buffer::builder()</code> (or <code>BufferBuilder::new()</code>) for access to the
full range of buffer creation options.</p>
<h1 id="errors" class="section-header"><a href="#errors">Errors</a></h1>
<p>This <code>ProQue</code> must have been pre-configured with default dimensions.
If not, set them with <code>::set_dims</code>, or just create a buffer using
<code>Buffer::builder()</code> instead.</p>
</div><h4 id='method.buffer_builder' class="method"><span id='buffer_builder.v' class='invisible'><code>pub fn <a href='#method.buffer_builder' class='fnname'>buffer_builder</a>&lt;T:&nbsp;<a class="trait" href="../ocl/traits/trait.OclPrm.html" title="trait ocl::traits::OclPrm">OclPrm</a>&gt;(&amp;self) -&gt; <a class="struct" href="../ocl/builders/struct.BufferBuilder.html" title="struct ocl::builders::BufferBuilder">BufferBuilder</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#151-159' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a new <code>BufferBuilder</code> with the default queue and length
pre-configured.</p>
<p>Use <code>.fill_val(Default::default())</code> to fill buffer with zeros.</p>
<p>Use <code>.build()</code> to create the buffer.</p>
<h3 id="panics" class="section-header"><a href="#panics">Panics</a></h3>
<p>This <code>ProQue</code> must have been pre-configured with default dimensions.
If not, set them with <code>::set_dims</code>, or just create a buffer using
<code>Buffer::builder()</code> instead.</p>
</div><h4 id='method.set_dims' class="method"><span id='set_dims.v' class='invisible'><code>pub fn <a href='#method.set_dims' class='fnname'>set_dims</a>&lt;S:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>&gt;&gt;(&amp;mut self, dims: S)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#162-164' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Sets the default dimensions used when creating buffers and kernels.</p>
</div><h4 id='method.max_wg_size' class="method"><span id='max_wg_size.v' class='invisible'><code>pub fn <a href='#method.max_wg_size' class='fnname'>max_wg_size</a>(&amp;self) -&gt; <a class="type" href="../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#170-172' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the maximum workgroup size supported by the device associated
with this <code>ProQue</code>.</p>
<p>[UNSTABLE]: Evaluate usefulness.</p>
</div><h4 id='method.queue' class="method"><span id='queue.v' class='invisible'><code>pub fn <a href='#method.queue' class='fnname'>queue</a>(&amp;self) -&gt; &amp;<a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#175-177' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a reference to the queue associated with this ProQue.</p>
</div><h4 id='method.context' class="method"><span id='context.v' class='invisible'><code>pub fn <a href='#method.context' class='fnname'>context</a>(&amp;self) -&gt; &amp;<a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#180-182' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the contained context.</p>
</div><h4 id='method.program' class="method"><span id='program.v' class='invisible'><code>pub fn <a href='#method.program' class='fnname'>program</a>(&amp;self) -&gt; &amp;<a class="struct" href="../ocl/struct.Program.html" title="struct ocl::Program">Program</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#185-187' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the current program build.</p>
</div><h4 id='method.dims' class="method"><span id='dims.v' class='invisible'><code>pub fn <a href='#method.dims' class='fnname'>dims</a>(&amp;self) -&gt; &amp;<a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#193-195' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the current <code>dims</code> or panics.</p>
<p>[UNSTABLE]: Evaluate which 'dims' method to keep. Leaning towards this
version at the moment.</p>
</div><h4 id='method.dims_result' class="method"><span id='dims_result.v' class='invisible'><code>pub fn <a href='#method.dims_result' class='fnname'>dims_result</a>(&amp;self) -&gt; <a class="type" href="../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a>&lt;&amp;<a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#201-206' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the current <code>dims</code> or an error.</p>
<p>[UNSTABLE]: Evaluate which 'dims' method to keep. Leaning towards the
above, panicking version at the moment.</p>
</div></div>
                    <h2 id='deref-methods' class='small-section-header'>
                      Methods from <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>&lt;Target = <a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a>&gt;<a href='#deref-methods' class='anchor'></a>
                    </h2>
                <div class='impl-items'><h4 id='method.flush' class="method"><span id='flush.v' class='invisible'><code>pub fn <a href='#method.flush' class='fnname'>flush</a>(&amp;self) -&gt; <a class="type" href="../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/queue.rs.html#39-41' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Issues all previously queued OpenCL commands to the device.</p>
</div><h4 id='method.finish' class="method"><span id='finish.v' class='invisible'><code>pub fn <a href='#method.finish' class='fnname'>finish</a>(&amp;self) -&gt; <a class="type" href="../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/queue.rs.html#44-46' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Blocks until all commands in this queue have completed before returning.</p>
</div><h4 id='method.enqueue_marker' class="method"><span id='enqueue_marker.v' class='invisible'><code>pub fn <a href='#method.enqueue_marker' class='fnname'>enqueue_marker</a>&lt;Ewl&gt;(&amp;self, ewait: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Ewl&gt;) -&gt; <a class="type" href="../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a>&lt;<a class="struct" href="../ocl/struct.Event.html" title="struct ocl::Event">Event</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Ewl: <a class="trait" href="../ocl_core/types/abs/trait.ClWaitListPtr.html" title="trait ocl_core::types::abs::ClWaitListPtr">ClWaitListPtr</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/queue.rs.html#50-57' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Enqueues a marker command which waits for either a list of events to
complete, or all previously enqueued commands to complete.</p>
</div><h4 id='method.as_core' class="method"><span id='as_core.v' class='invisible'><code>pub fn <a href='#method.as_core' class='fnname'>as_core</a>(&amp;self) -&gt; &amp;<a class="struct" href="../ocl_core/types/abs/struct.CommandQueue.html" title="struct ocl_core::types::abs::CommandQueue">CommandQueueCore</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/queue.rs.html#62-64' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a reference to the core pointer wrapper, usable by functions in
the <code>core</code> module.</p>
</div><h4 id='method.context-1' class="method"><span id='context.v-1' class='invisible'><code>pub fn <a href='#method.context-1' class='fnname'>context</a>(&amp;self) -&gt; <a class="struct" href="../ocl/struct.Context.html" title="struct ocl::Context">Context</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/queue.rs.html#67-69' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a copy of the Context associated with this queue.</p>
</div><h4 id='method.device' class="method"><span id='device.v' class='invisible'><code>pub fn <a href='#method.device' class='fnname'>device</a>(&amp;self) -&gt; <a class="struct" href="../ocl/struct.Device.html" title="struct ocl::Device">Device</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/queue.rs.html#72-74' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the <code>OpenCL</code> device associated with this queue.</p>
</div><h4 id='method.device_version' class="method"><span id='device_version.v' class='invisible'><code>pub fn <a href='#method.device_version' class='fnname'>device_version</a>(&amp;self) -&gt; <a class="struct" href="../ocl_core/types/structs/struct.OpenclVersion.html" title="struct ocl_core::types::structs::OpenclVersion">OpenclVersion</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/queue.rs.html#77-79' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the cached device version.</p>
</div><h4 id='method.info' class="method"><span id='info.v' class='invisible'><code>pub fn <a href='#method.info' class='fnname'>info</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;info_kind: <a class="enum" href="../ocl/enums/enum.CommandQueueInfo.html" title="enum ocl::enums::CommandQueueInfo">CommandQueueInfo</a><br>) -&gt; <a class="type" href="../ocl_core/error/type.Result.html" title="type ocl_core::error::Result">OclCoreResult</a>&lt;<a class="enum" href="../ocl/enums/enum.CommandQueueInfoResult.html" title="enum ocl::enums::CommandQueueInfoResult">CommandQueueInfoResult</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/queue.rs.html#82-84' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns info about this queue.</p>
</div></div>
            <h2 id='implementations' class='small-section-header'>
              Trait Implementations<a href='#implementations' class='anchor'></a>
            </h2>
        <h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../ocl/struct.ProQue.html" title="struct ocl::ProQue">ProQue</a></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#38' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../ocl/struct.ProQue.html" title="struct ocl::ProQue">ProQue</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#38' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../ocl/struct.ProQue.html" title="struct ocl::ProQue">ProQue</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#38' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#38' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-MemLen' class='impl'><span class='in-band'><code>impl <a class="trait" href="../ocl/traits/trait.MemLen.html" title="trait ocl::traits::MemLen">MemLen</a> for <a class="struct" href="../ocl/struct.ProQue.html" title="struct ocl::ProQue">ProQue</a></code><a href='#impl-MemLen' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#209-220' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.to_len' class="method"><span id='to_len.v' class='invisible'><code>fn <a href='../ocl/traits/trait.MemLen.html#tymethod.to_len' class='fnname'>to_len</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#210-212' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the exact number of elements of a volume of memory (equivalent to <code>Vec::len()</code>). <a href="../ocl/traits/trait.MemLen.html#tymethod.to_len">Read more</a></p>
</div><h4 id='method.to_len_padded' class="method"><span id='to_len_padded.v' class='invisible'><code>fn <a href='../ocl/traits/trait.MemLen.html#tymethod.to_len_padded' class='fnname'>to_len_padded</a>(&amp;self, incr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#213-215' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the length of a volume of memory padded to the next multiple of <code>incr</code>. <a href="../ocl/traits/trait.MemLen.html#tymethod.to_len_padded">Read more</a></p>
</div><h4 id='method.to_lens' class="method"><span id='to_lens.v' class='invisible'><code>fn <a href='../ocl/traits/trait.MemLen.html#tymethod.to_lens' class='fnname'>to_lens</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#216-219' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the exact lengths of each dimension of a volume of memory.</p>
</div></div><h3 id='impl-WorkDims' class='impl'><span class='in-band'><code>impl <a class="trait" href="../ocl/traits/trait.WorkDims.html" title="trait ocl::traits::WorkDims">WorkDims</a> for <a class="struct" href="../ocl/struct.ProQue.html" title="struct ocl::ProQue">ProQue</a></code><a href='#impl-WorkDims' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#222-234' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.dim_count' class="method"><span id='dim_count.v' class='invisible'><code>fn <a href='../ocl/traits/trait.WorkDims.html#tymethod.dim_count' class='fnname'>dim_count</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#223-225' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the number of dimensions defined.</p>
</div><h4 id='method.to_work_size' class="method"><span id='to_work_size.v' class='invisible'><code>fn <a href='../ocl/traits/trait.WorkDims.html#tymethod.to_work_size' class='fnname'>to_work_size</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#227-229' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns an array representing the amount of work to be done by a kernel. <a href="../ocl/traits/trait.WorkDims.html#tymethod.to_work_size">Read more</a></p>
</div><h4 id='method.to_work_offset' class="method"><span id='to_work_offset.v' class='invisible'><code>fn <a href='../ocl/traits/trait.WorkDims.html#tymethod.to_work_offset' class='fnname'>to_work_offset</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#231-233' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns an array representing the offset of a work item or memory location. <a href="../ocl/traits/trait.WorkDims.html#tymethod.to_work_offset">Read more</a></p>
</div></div><h3 id='impl-Deref' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="../ocl/struct.ProQue.html" title="struct ocl::ProQue">ProQue</a></code><a href='#impl-Deref' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#236-242' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='associatedtype.Target' class="type"><span id='Target.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target' class="type">Target</a> = <a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a></code></span></h4>
<div class='docblock'><p>The resulting type after dereferencing.</p>
</div><h4 id='method.deref' class="method"><span id='deref.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#tymethod.deref' class='fnname'>deref</a>(&amp;self) -&gt; &amp;<a class="struct" href="../ocl/struct.Queue.html" title="struct ocl::Queue">Queue</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/pro_que.rs.html#239-241' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Dereferences the value.</p>
</div></div></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>&#9166;</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>