| 1234567891011121314151617181920212223242526272829 |
- <!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 `WorkDims` trait in crate `ocl`."><meta name="keywords" content="rust, rustlang, rust-lang, WorkDims"><title>ocl::traits::WorkDims - 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="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc trait"><!--[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><p class='location'>Trait WorkDims</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.dim_count">dim_count</a><a href="#tymethod.to_work_size">to_work_size</a><a href="#tymethod.to_work_offset">to_work_offset</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>ocl</a>::<wbr><a href='index.html'>traits</a></p><script>window.sidebarCurrent = {name: 'WorkDims', ty: 'trait', 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"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Trait <a href='../index.html'>ocl</a>::<wbr><a href='index.html'>traits</a>::<wbr><a class="trait" href=''>WorkDims</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'>−</span>]</a></span><a class='srclink' href='../../src/ocl/standard/mod.rs.html#385-401' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait WorkDims {
- fn <a href='#tymethod.dim_count' class='fnname'>dim_count</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>;
- <div class='item-spacer'></div> fn <a href='#tymethod.to_work_size' class='fnname'>to_work_size</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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>>;
- <div class='item-spacer'></div> fn <a href='#tymethod.to_work_offset' class='fnname'>to_work_offset</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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>>;
- }</pre></div><div class='docblock'><p>Types which have properties describing the amount of work to be done
- in multiple dimensions.</p>
- </div>
- <h2 id='required-methods' class='small-section-header'>
- Required Methods<a href='#required-methods' class='anchor'></a>
- </h2>
- <div class='methods'>
- <h3 id='tymethod.dim_count' class='method'><span id='dim_count.v' class='invisible'><code>fn <a href='#tymethod.dim_count' class='fnname'>dim_count</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></h3><div class='docblock'><p>Returns the number of dimensions defined.</p>
- </div><h3 id='tymethod.to_work_size' class='method'><span id='to_work_size.v' class='invisible'><code>fn <a href='#tymethod.to_work_size' class='fnname'>to_work_size</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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></h3><div class='docblock'><p>Returns an array representing the amount of work to be done by a kernel.</p>
- <p>Unspecified dimensions (for example, the 3rd dimension in a
- 1-dimensional work size) are set equal to <code>1</code>.</p>
- </div><h3 id='tymethod.to_work_offset' class='method'><span id='to_work_offset.v' class='invisible'><code>fn <a href='#tymethod.to_work_offset' class='fnname'>to_work_offset</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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></h3><div class='docblock'><p>Returns an array representing the offset of a work item or memory
- location.</p>
- <p>Unspecified dimensions (for example, the 3rd dimension in a
- 1-dimensional work size) are set equal to <code>0</code>.</p>
- </div></div>
- <h2 id='implementors' class='small-section-header'>
- Implementors<a href='#implementors' class='anchor'></a>
- </h2>
- <ul class='item-list' id='implementors-list'>
- <li><table class='table-display'><tbody><tr><td><code>impl WorkDims for <a class="struct" href="../../ocl/struct.ProQue.html" title="struct ocl::ProQue">ProQue</a></code><td><div class='out-of-band'><a class='srclink' href='../../src/ocl/standard/pro_que.rs.html#222-234' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
- <li><table class='table-display'><tbody><tr><td><code>impl WorkDims for <a class="enum" href="../../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><td><div class='out-of-band'><a class='srclink' href='../../src/ocl/standard/spatial_dims.rs.html#144-156' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
- </ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
- src="../../implementors/ocl/traits/trait.WorkDims.js">
- </script></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><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "ocl";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
