Skip to content
This repository has been archived by the owner on Dec 30, 2019. It is now read-only.

Commit

Permalink
doc/automatic: update
Browse files Browse the repository at this point in the history
  • Loading branch information
Sir Mergealot committed Apr 6, 2018
1 parent da5c779 commit fa30c12
Show file tree
Hide file tree
Showing 158 changed files with 4,204 additions and 1,785 deletions.
1 change: 1 addition & 0 deletions brush.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 27 additions & 16 deletions coaster/backend/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,11 @@
<title>coaster::backend - 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">
<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>



Expand All @@ -33,6 +36,13 @@
<p class='location'>Module backend</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'><a href='../index.html'>coaster</a></p><script>window.sidebarCurrent = {name: 'backend', ty: 'mod', 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">
Expand All @@ -51,21 +61,17 @@ <h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>coaster</a>
</a>
</span><a class='srclink' href='../../src/coaster/backend.rs.html#1-136' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Provides the interface for running parallel computations on one ore many devices.</p>

<p>This is the abstraction over which you are interacting with your devices. You can create a
backend for computation by first choosing a specific <a href="../frameworks/index.html">Framework</a> such as OpenCL and
afterwards selecting one or many available hardwares to create a backend.</p>

<p>A backend provides you with the functionality of managing the memory of the devices and copying
your objects from host to devices and the other way around. Additionally you can execute
operations in parallel through kernel functions on the device(s) of the backend.</p>

<h2 id='architecture' class='section-header'><a href='#architecture'>Architecture</a></h2>
<h2 id="architecture" class="section-header"><a href="#architecture">Architecture</a></h2>
<p>The initialization of a backend happens through the BackendConfig, which defines which
<a href="../framework/index.html">framework</a> should be used and which <a href="../program/index.html">programs</a> should be available for
parallel execution.</p>

<h2 id='examples' class='section-header'><a href='#examples'>Examples</a></h2>
<h2 id="examples" class="section-header"><a href="#examples">Examples</a></h2>
<pre class="rust rust-example-rendered">
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">coaster</span> <span class="kw">as</span> <span class="ident">co</span>;
<span class="kw">use</span> <span class="ident">co</span>::<span class="ident">framework</span>::<span class="kw-2">*</span>;
Expand All @@ -91,13 +97,15 @@ <h2 id='examples' class='section-header'><a href='#examples'>Examples</a></h2>
title='struct coaster::backend::Backend'>Backend</a></td>
<td class='docblock-short'>
<p>Defines the main and highest struct of Coaster.</p>

</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.BackendConfig.html"
title='struct coaster::backend::BackendConfig'>BackendConfig</a></td>
<td class='docblock-short'>
<p>Provides Backend Configuration.</p>

</td>
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
Expand All @@ -106,6 +114,7 @@ <h2 id='examples' class='section-header'><a href='#examples'>Examples</a></h2>
title='trait coaster::backend::IBackend'>IBackend</a></td>
<td class='docblock-short'>
<p>Describes a Backend.</p>

</td>
</tr></table></section>
<section id='search' class="content hidden"></section>
Expand All @@ -120,20 +129,22 @@ <h1 class="hidden">Help</h1>
<h2>Keyboard Shortcuts</h2>

<dl>
<dt>?</dt>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt>↑</dt>
<dt><kbd>↑</kbd></dt>
<dd>Move up in search results</dd>
<dt>↓</dt>
<dt><kbd>↓</kbd></dt>
<dd>Move down in search results</dd>
<dt>↹</dt>
<dt><kbd>↹</kbd></dt>
<dd>Switch tab</dd>
<dt>&#9166;</dt>
<dt><kbd>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
<dt style="width:31px;">+ / -</dt>
<dd>Collapse/expand all sections</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>

Expand Down
36 changes: 24 additions & 12 deletions coaster/backend/struct.Backend.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,11 @@
<title>coaster::backend::Backend - 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">
<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>



Expand All @@ -33,6 +36,13 @@
<p class='location'>Struct Backend</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.hardwares">hardwares</a><a href="#method.framework">framework</a><a href="#method.device">device</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Clone">Clone</a><a href="#impl-IBackend">IBackend</a></div></div><p class='location'><a href='../index.html'>coaster</a>::<wbr><a href='index.html'>backend</a></p><script>window.sidebarCurrent = {name: 'Backend', 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">
Expand All @@ -59,9 +69,9 @@ <h3 id='impl' class='impl'><span class='in-band'><code>impl&lt;F:&nbsp;<a class=
<div class='docblock'><p>Defines the functionality of the Backend.</p>
</div><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>(config: <a class="struct" href="../../coaster/backend/struct.BackendConfig.html" title="struct coaster::backend::BackendConfig">BackendConfig</a>&lt;F&gt;) -&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="struct" href="../../coaster/backend/struct.Backend.html" title="struct coaster::backend::Backend">Backend</a>&lt;F&gt;, <a class="enum" href="../../coaster/error/enum.Error.html" title="enum coaster::error::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/coaster/backend.rs.html#68-76' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Initialize a new native Backend from a BackendConfig.</p>
</div><h4 id='method.hardwares' class="method"><span id='hardwares.v' class='invisible'><code>pub fn <a href='#method.hardwares' class='fnname'>hardwares</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a>F::<a class="type" href="../../coaster/framework/trait.IFramework.html#associatedtype.H" title="type coaster::framework::IFramework::H">H</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/coaster/backend.rs.html#79-81' title='goto source code'>[src]</a></span></h4>
</div><h4 id='method.hardwares' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></h3><code class="content"><span class="where fmt-newline">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span><span class="where fmt-newline">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></span></code></div></div><span id='hardwares.v' class='invisible'><code>pub fn <a href='#method.hardwares' class='fnname'>hardwares</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a>F::<a class="type" href="../../coaster/framework/trait.IFramework.html#associatedtype.H" title="type coaster::framework::IFramework::H">H</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/coaster/backend.rs.html#79-81' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the available hardware.</p>
</div><h4 id='method.framework' class="method"><span id='framework.v' class='invisible'><code>pub fn <a href='#method.framework' class='fnname'>framework</a>(&amp;self) -&gt; &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;F&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/coaster/backend.rs.html#84-86' title='goto source code'>[src]</a></span></h4>
</div><h4 id='method.framework' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;R&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;R&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;R&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;R&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></span><span class="where fmt-newline">impl&lt;W&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;W&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></span><span class="where fmt-newline">impl&lt;I&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;I&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = &lt;I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='framework.v' class='invisible'><code>pub fn <a href='#method.framework' class='fnname'>framework</a>(&amp;self) -&gt; &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;F&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/coaster/backend.rs.html#84-86' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the backend framework.</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; &amp;F::<a class="type" href="../../coaster/framework/trait.IFramework.html#associatedtype.D" title="type coaster::framework::IFramework::D">D</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/coaster/backend.rs.html#89-91' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the backend device.</p>
Expand Down Expand Up @@ -117,20 +127,22 @@ <h1 class="hidden">Help</h1>
<h2>Keyboard Shortcuts</h2>

<dl>
<dt>?</dt>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt>↑</dt>
<dt><kbd>↑</kbd></dt>
<dd>Move up in search results</dd>
<dt>↓</dt>
<dt><kbd>↓</kbd></dt>
<dd>Move down in search results</dd>
<dt>↹</dt>
<dt><kbd>↹</kbd></dt>
<dd>Switch tab</dd>
<dt>&#9166;</dt>
<dt><kbd>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
<dt style="width:31px;">+ / -</dt>
<dd>Collapse/expand all sections</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>

Expand Down
Loading

0 comments on commit fa30c12

Please sign in to comment.