<!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="Source of the Rust file `/Users/erlendbasso/.cargo/registry/src/github.com-1ecc6299db9ec823/nalgebra-0.32.1/src/geometry/scale_construction.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>scale_construction.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-1f7d512b176f0f72.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Bold-124a1ca42af929b6.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-6827029ac823cab7.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../../static.files/light-ebce58d0a40c3431.css"><link rel="stylesheet" disabled href="../../../static.files/dark-f23faae4a2daf9a6.css"><link rel="stylesheet" disabled href="../../../static.files/ayu-8af5e100b21cd173.css"><script id="default-settings" ></script><script src="../../../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="../../../static.files/source-script-5cf2e01a42cc9858.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../static.files/main-c55e1eb52e1886b4.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="icon" href="https://nalgebra.org/img/favicon.ico"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../nalgebra/index.html"><img class="rust-logo" src="../../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
<a href="#96" id="96">96</a>
<a href="#97" id="97">97</a>
<a href="#98" id="98">98</a>
<a href="#99" id="99">99</a>
<a href="#100" id="100">100</a>
<a href="#101" id="101">101</a>
<a href="#102" id="102">102</a>
<a href="#103" id="103">103</a>
<a href="#104" id="104">104</a>
<a href="#105" id="105">105</a>
<a href="#106" id="106">106</a>
<a href="#107" id="107">107</a>
<a href="#108" id="108">108</a>
<a href="#109" id="109">109</a>
<a href="#110" id="110">110</a>
<a href="#111" id="111">111</a>
<a href="#112" id="112">112</a>
<a href="#113" id="113">113</a>
<a href="#114" id="114">114</a>
<a href="#115" id="115">115</a>
<a href="#116" id="116">116</a>
<a href="#117" id="117">117</a>
<a href="#118" id="118">118</a>
<a href="#119" id="119">119</a>
<a href="#120" id="120">120</a>
<a href="#121" id="121">121</a>
<a href="#122" id="122">122</a>
<a href="#123" id="123">123</a>
</pre><pre class="rust"><code><span class="attr">#[cfg(feature = <span class="string">"arbitrary"</span>)]
</span><span class="kw">use </span><span class="kw">crate</span>::base::storage::Owned;
<span class="attr">#[cfg(feature = <span class="string">"arbitrary"</span>)]
</span><span class="kw">use </span>quickcheck::{Arbitrary, Gen};
<span class="kw">use </span>num::One;
<span class="attr">#[cfg(feature = <span class="string">"rand-no-std"</span>)]
</span><span class="kw">use </span>rand::{
distributions::{Distribution, Standard},
Rng,
};
<span class="kw">use </span>simba::scalar::{ClosedMul, SupersetOf};
<span class="kw">use </span><span class="kw">crate</span>::base::{SVector, Scalar};
<span class="kw">use </span><span class="kw">crate</span>::geometry::Scale;
<span class="kw">impl</span><T: Scalar, <span class="kw">const </span>D: usize> Scale<T, D> {
<span class="doccomment">/// Creates a new identity scale.
///
/// # Example
/// ```
/// # use nalgebra::{Point2, Point3, Scale2, Scale3};
/// let t = Scale2::identity();
/// let p = Point2::new(1.0, 2.0);
/// assert_eq!(t * p, p);
///
/// // Works in all dimensions.
/// let t = Scale3::identity();
/// let p = Point3::new(1.0, 2.0, 3.0);
/// assert_eq!(t * p, p);
/// ```
</span><span class="attr">#[inline]
</span><span class="kw">pub fn </span>identity() -> Scale<T, D>
<span class="kw">where
</span>T: One,
{
Scale::from(SVector::from_element(T::one()))
}
<span class="doccomment">/// Cast the components of `self` to another type.
///
/// # Example
/// ```
/// # use nalgebra::Scale2;
/// let tra = Scale2::new(1.0f64, 2.0);
/// let tra2 = tra.cast::<f32>();
/// assert_eq!(tra2, Scale2::new(1.0f32, 2.0));
/// ```
</span><span class="kw">pub fn </span>cast<To: Scalar>(<span class="self">self</span>) -> Scale<To, D>
<span class="kw">where
</span>Scale<To, D>: SupersetOf<<span class="self">Self</span>>,
{
<span class="kw">crate</span>::convert(<span class="self">self</span>)
}
}
<span class="kw">impl</span><T: Scalar + One + ClosedMul, <span class="kw">const </span>D: usize> One <span class="kw">for </span>Scale<T, D> {
<span class="attr">#[inline]
</span><span class="kw">fn </span>one() -> <span class="self">Self </span>{
<span class="self">Self</span>::identity()
}
}
<span class="attr">#[cfg(feature = <span class="string">"rand-no-std"</span>)]
</span><span class="kw">impl</span><T: Scalar, <span class="kw">const </span>D: usize> Distribution<Scale<T, D>> <span class="kw">for </span>Standard
<span class="kw">where
</span>Standard: Distribution<T>,
{
<span class="doccomment">/// Generate an arbitrary random variate for testing purposes.
</span><span class="attr">#[inline]
</span><span class="kw">fn </span>sample<G: Rng + <span class="question-mark">?</span>Sized>(<span class="kw-2">&</span><span class="self">self</span>, rng: <span class="kw-2">&mut </span>G) -> Scale<T, D> {
Scale::from(rng.gen::<SVector<T, D>>())
}
}
<span class="attr">#[cfg(feature = <span class="string">"arbitrary"</span>)]
</span><span class="kw">impl</span><T: Scalar + Arbitrary + Send, <span class="kw">const </span>D: usize> Arbitrary <span class="kw">for </span>Scale<T, D>
<span class="kw">where
</span>Owned<T, <span class="kw">crate</span>::Const<D>>: Send,
{
<span class="attr">#[inline]
</span><span class="kw">fn </span>arbitrary(rng: <span class="kw-2">&mut </span>Gen) -> <span class="self">Self </span>{
<span class="kw">let </span>v: SVector<T, D> = Arbitrary::arbitrary(rng);
<span class="self">Self</span>::from(v)
}
}
<span class="comment">/*
*
* Small Scale construction from components.
*
*/
</span><span class="macro">macro_rules! </span>componentwise_constructors_impl(
($(<span class="macro-nonterminal">$doc</span>: expr; <span class="macro-nonterminal">$D</span>: expr, $(<span class="macro-nonterminal">$args</span>: ident:<span class="macro-nonterminal">$irow</span>: expr),<span class="kw-2">*</span>);* $(;)<span class="kw-2">*</span>) => {$(
<span class="kw">impl</span><T> Scale<T, <span class="macro-nonterminal">$D</span>>
{
<span class="attr">#[doc = <span class="string">"Initializes this Scale from its components."</span>]
#[doc = <span class="string">"# Example\n```"</span>]
#[doc = <span class="macro-nonterminal">$doc</span>]
#[doc = <span class="string">"```"</span>]
#[inline]
</span><span class="kw">pub const fn </span>new($(<span class="macro-nonterminal">$args</span>: T),<span class="kw-2">*</span>) -> <span class="self">Self </span>{
<span class="self">Self </span>{ vector: SVector::<T, <span class="macro-nonterminal">$D</span>>::new($(<span class="macro-nonterminal">$args</span>),<span class="kw-2">*</span>) }
}
}
)<span class="kw-2">*</span>}
);
<span class="macro">componentwise_constructors_impl!</span>(
<span class="string">"# use nalgebra::Scale1;\nlet t = Scale1::new(1.0);\nassert!(t.vector.x == 1.0);"</span>;
<span class="number">1</span>, x:<span class="number">0</span>;
<span class="string">"# use nalgebra::Scale2;\nlet t = Scale2::new(1.0, 2.0);\nassert!(t.vector.x == 1.0 && t.vector.y == 2.0);"</span>;
<span class="number">2</span>, x:<span class="number">0</span>, y:<span class="number">1</span>;
<span class="string">"# use nalgebra::Scale3;\nlet t = Scale3::new(1.0, 2.0, 3.0);\nassert!(t.vector.x == 1.0 && t.vector.y == 2.0 && t.vector.z == 3.0);"</span>;
<span class="number">3</span>, x:<span class="number">0</span>, y:<span class="number">1</span>, z:<span class="number">2</span>;
<span class="string">"# use nalgebra::Scale4;\nlet t = Scale4::new(1.0, 2.0, 3.0, 4.0);\nassert!(t.vector.x == 1.0 && t.vector.y == 2.0 && t.vector.z == 3.0 && t.vector.w == 4.0);"</span>;
<span class="number">4</span>, x:<span class="number">0</span>, y:<span class="number">1</span>, z:<span class="number">2</span>, w:<span class="number">3</span>;
<span class="string">"# use nalgebra::Scale5;\nlet t = Scale5::new(1.0, 2.0, 3.0, 4.0, 5.0);\nassert!(t.vector.x == 1.0 && t.vector.y == 2.0 && t.vector.z == 3.0 && t.vector.w == 4.0 && t.vector.a == 5.0);"</span>;
<span class="number">5</span>, x:<span class="number">0</span>, y:<span class="number">1</span>, z:<span class="number">2</span>, w:<span class="number">3</span>, a:<span class="number">4</span>;
<span class="string">"# use nalgebra::Scale6;\nlet t = Scale6::new(1.0, 2.0, 3.0, 4.0, 5.0, 6.0);\nassert!(t.vector.x == 1.0 && t.vector.y == 2.0 && t.vector.z == 3.0 && t.vector.w == 4.0 && t.vector.a == 5.0 && t.vector.b == 6.0);"</span>;
<span class="number">6</span>, x:<span class="number">0</span>, y:<span class="number">1</span>, z:<span class="number">2</span>, w:<span class="number">3</span>, a:<span class="number">4</span>, b:<span class="number">5</span>;
);
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="nalgebra" data-themes="" data-resource-suffix="" data-rustdoc-version="1.67.1 (d5a82bbd2 2023-02-07)" data-search-js="search-444266647c4dba98.js" data-settings-js="settings-bebeae96e00e4617.js" data-settings-css="settings-af96d9e2fc13e081.css" ></div></body></html>