clfft 0.3.3

Bindings for clFFT, a FFT library for OpenCL.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177

<!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 `ProgramBuilder` struct in crate `ocl`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, ProgramBuilder">

    <title>ocl::builders::ProgramBuilder - Rust</title>

    <link rel="stylesheet" type="text/css" href="../../normalize.css">
    <link rel="stylesheet" type="text/css" href="../../rustdoc.css">
    <link rel="stylesheet" type="text/css" href="../../main.css">
    

    
    
</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">
        
        <p class='location'><a href='../index.html'>ocl</a>::<wbr><a href='index.html'>builders</a></p><script>window.sidebarCurrent = {name: 'ProgramBuilder', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
    </nav>

    <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 href='index.html'>builders</a>::<wbr><a class="struct" href=''>ProgramBuilder</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/program.rs.html#183-188' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'><div class="docblock attributes">#[must_use = "builders do nothing unless \'::build\' is called"]
</div>pub struct ProgramBuilder { /* fields omitted */ }</pre><div class='docblock'><p>A builder for <code>Program</code>.</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../../ocl/builders/struct.ProgramBuilder.html" title="struct ocl::builders::ProgramBuilder">ProgramBuilder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/program.rs.html#190-466' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a>() -&gt; <a class="struct" href="../../ocl/builders/struct.ProgramBuilder.html" title="struct ocl::builders::ProgramBuilder">ProgramBuilder</a></code></span></h4>
<div class='docblock'><p>Returns a new, empty, build configuration object.</p>
</div><h4 id='method.build' class="method"><span id='build.v' class='invisible'><code>fn <a href='#method.build' class='fnname'>build</a>(self, context: &amp;<a class="struct" href="../../ocl/struct.Context.html" title="struct ocl::Context">Context</a>) -&gt; <a class="type" href="../../ocl/type.Result.html" title="type ocl::Result">OclResult</a>&lt;<a class="struct" href="../../ocl/struct.Program.html" title="struct ocl::Program">Program</a>&gt;</code></span></h4>
<div class='docblock'><p>Returns a newly built Program.</p>
<ul>
<li>
<p>TODO: If the context is associated with more than one device,
check that at least one of those devices has been specified. An empty
device list will cause an <code>OpenCL</code> error in that case.</p>
</li>
<li>
<p>TODO: Check for duplicate devices in the final device list.</p>
</li>
</ul>
</div><h4 id='method.cmplr_def' class="method"><span id='cmplr_def.v' class='invisible'><code>fn <a href='#method.cmplr_def' class='fnname'>cmplr_def</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="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a>&gt;&gt;(self, name: S, val: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -&gt; <a class="struct" href="../../ocl/builders/struct.ProgramBuilder.html" title="struct ocl::builders::ProgramBuilder">ProgramBuilder</a></code></span></h4>
<div class='docblock'><p>Adds a build option containing a compiler command line definition.
Formatted as <code>-D {name}={val}</code>.</p>
<h2 id="example" class="section-header"><a href="#example">Example</a></h2>
<p><code>...cmplr_def(&quot;MAX_ITERS&quot;, 500)...</code></p>
</div><h4 id='method.cmplr_opt' class="method"><span id='cmplr_opt.v' class='invisible'><code>fn <a href='#method.cmplr_opt' class='fnname'>cmplr_opt</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="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a>&gt;&gt;(self, co: S) -&gt; <a class="struct" href="../../ocl/builders/struct.ProgramBuilder.html" title="struct ocl::builders::ProgramBuilder">ProgramBuilder</a></code></span></h4>
<div class='docblock'><p>Adds a build option containing a raw compiler command line parameter.
Formatted as <code>{}</code> (exact text).</p>
<h2 id="example-1" class="section-header"><a href="#example-1">Example</a></h2>
<p><code>...cmplr_opt(&quot;-g&quot;)...</code></p>
</div><h4 id='method.bo' class="method"><span id='bo.v' class='invisible'><code>fn <a href='#method.bo' class='fnname'>bo</a>(self, bo: <a class="enum" href="../../ocl/builders/enum.BuildOpt.html" title="enum ocl::builders::BuildOpt">BuildOpt</a>) -&gt; <a class="struct" href="../../ocl/builders/struct.ProgramBuilder.html" title="struct ocl::builders::ProgramBuilder">ProgramBuilder</a></code></span></h4>
<div class='docblock'><p>Pushes pre-created build option to the list of options.</p>
</div><h4 id='method.src_file' class="method"><span id='src_file.v' class='invisible'><code>fn <a href='#method.src_file' class='fnname'>src_file</a>&lt;P:&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="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a>&gt;&gt;(self, file_path: P) -&gt; <a class="struct" href="../../ocl/builders/struct.ProgramBuilder.html" title="struct ocl::builders::ProgramBuilder">ProgramBuilder</a></code></span></h4>
<div class='docblock'><p>Adds the contents of a file to the program.</p>
</div><h4 id='method.src' class="method"><span id='src.v' class='invisible'><code>fn <a href='#method.src' class='fnname'>src</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="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a>&gt;&gt;(self, src: S) -&gt; <a class="struct" href="../../ocl/builders/struct.ProgramBuilder.html" title="struct ocl::builders::ProgramBuilder">ProgramBuilder</a></code></span></h4>
<div class='docblock'><p>Adds raw text to the program source.</p>
</div><h4 id='method.devices' class="method"><span id='devices.v' class='invisible'><code>fn <a href='#method.devices' class='fnname'>devices</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/builders/enum.DeviceSpecifier.html" title="enum ocl::builders::DeviceSpecifier">DeviceSpecifier</a>&gt;&gt;(self, device_spec: D) -&gt; <a class="struct" href="../../ocl/builders/struct.ProgramBuilder.html" title="struct ocl::builders::ProgramBuilder">ProgramBuilder</a></code></span></h4>
<div class='docblock'><p>Specifies a list of devices to build this program on. The devices must
be associated with the context passed to <code>::build</code> later on.</p>
<p>Devices may be specified in any number of ways including simply
passing a device or slice of devices. See the <a href="enum.DeviceSpecifier.html#method.from"><code>impl From</code></a> section of
<a href="enum.DeviceSpecifier.html"><code>DeviceSpecifier</code></a> for more information.</p>
<h2 id="panics" class="section-header"><a href="#panics">Panics</a></h2>
<p>Devices must not have already been specified.</p>
</div><h4 id='method.get_device_spec' class="method"><span id='get_device_spec.v' class='invisible'><code>fn <a href='#method.get_device_spec' class='fnname'>get_device_spec</a>(&amp;self) -&gt; &amp;<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="enum" href="../../ocl/builders/enum.DeviceSpecifier.html" title="enum ocl::builders::DeviceSpecifier">DeviceSpecifier</a>&gt;</code></span></h4>
<div class='docblock'><p>Returns the devices specified to be associated the program.</p>
</div><h4 id='method.get_compiler_options' class="method"><span id='get_compiler_options.v' class='invisible'><code>fn <a href='#method.get_compiler_options' class='fnname'>get_compiler_options</a>(&amp;self) -&gt; <a class="type" href="../../ocl/type.Result.html" title="type ocl::Result">OclResult</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/std/ffi/c_str/struct.CString.html" title="struct std::ffi::c_str::CString">CString</a>&gt;</code></span></h4>
<div class='docblock'><p>Returns a concatenated string of command line options to be passed to
the compiler when building this program.</p>
</div><h4 id='method.get_src_strings' class="method"><span id='get_src_strings.v' class='invisible'><code>fn <a href='#method.get_src_strings' class='fnname'>get_src_strings</a>(&amp;self) -&gt; <a class="type" href="../../ocl/type.Result.html" title="type ocl::Result">OclResult</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html" title="struct collections::vec::Vec">Vec</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/std/ffi/c_str/struct.CString.html" title="struct std::ffi::c_str::CString">CString</a>&gt;&gt;</code></span></h4>
<div class='docblock'><p>Returns the final program source code as a list of strings.</p>
<h3 id="order-of-inclusion" class="section-header"><a href="#order-of-inclusion">Order of Inclusion</a></h3>
<ol>
<li>Macro definitions and code strings specified by a
<code>BuildOpt::IncludeDefine</code> or <code>BuildOpt::IncludeRaw</code> via <code>::bo</code></li>
<li>Contents of files specified via <code>::src_file</code></li>
<li>Contents of strings specified via <code>::src</code> or a
<code>BuildOpt::IncludeRawEof</code> via <code>::bo</code></li>
</ol>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 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/builders/struct.ProgramBuilder.html" title="struct ocl::builders::ProgramBuilder">ProgramBuilder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/program.rs.html#182' 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/builders/struct.ProgramBuilder.html" title="struct ocl::builders::ProgramBuilder">ProgramBuilder</a></code></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: &amp;Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></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 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/builders/struct.ProgramBuilder.html" title="struct ocl::builders::ProgramBuilder">ProgramBuilder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl/standard/program.rs.html#182' 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></h4>
<div class='docblock'><p>Formats the value using the given formatter.</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>?</dt>
                    <dd>Show this help dialog</dd>
                    <dt>S</dt>
                    <dd>Focus the search field</dd>
                    <dt>&larrb;</dt>
                    <dd>Move up in search results</dd>
                    <dt>&rarrb;</dt>
                    <dd>Move down in search results</dd>
                    <dt>&#9166;</dt>
                    <dd>Go to active search result</dd>
                    <dt>+</dt>
                    <dd>Collapse/expand 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="../../jquery.js"></script>
    <script src="../../main.js"></script>
    <script defer src="../../search-index.js"></script>
</body>
</html>