scad 1.2.2

A crate for generating OpenSCAD models using rust
Documentation 
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

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

    <title>rand::XorShiftRng - Rust</title>

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

    <link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico">
    
</head>
<body class="rustdoc">
    <!--[if lte IE 8]>
    <div class="warning">
        This old browser is unsupported and will most likely display funky
        things.
    </div>
    <![endif]-->

    

    <nav class="sidebar">
        <a href='../rand/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk.png' alt='logo' width='100'></a>
        <p class='location'><a href='index.html'>rand</a></p><script>window.sidebarCurrent = {name: 'XorShiftRng', 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 struct">
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>rand</a>::<wbr><a class='struct' href=''>XorShiftRng</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 id='src-1600' class='srclink' href='../src/rand/lib.rs.html#668-673' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct XorShiftRng { /* fields omitted */ }</pre><div class='docblock'><p>An Xorshift[1] random number
generator.</p>

<p>The Xorshift algorithm is not suitable for cryptographic purposes
but is very fast. If you do not know for sure that it fits your
requirements, use a more secure one such as <code>IsaacRng</code> or <code>OsRng</code>.</p>

<p>[1]: Marsaglia, George (July 2003). <a href="http://www.jstatsoft.org/v08/i14/paper">&quot;Xorshift
RNGs&quot;</a>. <em>Journal of
Statistical Software</em>. Vol. 8 (Issue 14).</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class='struct' href='../rand/struct.XorShiftRng.html' title='rand::XorShiftRng'>XorShiftRng</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-1612' class='srclink' href='../src/rand/lib.rs.html#675-690' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new_unseeded' class='method'><span id='new_unseeded.v' class='invisible'><code>fn <a href='#method.new_unseeded' class='fnname'>new_unseeded</a>() -&gt; <a class='struct' href='../rand/struct.XorShiftRng.html' title='rand::XorShiftRng'>XorShiftRng</a></code></span></h4>
<div class='docblock'><p>Creates a new XorShiftRng instance which is not seeded.</p>

<p>The initial values of this RNG are constants, so all generators created
by this function will yield the same stream of random numbers. It is
highly recommended that this is created through <code>SeedableRng</code> instead of
this function</p>
</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='core::clone::Clone'>Clone</a> for <a class='struct' href='../rand/struct.XorShiftRng.html' title='rand::XorShiftRng'>XorShiftRng</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-1605' class='srclink' href='../src/rand/lib.rs.html#667' 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='../rand/struct.XorShiftRng.html' title='rand::XorShiftRng'>XorShiftRng</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='../rand/trait.Rng.html' title='rand::Rng'>Rng</a> for <a class='struct' href='../rand/struct.XorShiftRng.html' title='rand::XorShiftRng'>XorShiftRng</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-1614' class='srclink' href='../src/rand/lib.rs.html#692-704' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.next_u32' class='method'><span id='next_u32.v' class='invisible'><code>fn <a href='../rand/trait.Rng.html#tymethod.next_u32' class='fnname'>next_u32</a>(&amp;mut self) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a></code></span></h4>
<div class='docblock'><p>Return the next random u32. <a href="../rand/trait.Rng.html#tymethod.next_u32">Read more</a></p>
</div><h4 id='method.next_u64' class='method'><span id='next_u64.v' class='invisible'><code>fn <a href='../rand/trait.Rng.html#method.next_u64' class='fnname'>next_u64</a>(&amp;mut self) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u64.html'>u64</a></code></span></h4>
<div class='docblock'><p>Return the next random u64. <a href="../rand/trait.Rng.html#method.next_u64">Read more</a></p>
</div><h4 id='method.next_f32' class='method'><span id='next_f32.v' class='invisible'><code>fn <a href='../rand/trait.Rng.html#method.next_f32' class='fnname'>next_f32</a>(&amp;mut self) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.f32.html'>f32</a></code></span></h4>
<div class='docblock'><p>Return the next random f32 selected from the half-open interval <code>[0, 1)</code>. <a href="../rand/trait.Rng.html#method.next_f32">Read more</a></p>
</div><h4 id='method.next_f64' class='method'><span id='next_f64.v' class='invisible'><code>fn <a href='../rand/trait.Rng.html#method.next_f64' class='fnname'>next_f64</a>(&amp;mut self) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.f64.html'>f64</a></code></span></h4>
<div class='docblock'><p>Return the next random f64 selected from the half-open interval <code>[0, 1)</code>. <a href="../rand/trait.Rng.html#method.next_f64">Read more</a></p>
</div><h4 id='method.fill_bytes' class='method'><span id='fill_bytes.v' class='invisible'><code>fn <a href='../rand/trait.Rng.html#method.fill_bytes' class='fnname'>fill_bytes</a>(&amp;mut self, dest: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>&amp;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>)</code></span></h4>
<div class='docblock'><p>Fill <code>dest</code> with random data. <a href="../rand/trait.Rng.html#method.fill_bytes">Read more</a></p>
</div><h4 id='method.gen' class='method'><span id='gen.v' class='invisible'><code>fn <a href='../rand/trait.Rng.html#method.gen' class='fnname'>gen</a>&lt;T:&nbsp;<a class='trait' href='../rand/trait.Rand.html' title='rand::Rand'>Rand</a>&gt;(&amp;mut self) -&gt; T <span class='where'>where Self: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></span></h4>
<div class='docblock'><p>Return a random value of a <code>Rand</code> type. <a href="../rand/trait.Rng.html#method.gen">Read more</a></p>
</div><h4 id='method.gen_iter' class='method'><span id='gen_iter.v' class='invisible'><code>fn <a href='../rand/trait.Rng.html#method.gen_iter' class='fnname'>gen_iter</a>&lt;'a,&nbsp;T:&nbsp;<a class='trait' href='../rand/trait.Rand.html' title='rand::Rand'>Rand</a>&gt;(&amp;'a mut self) -&gt; <a class='struct' href='../rand/struct.Generator.html' title='rand::Generator'>Generator</a>&lt;'a,&nbsp;T,&nbsp;Self&gt; <span class='where'>where Self: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></span></h4>
<div class='docblock'><p>Return an iterator that will yield an infinite number of randomly generated items. <a href="../rand/trait.Rng.html#method.gen_iter">Read more</a></p>
</div><h4 id='method.gen_range' class='method'><span id='gen_range.v' class='invisible'><code>fn <a href='../rand/trait.Rng.html#method.gen_range' class='fnname'>gen_range</a>&lt;T:&nbsp;<a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html' title='core::cmp::PartialOrd'>PartialOrd</a> + <a class='trait' href='../rand/distributions/range/trait.SampleRange.html' title='rand::distributions::range::SampleRange'>SampleRange</a>&gt;(&amp;mut self, low: T, high: T) -&gt; T <span class='where'>where Self: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></span></h4>
<div class='docblock'><p>Generate a random value in the range [<code>low</code>, <code>high</code>). <a href="../rand/trait.Rng.html#method.gen_range">Read more</a></p>
</div><h4 id='method.gen_weighted_bool' class='method'><span id='gen_weighted_bool.v' class='invisible'><code>fn <a href='../rand/trait.Rng.html#method.gen_weighted_bool' class='fnname'>gen_weighted_bool</a>(&amp;mut self, n: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a>) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a> <span class='where'>where Self: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></span></h4>
<div class='docblock'><p>Return a bool with a 1 in n chance of true <a href="../rand/trait.Rng.html#method.gen_weighted_bool">Read more</a></p>
</div><h4 id='method.gen_ascii_chars' class='method'><span id='gen_ascii_chars.v' class='invisible'><code>fn <a href='../rand/trait.Rng.html#method.gen_ascii_chars' class='fnname'>gen_ascii_chars</a>&lt;'a&gt;(&amp;'a mut self) -&gt; <a class='struct' href='../rand/struct.AsciiGenerator.html' title='rand::AsciiGenerator'>AsciiGenerator</a>&lt;'a,&nbsp;Self&gt; <span class='where'>where Self: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></span></h4>
<div class='docblock'><p>Return an iterator of random characters from the set A-Z,a-z,0-9. <a href="../rand/trait.Rng.html#method.gen_ascii_chars">Read more</a></p>
</div><h4 id='method.choose' class='method'><span id='choose.v' class='invisible'><code>fn <a href='../rand/trait.Rng.html#method.choose' class='fnname'>choose</a>&lt;'a,&nbsp;T&gt;(&amp;mut self, values: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>&amp;'a [</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>]</a>) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a>&lt;&amp;'a T&gt; <span class='where'>where Self: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></span></h4>
<div class='docblock'><p>Return a random element from <code>values</code>. <a href="../rand/trait.Rng.html#method.choose">Read more</a></p>
</div><h4 id='method.shuffle' class='method'><span id='shuffle.v' class='invisible'><code>fn <a href='../rand/trait.Rng.html#method.shuffle' class='fnname'>shuffle</a>&lt;T&gt;(&amp;mut self, values: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>&amp;mut [</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>]</a>) <span class='where'>where Self: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></span></h4>
<div class='docblock'><p>Shuffle a mutable slice in place. <a href="../rand/trait.Rng.html#method.shuffle">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='../rand/trait.SeedableRng.html' title='rand::SeedableRng'>SeedableRng</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.u32.html'>u32</a><a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.array.html'>; 4]</a>&gt; for <a class='struct' href='../rand/struct.XorShiftRng.html' title='rand::XorShiftRng'>XorShiftRng</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-1620' class='srclink' href='../src/rand/lib.rs.html#706-730' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.reseed' class='method'><span id='reseed.v' class='invisible'><code>fn <a href='../rand/trait.SeedableRng.html#tymethod.reseed' class='fnname'>reseed</a>(&amp;mut self, seed: <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.u32.html'>u32</a><a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.array.html'>; 4]</a>)</code></span></h4>
<div class='docblock'><p>Reseed an XorShiftRng. This will panic if <code>seed</code> is entirely 0.</p>
</div><h4 id='method.from_seed' class='method'><span id='from_seed.v' class='invisible'><code>fn <a href='../rand/trait.SeedableRng.html#tymethod.from_seed' class='fnname'>from_seed</a>(seed: <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.u32.html'>u32</a><a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.array.html'>; 4]</a>) -&gt; <a class='struct' href='../rand/struct.XorShiftRng.html' title='rand::XorShiftRng'>XorShiftRng</a></code></span></h4>
<div class='docblock'><p>Create a new XorShiftRng. This will panic if <code>seed</code> is entirely 0.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='../rand/trait.Rand.html' title='rand::Rand'>Rand</a> for <a class='struct' href='../rand/struct.XorShiftRng.html' title='rand::XorShiftRng'>XorShiftRng</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-1635' class='srclink' href='../src/rand/lib.rs.html#732-741' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.rand' class='method'><span id='rand.v' class='invisible'><code>fn <a href='../rand/trait.Rand.html#tymethod.rand' class='fnname'>rand</a>&lt;R:&nbsp;<a class='trait' href='../rand/trait.Rng.html' title='rand::Rng'>Rng</a>&gt;(rng: &amp;mut R) -&gt; <a class='struct' href='../rand/struct.XorShiftRng.html' title='rand::XorShiftRng'>XorShiftRng</a></code></span></h4>
<div class='docblock'><p>Generates a random instance of this type using the specified source of randomness. <a href="../rand/trait.Rand.html#tymethod.rand">Read more</a></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 = "rand";
        window.playgroundUrl = "";
    </script>
    <script src="../jquery.js"></script>
    <script src="../main.js"></script>
    
    <script defer src="../search-index.js"></script>
</body>
</html>