enum.SpatialDims.html 61 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <meta name="generator" content="rustdoc">
  7. <meta name="description" content="API documentation for the Rust `SpatialDims` enum in crate `ocl`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, SpatialDims">
  9. <title>ocl::SpatialDims - Rust</title>
  10. <link rel="stylesheet" type="text/css" href="../normalize.css">
  11. <link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle">
  12. <link rel="stylesheet" type="text/css" href="../dark.css">
  13. <link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
  14. <script src="../storage.js"></script>
  15. </head>
  16. <body class="rustdoc enum">
  17. <!--[if lte IE 8]>
  18. <div class="warning">
  19. This old browser is unsupported and will most likely display funky
  20. things.
  21. </div>
  22. <![endif]-->
  23. <nav class="sidebar">
  24. <div class="sidebar-menu">&#9776;</div>
  25. <p class='location'>Enum SpatialDims</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Unspecified">Unspecified</a><a href="#variant.One">One</a><a href="#variant.Two">Two</a><a href="#variant.Three">Three</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.dim_count">dim_count</a><a href="#method.to_lens">to_lens</a><a href="#method.to_offset">to_offset</a><a href="#method.to_len">to_len</a><a href="#method.try_to_padded_len">try_to_padded_len</a><a href="#method.is_unspecified">is_unspecified</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-Copy">Copy</a><a href="#impl-PartialEq">PartialEq</a><a href="#impl-Eq">Eq</a><a href="#impl-MemLen">MemLen</a><a href="#impl-WorkDims">WorkDims</a><a href="#impl-Index%3Cusize%3E">Index&lt;usize&gt;</a><a href="#impl-From%3C%26%27a%20SpatialDims%3E">From&lt;&amp;&#39;a SpatialDims&gt;</a><a href="#impl-From%3Cusize%3E">From&lt;usize&gt;</a><a href="#impl-From%3Cisize%3E">From&lt;isize&gt;</a><a href="#impl-From%3Cu32%3E">From&lt;u32&gt;</a><a href="#impl-From%3Ci32%3E">From&lt;i32&gt;</a><a href="#impl-From%3C(T%2C)%3E">From&lt;(T,)&gt;</a><a href="#impl-From%3C%26%27a%20(T%2C)%3E">From&lt;&amp;&#39;a (T,)&gt;</a><a href="#impl-From%3C%5BT%3B%201%5D%3E">From&lt;[T; 1]&gt;</a><a href="#impl-From%3C%26%27a%20%5BT%3B%201%5D%3E">From&lt;&amp;&#39;a [T; 1]&gt;</a><a href="#impl-From%3C(T%2C%20T)%3E">From&lt;(T, T)&gt;</a><a href="#impl-From%3C%26%27a%20(T%2C%20T)%3E">From&lt;&amp;&#39;a (T, T)&gt;</a><a href="#impl-From%3C%5BT%3B%202%5D%3E">From&lt;[T; 2]&gt;</a><a href="#impl-From%3C%26%27a%20%5BT%3B%202%5D%3E">From&lt;&amp;&#39;a [T; 2]&gt;</a><a href="#impl-From%3C(T%2C%20T%2C%20T)%3E">From&lt;(T, T, T)&gt;</a><a href="#impl-From%3C%26%27a%20(T%2C%20T%2C%20T)%3E">From&lt;&amp;&#39;a (T, T, T)&gt;</a><a href="#impl-From%3C%5BT%3B%203%5D%3E">From&lt;[T; 3]&gt;</a><a href="#impl-From%3C%26%27a%20%5BT%3B%203%5D%3E">From&lt;&amp;&#39;a [T; 3]&gt;</a></div></div><p class='location'><a href='index.html'>ocl</a></p><script>window.sidebarCurrent = {name: 'SpatialDims', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
  26. </nav>
  27. <div class="theme-picker">
  28. <button id="theme-picker" aria-label="Pick another theme!">
  29. <img src="../brush.svg" width="18" alt="Pick another theme!">
  30. </button>
  31. <div id="theme-choices"></div>
  32. </div>
  33. <script src="../theme.js"></script>
  34. <nav class="sub">
  35. <form class="search-form js-only">
  36. <div class="search-container">
  37. <input class="search-input" name="search"
  38. autocomplete="off"
  39. placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
  40. type="search">
  41. </div>
  42. </form>
  43. </nav>
  44. <section id='main' class="content">
  45. <h1 class='fqn'><span class='in-band'>Enum <a href='index.html'>ocl</a>::<wbr><a class="enum" href=''>SpatialDims</a></span><span class='out-of-band'><span id='render-detail'>
  46. <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
  47. [<span class='inner'>&#x2212;</span>]
  48. </a>
  49. </span><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#32-37' title='goto source code'>[src]</a></span></h1>
  50. <pre class='rust enum'>pub enum SpatialDims {
  51. Unspecified,
  52. One(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>),
  53. Two(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>),
  54. Three(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>),
  55. }</pre><div class='docblock'><p>Specifies a size or offset in up to three dimensions.</p>
  56. <p>Using <code>SpatialDims</code> to specify dimensions for your application may not be
  57. appropriate. Custom types implementing the traits <code>MemLen</code> and <code>WorkDims</code>
  58. should be created to express more complex relationships between data shape
  59. and work size for kernels which do not have a 1:1 correspondence between
  60. data set length and global work size.</p>
  61. <p>[FIXME]: Describe the ways a <code>SpatialDims</code> can be created using various
  62. <code>From</code> implementations.</p>
  63. <p>[UNSTABLE]: This type and its methods may be renamed or otherwise changed
  64. at any time. This is still a work in progress.</p>
  65. </div><h2 id='variants' class='variants small-section-header'>
  66. Variants<a href='#variants' class='anchor'></a></h2>
  67. <span id="variant.Unspecified" class="variant small-section-header"><a href="#variant.Unspecified" class="anchor field"></a><span id='Unspecified.v' class='invisible'><code>Unspecified</code></span></span><span id="variant.One" class="variant small-section-header"><a href="#variant.One" class="anchor field"></a><span id='One.v' class='invisible'><code>One(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code></span></span><span id="variant.Two" class="variant small-section-header"><a href="#variant.Two" class="anchor field"></a><span id='Two.v' class='invisible'><code>Two(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code></span></span><span id="variant.Three" class="variant small-section-header"><a href="#variant.Three" class="anchor field"></a><span id='Three.v' class='invisible'><code>Three(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code></span></span>
  68. <h2 id='methods' class='small-section-header'>
  69. Methods<a href='#methods' class='anchor'></a>
  70. </h2>
  71. <h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</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/spatial_dims.rs.html#39-128' title='goto source code'>[src]</a></span></h3>
  72. <div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;d0: <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.usize.html">usize</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;d1: <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.usize.html">usize</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;d2: <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.usize.html">usize</a>&gt;<br>) -&gt; <a class="type" href="../ocl/error/type.Result.html" title="type ocl::error::Result">OclResult</a>&lt;<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/spatial_dims.rs.html#49-70' title='goto source code'>[src]</a></span></h4>
  73. <div class='docblock'><p>Returns a new <code>SpatialDims</code>.</p>
  74. <p>Dimensions must be specified in order from d0 -&gt; d1 -&gt; d2; i.e. <code>d1</code>
  75. cannot be <code>Some(x)</code> if <code>d0</code> is <code>None</code>.</p>
  76. <p>Explicitly setting all zeros as values is not recommended as it is
  77. invalid to OpenCL functions. Use <code>::Unspecified</code> to represent <code>NULL</code>
  78. instead.</p>
  79. </div><h4 id='method.dim_count' class="method"><span id='dim_count.v' class='invisible'><code>pub fn <a href='#method.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/spatial_dims.rs.html#73-80' title='goto source code'>[src]</a></span></h4>
  80. <div class='docblock'><p>Returns the number of dimensions defined by this <code>SpatialDims</code>.</p>
  81. </div><h4 id='method.to_lens' class="method"><span id='to_lens.v' class='invisible'><code>pub fn <a href='#method.to_lens' class='fnname'>to_lens</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</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>, UnspecifiedDimensionsError&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#83-90' title='goto source code'>[src]</a></span></h4>
  82. <div class='docblock'><p>Returns a 3D size or an error if unspecified.</p>
  83. </div><h4 id='method.to_offset' class="method"><span id='to_offset.v' class='invisible'><code>pub fn <a href='#method.to_offset' class='fnname'>to_offset</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</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>, UnspecifiedDimensionsError&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#93-100' title='goto source code'>[src]</a></span></h4>
  84. <div class='docblock'><p>Returns a 3D offset or an error if unspecified.</p>
  85. </div><h4 id='method.to_len' class="method"><span id='to_len.v' class='invisible'><code>pub fn <a href='#method.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/spatial_dims.rs.html#110-117' title='goto source code'>[src]</a></span></h4>
  86. <div class='docblock'><p>Returns the product of all contained dimensional values (equivalent to
  87. a length, area, or volume) or zero if unspecified.</p>
  88. <p>Check <code>::is_unspecified</code> if it matters whether or not the zero length
  89. has been explicitly set however, explicitly setting all zeros as
  90. dimensions is not recommended as it is an invalid value to OpenCL
  91. functions. Use <code>::Unspecified</code> to represent <code>NULL</code> instead.</p>
  92. </div><h4 id='method.try_to_padded_len' class="method"><span id='try_to_padded_len.v' class='invisible'><code>pub fn <a href='#method.try_to_padded_len' class='fnname'>try_to_padded_len</a>(&amp;self, incr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&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/spatial_dims.rs.html#120-122' title='goto source code'>[src]</a></span></h4>
  93. <div class='docblock'><p>Takes the length and rounds it up to the nearest <code>incr</code> or an error.</p>
  94. </div><h4 id='method.is_unspecified' class="method"><span id='is_unspecified.v' class='invisible'><code>pub fn <a href='#method.is_unspecified' class='fnname'>is_unspecified</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#125-127' title='goto source code'>[src]</a></span></h4>
  95. <div class='docblock'><p>Returns <code>true</code> if this <code>SpatialDims</code> is an <code>Unspecified</code> variant.</p>
  96. </div></div>
  97. <h2 id='implementations' class='small-section-header'>
  98. Trait Implementations<a href='#implementations' class='anchor'></a>
  99. </h2>
  100. <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="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</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/spatial_dims.rs.html#31' title='goto source code'>[src]</a></span></h3>
  101. <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="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/spatial_dims.rs.html#31' title='goto source code'>[src]</a></span></h4>
  102. <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>
  103. </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>
  104. <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>
  105. </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="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</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/spatial_dims.rs.html#31' title='goto source code'>[src]</a></span></h3>
  106. <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/spatial_dims.rs.html#31' title='goto source code'>[src]</a></span></h4>
  107. <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>
  108. </div></div><h3 id='impl-Copy' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-Copy' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#31' title='goto source code'>[src]</a></span></h3>
  109. <div class='impl-items'></div><h3 id='impl-PartialEq' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-PartialEq' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#31' title='goto source code'>[src]</a></span></h3>
  110. <div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, __arg_0: &amp;<a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#31' title='goto source code'>[src]</a></span></h4>
  111. <div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
  112. </div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, __arg_0: &amp;<a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#31' title='goto source code'>[src]</a></span></h4>
  113. <div class='docblock'><p>This method tests for <code>!=</code>.</p>
  114. </div></div><h3 id='impl-Eq' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-Eq' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#31' title='goto source code'>[src]</a></span></h3>
  115. <div class='impl-items'></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="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</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/spatial_dims.rs.html#130-142' title='goto source code'>[src]</a></span></h3>
  116. <div class='impl-items'><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/spatial_dims.rs.html#131-133' title='goto source code'>[src]</a></span></h4>
  117. <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>
  118. </div><h4 id='method.to_len-1' class="method"><span id='to_len.v-1' 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/spatial_dims.rs.html#135-137' title='goto source code'>[src]</a></span></h4>
  119. <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>
  120. </div><h4 id='method.to_lens-1' class="method"><span id='to_lens.v-1' 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/spatial_dims.rs.html#139-141' title='goto source code'>[src]</a></span></h4>
  121. <div class='docblock'><p>Returns the exact lengths of each dimension of a volume of memory.</p>
  122. </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="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</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/spatial_dims.rs.html#144-156' title='goto source code'>[src]</a></span></h3>
  123. <div class='impl-items'><h4 id='method.dim_count-1' class="method"><span id='dim_count.v-1' 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/spatial_dims.rs.html#145-147' title='goto source code'>[src]</a></span></h4>
  124. <div class='docblock'><p>Returns the number of dimensions defined.</p>
  125. </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/spatial_dims.rs.html#149-151' title='goto source code'>[src]</a></span></h4>
  126. <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>
  127. </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/spatial_dims.rs.html#153-155' title='goto source code'>[src]</a></span></h4>
  128. <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>
  129. </div></div><h3 id='impl-Index%3Cusize%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html" title="trait core::ops::index::Index">Index</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt; for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-Index%3Cusize%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#159-190' title='goto source code'>[src]</a></span></h3>
  130. <div class='impl-items'><h4 id='associatedtype.Output' class="type"><span id='Output.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output' class="type">Output</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></h4>
  131. <div class='docblock'><p>The returned type after indexing.</p>
  132. </div><h4 id='method.index' class="method"><span id='index.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#tymethod.index' class='fnname'>index</a>(&amp;self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; &amp;<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/spatial_dims.rs.html#162-189' title='goto source code'>[src]</a></span></h4>
  133. <div class='docblock'><p>Performs the indexing (<code>container[index]</code>) operation.</p>
  134. </div></div><h3 id='impl-From%3C%26%27a%20SpatialDims%3E' class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;&amp;'a <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>&gt; for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-From%3C%26%27a%20SpatialDims%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#192-196' title='goto source code'>[src]</a></span></h3>
  135. <div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(sd: &amp;'a <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a>) -&gt; <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/spatial_dims.rs.html#193-195' title='goto source code'>[src]</a></span></h4>
  136. <div class='docblock'><p>Performs the conversion.</p>
  137. </div></div><h3 id='impl-From%3Cusize%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt; for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-From%3Cusize%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#199-203' title='goto source code'>[src]</a></span></h3>
  138. <div class='impl-items'><h4 id='method.from-1' class="method"><span id='from.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(val: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <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/spatial_dims.rs.html#200-202' title='goto source code'>[src]</a></span></h4>
  139. <div class='docblock'><p>Performs the conversion.</p>
  140. </div></div><h3 id='impl-From%3Cisize%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a>&gt; for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-From%3Cisize%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#206-212' title='goto source code'>[src]</a></span></h3>
  141. <div class='impl-items'><h4 id='method.from-2' class="method"><span id='from.v-2' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(val: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a>) -&gt; <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/spatial_dims.rs.html#207-211' title='goto source code'>[src]</a></span></h4>
  142. <div class='docblock'><p>Performs the conversion.</p>
  143. </div></div><h3 id='impl-From%3Cu32%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>&gt; for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-From%3Cu32%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#215-219' title='goto source code'>[src]</a></span></h3>
  144. <div class='impl-items'><h4 id='method.from-3' class="method"><span id='from.v-3' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(val: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; <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/spatial_dims.rs.html#216-218' title='goto source code'>[src]</a></span></h4>
  145. <div class='docblock'><p>Performs the conversion.</p>
  146. </div></div><h3 id='impl-From%3Ci32%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>&gt; for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-From%3Ci32%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#222-226' title='goto source code'>[src]</a></span></h3>
  147. <div class='impl-items'><h4 id='method.from-4' class="method"><span id='from.v-4' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(val: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -&gt; <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/spatial_dims.rs.html#223-225' title='goto source code'>[src]</a></span></h4>
  148. <div class='docblock'><p>Performs the conversion.</p>
  149. </div></div><h3 id='impl-From%3C(T%2C)%3E' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="../num_traits/trait.Num.html" title="trait num_traits::Num">Num</a> + <a class="trait" href="../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">,)</a>&gt; for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-From%3C(T%2C)%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#228-232' title='goto source code'>[src]</a></span></h3>
  150. <div class='impl-items'><h4 id='method.from-5' class="method"><span id='from.v-5' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(val: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">,)</a>) -&gt; <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/spatial_dims.rs.html#229-231' title='goto source code'>[src]</a></span></h4>
  151. <div class='docblock'><p>Performs the conversion.</p>
  152. </div></div><h3 id='impl-From%3C%26%27a%20(T%2C)%3E' class='impl'><span class='in-band'><code>impl&lt;'a, T:&nbsp;<a class="trait" href="../num_traits/trait.Num.html" title="trait num_traits::Num">Num</a> + <a class="trait" href="../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;&amp;'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">,)</a>&gt; for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-From%3C%26%27a%20(T%2C)%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#234-238' title='goto source code'>[src]</a></span></h3>
  153. <div class='impl-items'><h4 id='method.from-6' class="method"><span id='from.v-6' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(val: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">,)</a>) -&gt; <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/spatial_dims.rs.html#235-237' title='goto source code'>[src]</a></span></h4>
  154. <div class='docblock'><p>Performs the conversion.</p>
  155. </div></div><h3 id='impl-From%3C%5BT%3B%201%5D%3E' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="../num_traits/trait.Num.html" title="trait num_traits::Num">Num</a> + <a class="trait" href="../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 1]</a>&gt; for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-From%3C%5BT%3B%201%5D%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#240-244' title='goto source code'>[src]</a></span></h3>
  156. <div class='impl-items'><h4 id='method.from-7' class="method"><span id='from.v-7' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(val: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 1]</a>) -&gt; <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/spatial_dims.rs.html#241-243' title='goto source code'>[src]</a></span></h4>
  157. <div class='docblock'><p>Performs the conversion.</p>
  158. </div></div><h3 id='impl-From%3C%26%27a%20%5BT%3B%201%5D%3E' class='impl'><span class='in-band'><code>impl&lt;'a, T:&nbsp;<a class="trait" href="../num_traits/trait.Num.html" title="trait num_traits::Num">Num</a> + <a class="trait" href="../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;&amp;'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 1]</a>&gt; for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-From%3C%26%27a%20%5BT%3B%201%5D%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#246-250' title='goto source code'>[src]</a></span></h3>
  159. <div class='impl-items'><h4 id='method.from-8' class="method"><span id='from.v-8' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(val: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 1]</a>) -&gt; <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/spatial_dims.rs.html#247-249' title='goto source code'>[src]</a></span></h4>
  160. <div class='docblock'><p>Performs the conversion.</p>
  161. </div></div><h3 id='impl-From%3C(T%2C%20T)%3E' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="../num_traits/trait.Num.html" title="trait num_traits::Num">Num</a> + <a class="trait" href="../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>T, T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>&gt; for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-From%3C(T%2C%20T)%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#252-259' title='goto source code'>[src]</a></span></h3>
  162. <div class='impl-items'><h4 id='method.from-9' class="method"><span id='from.v-9' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(pair: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>T, T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>) -&gt; <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/spatial_dims.rs.html#253-258' title='goto source code'>[src]</a></span></h4>
  163. <div class='docblock'><p>Performs the conversion.</p>
  164. </div></div><h3 id='impl-From%3C%26%27a%20(T%2C%20T)%3E' class='impl'><span class='in-band'><code>impl&lt;'a, T:&nbsp;<a class="trait" href="../num_traits/trait.Num.html" title="trait num_traits::Num">Num</a> + <a class="trait" href="../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;&amp;'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>T, T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>&gt; for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-From%3C%26%27a%20(T%2C%20T)%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#261-268' title='goto source code'>[src]</a></span></h3>
  165. <div class='impl-items'><h4 id='method.from-10' class="method"><span id='from.v-10' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(pair: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>T, T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>) -&gt; <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/spatial_dims.rs.html#262-267' title='goto source code'>[src]</a></span></h4>
  166. <div class='docblock'><p>Performs the conversion.</p>
  167. </div></div><h3 id='impl-From%3C%5BT%3B%202%5D%3E' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="../num_traits/trait.Num.html" title="trait num_traits::Num">Num</a> + <a class="trait" href="../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 2]</a>&gt; for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-From%3C%5BT%3B%202%5D%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#270-277' title='goto source code'>[src]</a></span></h3>
  168. <div class='impl-items'><h4 id='method.from-11' class="method"><span id='from.v-11' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(pair: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 2]</a>) -&gt; <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/spatial_dims.rs.html#271-276' title='goto source code'>[src]</a></span></h4>
  169. <div class='docblock'><p>Performs the conversion.</p>
  170. </div></div><h3 id='impl-From%3C%26%27a%20%5BT%3B%202%5D%3E' class='impl'><span class='in-band'><code>impl&lt;'a, T:&nbsp;<a class="trait" href="../num_traits/trait.Num.html" title="trait num_traits::Num">Num</a> + <a class="trait" href="../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;&amp;'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 2]</a>&gt; for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-From%3C%26%27a%20%5BT%3B%202%5D%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#279-286' title='goto source code'>[src]</a></span></h3>
  171. <div class='impl-items'><h4 id='method.from-12' class="method"><span id='from.v-12' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(pair: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 2]</a>) -&gt; <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/spatial_dims.rs.html#280-285' title='goto source code'>[src]</a></span></h4>
  172. <div class='docblock'><p>Performs the conversion.</p>
  173. </div></div><h3 id='impl-From%3C(T%2C%20T%2C%20T)%3E' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="../num_traits/trait.Num.html" title="trait num_traits::Num">Num</a> + <a class="trait" href="../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>T, T, T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>&gt; for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-From%3C(T%2C%20T%2C%20T)%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#288-296' title='goto source code'>[src]</a></span></h3>
  174. <div class='impl-items'><h4 id='method.from-13' class="method"><span id='from.v-13' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(set: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>T, T, T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>) -&gt; <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/spatial_dims.rs.html#289-295' title='goto source code'>[src]</a></span></h4>
  175. <div class='docblock'><p>Performs the conversion.</p>
  176. </div></div><h3 id='impl-From%3C%26%27a%20(T%2C%20T%2C%20T)%3E' class='impl'><span class='in-band'><code>impl&lt;'a, T:&nbsp;<a class="trait" href="../num_traits/trait.Num.html" title="trait num_traits::Num">Num</a> + <a class="trait" href="../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;&amp;'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>T, T, T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>&gt; for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-From%3C%26%27a%20(T%2C%20T%2C%20T)%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#298-306' title='goto source code'>[src]</a></span></h3>
  177. <div class='impl-items'><h4 id='method.from-14' class="method"><span id='from.v-14' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(set: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>T, T, T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>) -&gt; <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/spatial_dims.rs.html#299-305' title='goto source code'>[src]</a></span></h4>
  178. <div class='docblock'><p>Performs the conversion.</p>
  179. </div></div><h3 id='impl-From%3C%5BT%3B%203%5D%3E' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="../num_traits/trait.Num.html" title="trait num_traits::Num">Num</a> + <a class="trait" href="../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a>&gt; for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-From%3C%5BT%3B%203%5D%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#308-316' title='goto source code'>[src]</a></span></h3>
  180. <div class='impl-items'><h4 id='method.from-15' class="method"><span id='from.v-15' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(set: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a>) -&gt; <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/spatial_dims.rs.html#309-315' title='goto source code'>[src]</a></span></h4>
  181. <div class='docblock'><p>Performs the conversion.</p>
  182. </div></div><h3 id='impl-From%3C%26%27a%20%5BT%3B%203%5D%3E' class='impl'><span class='in-band'><code>impl&lt;'a, T:&nbsp;<a class="trait" href="../num_traits/trait.Num.html" title="trait num_traits::Num">Num</a> + <a class="trait" href="../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;&amp;'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a>&gt; for <a class="enum" href="../ocl/enum.SpatialDims.html" title="enum ocl::SpatialDims">SpatialDims</a></code><a href='#impl-From%3C%26%27a%20%5BT%3B%203%5D%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/ocl/standard/spatial_dims.rs.html#318-326' title='goto source code'>[src]</a></span></h3>
  183. <div class='impl-items'><h4 id='method.from-16' class="method"><span id='from.v-16' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(set: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a>) -&gt; <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/spatial_dims.rs.html#319-325' title='goto source code'>[src]</a></span></h4>
  184. <div class='docblock'><p>Performs the conversion.</p>
  185. </div></div></section>
  186. <section id='search' class="content hidden"></section>
  187. <section class="footer"></section>
  188. <aside id="help" class="hidden">
  189. <div>
  190. <h1 class="hidden">Help</h1>
  191. <div class="shortcuts">
  192. <h2>Keyboard Shortcuts</h2>
  193. <dl>
  194. <dt><kbd>?</kbd></dt>
  195. <dd>Show this help dialog</dd>
  196. <dt><kbd>S</kbd></dt>
  197. <dd>Focus the search field</dd>
  198. <dt><kbd>↑</kbd></dt>
  199. <dd>Move up in search results</dd>
  200. <dt><kbd>↓</kbd></dt>
  201. <dd>Move down in search results</dd>
  202. <dt><kbd>↹</kbd></dt>
  203. <dd>Switch tab</dd>
  204. <dt><kbd>&#9166;</kbd></dt>
  205. <dd>Go to active search result</dd>
  206. <dt><kbd>+</kbd></dt>
  207. <dd>Expand all sections</dd>
  208. <dt><kbd>-</kbd></dt>
  209. <dd>Collapse all sections</dd>
  210. </dl>
  211. </div>
  212. <div class="infos">
  213. <h2>Search Tricks</h2>
  214. <p>
  215. Prefix searches with a type followed by a colon (e.g.
  216. <code>fn:</code>) to restrict the search to a given type.
  217. </p>
  218. <p>
  219. Accepted types are: <code>fn</code>, <code>mod</code>,
  220. <code>struct</code>, <code>enum</code>,
  221. <code>trait</code>, <code>type</code>, <code>macro</code>,
  222. and <code>const</code>.
  223. </p>
  224. <p>
  225. Search functions by type signature (e.g.
  226. <code>vec -> usize</code> or <code>* -> vec</code>)
  227. </p>
  228. </div>
  229. </div>
  230. </aside>
  231. <script>
  232. window.rootPath = "../";
  233. window.currentCrate = "ocl";
  234. </script>
  235. <script src="../main.js"></script>
  236. <script defer src="../search-index.js"></script>
  237. </body>
  238. </html>