<!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/base/storage.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>storage.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>
<a href="#124" id="124">124</a>
<a href="#125" id="125">125</a>
<a href="#126" id="126">126</a>
<a href="#127" id="127">127</a>
<a href="#128" id="128">128</a>
<a href="#129" id="129">129</a>
<a href="#130" id="130">130</a>
<a href="#131" id="131">131</a>
<a href="#132" id="132">132</a>
<a href="#133" id="133">133</a>
<a href="#134" id="134">134</a>
<a href="#135" id="135">135</a>
<a href="#136" id="136">136</a>
<a href="#137" id="137">137</a>
<a href="#138" id="138">138</a>
<a href="#139" id="139">139</a>
<a href="#140" id="140">140</a>
<a href="#141" id="141">141</a>
<a href="#142" id="142">142</a>
<a href="#143" id="143">143</a>
<a href="#144" id="144">144</a>
<a href="#145" id="145">145</a>
<a href="#146" id="146">146</a>
<a href="#147" id="147">147</a>
<a href="#148" id="148">148</a>
<a href="#149" id="149">149</a>
<a href="#150" id="150">150</a>
<a href="#151" id="151">151</a>
<a href="#152" id="152">152</a>
<a href="#153" id="153">153</a>
<a href="#154" id="154">154</a>
<a href="#155" id="155">155</a>
<a href="#156" id="156">156</a>
<a href="#157" id="157">157</a>
<a href="#158" id="158">158</a>
<a href="#159" id="159">159</a>
<a href="#160" id="160">160</a>
<a href="#161" id="161">161</a>
<a href="#162" id="162">162</a>
<a href="#163" id="163">163</a>
<a href="#164" id="164">164</a>
<a href="#165" id="165">165</a>
<a href="#166" id="166">166</a>
<a href="#167" id="167">167</a>
<a href="#168" id="168">168</a>
<a href="#169" id="169">169</a>
<a href="#170" id="170">170</a>
<a href="#171" id="171">171</a>
<a href="#172" id="172">172</a>
<a href="#173" id="173">173</a>
<a href="#174" id="174">174</a>
<a href="#175" id="175">175</a>
<a href="#176" id="176">176</a>
<a href="#177" id="177">177</a>
<a href="#178" id="178">178</a>
<a href="#179" id="179">179</a>
<a href="#180" id="180">180</a>
<a href="#181" id="181">181</a>
<a href="#182" id="182">182</a>
<a href="#183" id="183">183</a>
<a href="#184" id="184">184</a>
<a href="#185" id="185">185</a>
<a href="#186" id="186">186</a>
<a href="#187" id="187">187</a>
<a href="#188" id="188">188</a>
<a href="#189" id="189">189</a>
<a href="#190" id="190">190</a>
<a href="#191" id="191">191</a>
<a href="#192" id="192">192</a>
<a href="#193" id="193">193</a>
<a href="#194" id="194">194</a>
<a href="#195" id="195">195</a>
<a href="#196" id="196">196</a>
<a href="#197" id="197">197</a>
<a href="#198" id="198">198</a>
<a href="#199" id="199">199</a>
<a href="#200" id="200">200</a>
<a href="#201" id="201">201</a>
<a href="#202" id="202">202</a>
<a href="#203" id="203">203</a>
<a href="#204" id="204">204</a>
<a href="#205" id="205">205</a>
<a href="#206" id="206">206</a>
<a href="#207" id="207">207</a>
<a href="#208" id="208">208</a>
<a href="#209" id="209">209</a>
<a href="#210" id="210">210</a>
<a href="#211" id="211">211</a>
<a href="#212" id="212">212</a>
<a href="#213" id="213">213</a>
<a href="#214" id="214">214</a>
<a href="#215" id="215">215</a>
<a href="#216" id="216">216</a>
<a href="#217" id="217">217</a>
<a href="#218" id="218">218</a>
<a href="#219" id="219">219</a>
<a href="#220" id="220">220</a>
<a href="#221" id="221">221</a>
<a href="#222" id="222">222</a>
<a href="#223" id="223">223</a>
<a href="#224" id="224">224</a>
<a href="#225" id="225">225</a>
<a href="#226" id="226">226</a>
<a href="#227" id="227">227</a>
<a href="#228" id="228">228</a>
<a href="#229" id="229">229</a>
<a href="#230" id="230">230</a>
<a href="#231" id="231">231</a>
<a href="#232" id="232">232</a>
<a href="#233" id="233">233</a>
<a href="#234" id="234">234</a>
<a href="#235" id="235">235</a>
<a href="#236" id="236">236</a>
<a href="#237" id="237">237</a>
<a href="#238" id="238">238</a>
<a href="#239" id="239">239</a>
<a href="#240" id="240">240</a>
<a href="#241" id="241">241</a>
<a href="#242" id="242">242</a>
<a href="#243" id="243">243</a>
<a href="#244" id="244">244</a>
<a href="#245" id="245">245</a>
<a href="#246" id="246">246</a>
<a href="#247" id="247">247</a>
<a href="#248" id="248">248</a>
<a href="#249" id="249">249</a>
<a href="#250" id="250">250</a>
<a href="#251" id="251">251</a>
<a href="#252" id="252">252</a>
<a href="#253" id="253">253</a>
<a href="#254" id="254">254</a>
<a href="#255" id="255">255</a>
<a href="#256" id="256">256</a>
<a href="#257" id="257">257</a>
<a href="#258" id="258">258</a>
<a href="#259" id="259">259</a>
<a href="#260" id="260">260</a>
<a href="#261" id="261">261</a>
<a href="#262" id="262">262</a>
<a href="#263" id="263">263</a>
</pre><pre class="rust"><code><span class="doccomment">//! Abstract definition of a matrix data storage.
</span><span class="kw">use </span>std::ptr;
<span class="kw">use </span><span class="kw">crate</span>::base::allocator::{Allocator, SameShapeC, SameShapeR};
<span class="kw">use </span><span class="kw">crate</span>::base::default_allocator::DefaultAllocator;
<span class="kw">use </span><span class="kw">crate</span>::base::dimension::{Dim, U1};
<span class="kw">use </span><span class="kw">crate</span>::base::Scalar;
<span class="comment">/*
* Aliases for allocation results.
*/
</span><span class="doccomment">/// The data storage for the sum of two matrices with dimensions `(R1, C1)` and `(R2, C2)`.
</span><span class="kw">pub type </span>SameShapeStorage<T, R1, C1, R2, C2> =
<DefaultAllocator <span class="kw">as </span>Allocator<T, SameShapeR<R1, R2>, SameShapeC<C1, C2>>>::Buffer;
<span class="comment">// TODO: better name than Owned ?
</span><span class="doccomment">/// The owned data storage that can be allocated from `S`.
</span><span class="kw">pub type </span>Owned<T, R, C = U1> = <DefaultAllocator <span class="kw">as </span>Allocator<T, R, C>>::Buffer;
<span class="doccomment">/// The owned data storage that can be allocated from `S`.
</span><span class="kw">pub type </span>OwnedUninit<T, R, C = U1> = <DefaultAllocator <span class="kw">as </span>Allocator<T, R, C>>::BufferUninit;
<span class="doccomment">/// The row-stride of the owned data storage for a buffer of dimension `(R, C)`.
</span><span class="kw">pub type </span>RStride<T, R, C = U1> =
<<DefaultAllocator <span class="kw">as </span>Allocator<T, R, C>>::Buffer <span class="kw">as </span>RawStorage<T, R, C>>::RStride;
<span class="doccomment">/// The column-stride of the owned data storage for a buffer of dimension `(R, C)`.
</span><span class="kw">pub type </span>CStride<T, R, C = U1> =
<<DefaultAllocator <span class="kw">as </span>Allocator<T, R, C>>::Buffer <span class="kw">as </span>RawStorage<T, R, C>>::CStride;
<span class="doccomment">/// The trait shared by all matrix data storage.
///
/// TODO: doc
/// In generic code, it is recommended use the `Storage` trait bound instead. The `RawStorage`
/// trait bound is generally used by code that needs to work with storages that contains
/// `MaybeUninit<T>` elements.
///
/// Note that `Self` must always have a number of elements compatible with the matrix length (given
/// by `R` and `C` if they are known at compile-time). For example, implementors of this trait
/// should **not** allow the user to modify the size of the underlying buffer with safe methods
/// (for example the `VecStorage::data_mut` method is unsafe because the user could change the
/// vector's size so that it no longer contains enough elements: this will lead to UB.
</span><span class="kw">pub unsafe trait </span>RawStorage<T, R: Dim, C: Dim = U1>: Sized {
<span class="doccomment">/// The static stride of this storage's rows.
</span><span class="kw">type </span>RStride: Dim;
<span class="doccomment">/// The static stride of this storage's columns.
</span><span class="kw">type </span>CStride: Dim;
<span class="doccomment">/// The matrix data pointer.
</span><span class="kw">fn </span>ptr(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">*const </span>T;
<span class="doccomment">/// The dimension of the matrix at run-time. Arr length of zero indicates the additive identity
/// element of any dimension. Must be equal to `Self::dimension()` if it is not `None`.
</span><span class="kw">fn </span>shape(<span class="kw-2">&</span><span class="self">self</span>) -> (R, C);
<span class="doccomment">/// The spacing between consecutive row elements and consecutive column elements.
///
/// For example this returns `(1, 5)` for a row-major matrix with 5 columns.
</span><span class="kw">fn </span>strides(<span class="kw-2">&</span><span class="self">self</span>) -> (<span class="self">Self</span>::RStride, <span class="self">Self</span>::CStride);
<span class="doccomment">/// Compute the index corresponding to the irow-th row and icol-th column of this matrix. The
/// index must be such that the following holds:
///
/// ```ignore
/// let lindex = self.linear_index(irow, icol);
/// assert!(*self.get_unchecked(irow, icol) == *self.get_unchecked_linear(lindex))
/// ```
</span><span class="attr">#[inline]
</span><span class="kw">fn </span>linear_index(<span class="kw-2">&</span><span class="self">self</span>, irow: usize, icol: usize) -> usize {
<span class="kw">let </span>(rstride, cstride) = <span class="self">self</span>.strides();
irow * rstride.value() + icol * cstride.value()
}
<span class="doccomment">/// Gets the address of the i-th matrix component without performing bound-checking.
///
/// # Safety
/// If the index is out of bounds, dereferencing the result will cause undefined behavior.
</span><span class="attr">#[inline]
</span><span class="kw">fn </span>get_address_unchecked_linear(<span class="kw-2">&</span><span class="self">self</span>, i: usize) -> <span class="kw-2">*const </span>T {
<span class="self">self</span>.ptr().wrapping_add(i)
}
<span class="doccomment">/// Gets the address of the i-th matrix component without performing bound-checking.
///
/// # Safety
/// If the index is out of bounds, dereferencing the result will cause undefined behavior.
</span><span class="attr">#[inline]
</span><span class="kw">fn </span>get_address_unchecked(<span class="kw-2">&</span><span class="self">self</span>, irow: usize, icol: usize) -> <span class="kw-2">*const </span>T {
<span class="self">self</span>.get_address_unchecked_linear(<span class="self">self</span>.linear_index(irow, icol))
}
<span class="doccomment">/// Retrieves a reference to the i-th element without bound-checking.
///
/// # Safety
/// If the index is out of bounds, the method will cause undefined behavior.
</span><span class="attr">#[inline]
</span><span class="kw">unsafe fn </span>get_unchecked_linear(<span class="kw-2">&</span><span class="self">self</span>, i: usize) -> <span class="kw-2">&</span>T {
<span class="kw-2">&*</span><span class="self">self</span>.get_address_unchecked_linear(i)
}
<span class="doccomment">/// Retrieves a reference to the i-th element without bound-checking.
///
/// # Safety
/// If the index is out of bounds, the method will cause undefined behavior.
</span><span class="attr">#[inline]
</span><span class="kw">unsafe fn </span>get_unchecked(<span class="kw-2">&</span><span class="self">self</span>, irow: usize, icol: usize) -> <span class="kw-2">&</span>T {
<span class="self">self</span>.get_unchecked_linear(<span class="self">self</span>.linear_index(irow, icol))
}
<span class="doccomment">/// Indicates whether this data buffer stores its elements contiguously.
///
/// # Safety
/// This function must not return `true` if the underlying storage is not contiguous,
/// or undefined behaviour will occur.
</span><span class="kw">fn </span>is_contiguous(<span class="kw-2">&</span><span class="self">self</span>) -> bool;
<span class="doccomment">/// Retrieves the data buffer as a contiguous slice.
///
/// # Safety
/// The matrix components may not be stored in a contiguous way, depending on the strides.
/// This method is unsafe because this can yield to invalid aliasing when called on some pairs
/// of matrix views originating from the same matrix with strides.
///
/// Call the safe alternative `matrix.as_slice()` instead.
</span><span class="kw">unsafe fn </span>as_slice_unchecked(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[T];
}
<span class="doccomment">/// Trait shared by all matrix data storage that don’t contain any uninitialized elements.
</span><span class="kw">pub unsafe trait </span>Storage<T, R: Dim, C: Dim = U1>: RawStorage<T, R, C> {
<span class="doccomment">/// Builds a matrix data storage that does not contain any reference.
</span><span class="kw">fn </span>into_owned(<span class="self">self</span>) -> Owned<T, R, C>
<span class="kw">where
</span>DefaultAllocator: Allocator<T, R, C>;
<span class="doccomment">/// Clones this data storage to one that does not contain any reference.
</span><span class="kw">fn </span>clone_owned(<span class="kw-2">&</span><span class="self">self</span>) -> Owned<T, R, C>
<span class="kw">where
</span>DefaultAllocator: Allocator<T, R, C>;
}
<span class="doccomment">/// Trait implemented by matrix data storage that can provide a mutable access to its elements.
///
/// In generic code, it is recommended use the `StorageMut` trait bound instead. The
/// `RawStorageMut` trait bound is generally used by code that needs to work with storages that
/// contains `MaybeUninit<T>` elements.
///
/// Note that a mutable access does not mean that the matrix owns its data. For example, a mutable
/// matrix view can provide mutable access to its elements even if it does not own its data (it
/// contains only an internal reference to them).
</span><span class="kw">pub unsafe trait </span>RawStorageMut<T, R: Dim, C: Dim = U1>: RawStorage<T, R, C> {
<span class="doccomment">/// The matrix mutable data pointer.
</span><span class="kw">fn </span>ptr_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">*mut </span>T;
<span class="doccomment">/// Gets the mutable address of the i-th matrix component without performing bound-checking.
///
/// # Safety
/// If the index is out of bounds, dereferencing the result will cause undefined behavior.
</span><span class="attr">#[inline]
</span><span class="kw">fn </span>get_address_unchecked_linear_mut(<span class="kw-2">&mut </span><span class="self">self</span>, i: usize) -> <span class="kw-2">*mut </span>T {
<span class="self">self</span>.ptr_mut().wrapping_add(i)
}
<span class="doccomment">/// Gets the mutable address of the i-th matrix component without performing bound-checking.
///
/// # Safety
/// If the index is out of bounds, dereferencing the result will cause undefined behavior.
</span><span class="attr">#[inline]
</span><span class="kw">fn </span>get_address_unchecked_mut(<span class="kw-2">&mut </span><span class="self">self</span>, irow: usize, icol: usize) -> <span class="kw-2">*mut </span>T {
<span class="kw">let </span>lid = <span class="self">self</span>.linear_index(irow, icol);
<span class="self">self</span>.get_address_unchecked_linear_mut(lid)
}
<span class="doccomment">/// Retrieves a mutable reference to the i-th element without bound-checking.
///
/// # Safety
/// If the index is out of bounds, the method will cause undefined behavior.
</span><span class="kw">unsafe fn </span>get_unchecked_linear_mut(<span class="kw-2">&mut </span><span class="self">self</span>, i: usize) -> <span class="kw-2">&mut </span>T {
<span class="kw-2">&mut *</span><span class="self">self</span>.get_address_unchecked_linear_mut(i)
}
<span class="doccomment">/// Retrieves a mutable reference to the element at `(irow, icol)` without bound-checking.
///
/// # Safety
/// If the index is out of bounds, the method will cause undefined behavior.
</span><span class="attr">#[inline]
</span><span class="kw">unsafe fn </span>get_unchecked_mut(<span class="kw-2">&mut </span><span class="self">self</span>, irow: usize, icol: usize) -> <span class="kw-2">&mut </span>T {
<span class="kw-2">&mut *</span><span class="self">self</span>.get_address_unchecked_mut(irow, icol)
}
<span class="doccomment">/// Swaps two elements using their linear index without bound-checking.
///
/// # Safety
/// If the indices are out of bounds, the method will cause undefined behavior.
</span><span class="attr">#[inline]
</span><span class="kw">unsafe fn </span>swap_unchecked_linear(<span class="kw-2">&mut </span><span class="self">self</span>, i1: usize, i2: usize) {
<span class="kw">let </span>a = <span class="self">self</span>.get_address_unchecked_linear_mut(i1);
<span class="kw">let </span>b = <span class="self">self</span>.get_address_unchecked_linear_mut(i2);
ptr::swap(a, b);
}
<span class="doccomment">/// Swaps two elements without bound-checking.
///
/// # Safety
/// If the indices are out of bounds, the method will cause undefined behavior.
</span><span class="attr">#[inline]
</span><span class="kw">unsafe fn </span>swap_unchecked(<span class="kw-2">&mut </span><span class="self">self</span>, row_col1: (usize, usize), row_col2: (usize, usize)) {
<span class="kw">let </span>lid1 = <span class="self">self</span>.linear_index(row_col1.<span class="number">0</span>, row_col1.<span class="number">1</span>);
<span class="kw">let </span>lid2 = <span class="self">self</span>.linear_index(row_col2.<span class="number">0</span>, row_col2.<span class="number">1</span>);
<span class="self">self</span>.swap_unchecked_linear(lid1, lid2)
}
<span class="doccomment">/// Retrieves the mutable data buffer as a contiguous slice.
///
/// Matrix components may not be contiguous, depending on its strides.
///
/// # Safety
/// The matrix components may not be stored in a contiguous way, depending on the strides.
/// This method is unsafe because this can yield to invalid aliasing when called on some pairs
/// of matrix slices originating from the same matrix with strides.
</span><span class="kw">unsafe fn </span>as_mut_slice_unchecked(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>[T];
}
<span class="doccomment">/// Trait shared by all mutable matrix data storage that don’t contain any uninitialized elements.
</span><span class="kw">pub unsafe trait </span>StorageMut<T, R: Dim, C: Dim = U1>:
Storage<T, R, C> + RawStorageMut<T, R, C>
{
}
<span class="kw">unsafe impl</span><S, T, R, C> StorageMut<T, R, C> <span class="kw">for </span>S
<span class="kw">where
</span>R: Dim,
C: Dim,
S: Storage<T, R, C> + RawStorageMut<T, R, C>,
{
}
<span class="doccomment">/// Marker trait indicating that a storage is stored contiguously in memory.
///
/// The storage requirement means that for any value of `i` in `[0, nrows * ncols - 1]`, the value
/// `.get_unchecked_linear` returns one of the matrix component. This trait is unsafe because
/// failing to comply to this may cause Undefined Behaviors.
</span><span class="kw">pub unsafe trait </span>IsContiguous {}
<span class="doccomment">/// A matrix storage that can be reshaped in-place.
</span><span class="kw">pub trait </span>ReshapableStorage<T, R1, C1, R2, C2>: RawStorage<T, R1, C1>
<span class="kw">where
</span>T: Scalar,
R1: Dim,
C1: Dim,
R2: Dim,
C2: Dim,
{
<span class="doccomment">/// The reshaped storage type.
</span><span class="kw">type </span>Output: RawStorage<T, R2, C2>;
<span class="doccomment">/// Reshapes the storage into the output storage type.
</span><span class="kw">fn </span>reshape_generic(<span class="self">self</span>, nrows: R2, ncols: C2) -> <span class="self">Self</span>::Output;
}
</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>