| <!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 `/root/.cargo/git/checkouts/rulinalg-309246e5a94bf5cf/1ed8b93/src/internal_utils.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>internal_utils.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></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"><a class="sidebar-logo" href="../../rulinalg/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../rulinalg/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" 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="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>matrix::{BaseMatrix, BaseMatrixMut}; |
| <span class="kw">use </span>libnum::{Zero, Num}; |
| <span class="kw">use </span>utils::in_place_vec_bin_op; |
| |
| <span class="kw">pub fn </span>nullify_lower_triangular_part<T, M>(matrix: <span class="kw-2">&mut </span>M) |
| <span class="kw">where </span>T: Zero, M: BaseMatrixMut<T> { |
| <span class="kw">for </span>(i, <span class="kw-2">mut </span>row) <span class="kw">in </span>matrix.row_iter_mut().enumerate() { |
| <span class="kw">for </span>element <span class="kw">in </span>row.raw_slice_mut().iter_mut().take(i) { |
| <span class="kw-2">*</span>element = T::zero(); |
| } |
| } |
| } |
| |
| <span class="kw">pub fn </span>nullify_upper_triangular_part<T, M>(matrix: <span class="kw-2">&mut </span>M) |
| <span class="kw">where </span>T: Zero, M: BaseMatrixMut<T> { |
| <span class="kw">for </span>(i, <span class="kw-2">mut </span>row) <span class="kw">in </span>matrix.row_iter_mut().enumerate() { |
| <span class="kw">for </span>element <span class="kw">in </span>row.raw_slice_mut().iter_mut().skip(i + <span class="number">1</span>) { |
| <span class="kw-2">*</span>element = T::zero(); |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Given a vector `x` and a `m x n` matrix `A`, compute |
| /// `y = A^T x`. |
| /// |
| /// This is a stopgap solution until we have a more proper |
| /// BLIS/BLAS-like API. |
| </span><span class="kw">pub fn </span>transpose_gemv<T, M>(a: <span class="kw-2">&</span>M, x: <span class="kw-2">&</span>[T], y: <span class="kw-2">&mut </span>[T]) |
| <span class="kw">where </span>M: BaseMatrix<T>, T: Num + Copy |
| { |
| <span class="kw">let </span>m = a.rows(); |
| <span class="kw">let </span>n = a.cols(); |
| |
| <span class="macro">assert!</span>(x.len() == m, <span class="string">"A and x must be dimensionally compatible."</span>); |
| <span class="macro">assert!</span>(y.len() == n, <span class="string">"A and y must be dimensionally compatible."</span>); |
| |
| <span class="kw">for </span>element <span class="kw">in </span>y.iter_mut() { |
| <span class="kw-2">*</span>element = T::zero(); |
| } |
| |
| <span class="kw">for </span>j <span class="kw">in </span><span class="number">0 </span>.. m { |
| <span class="kw">let </span>a_j = a.row(j).raw_slice(); |
| axpy(x[j], a_j, y); |
| } |
| } |
| |
| <span class="comment">// Given scalar `a` and vectors `x` and `y` of same length, computes the |
| // scalar-vector product `y <- y + a * x`. |
| // |
| </span><span class="doccomment">/// This function is a stopgap solution until we have a more proper |
| /// BLIS/BLAS-like API. |
| </span><span class="kw">pub fn </span>axpy<T>(a: T, x: <span class="kw-2">&</span>[T], y: <span class="kw-2">&mut </span>[T]) |
| <span class="kw">where </span>T: Num + Copy |
| { |
| <span class="macro">assert!</span>(x.len() == y.len()); |
| in_place_vec_bin_op(y, x, |y, x| { |
| <span class="kw-2">*</span>y = y.clone() + a * x.clone(); |
| }); |
| } |
| |
| <span class="doccomment">/// Given a `m x n` matrix `A` and vectors `x` and `y` and |
| /// a scalar `alpha`, perform the rank-1 update |
| /// `A <- A + alpha * x y^T`. |
| /// |
| /// This function is a stopgap solution until we have a more proper |
| /// BLIS/BLAS-like API. |
| </span><span class="kw">pub fn </span>ger<T, M>(a: <span class="kw-2">&mut </span>M, alpha: T, x: <span class="kw-2">&</span>[T], y: <span class="kw-2">&</span>[T]) |
| <span class="kw">where </span>M: BaseMatrixMut<T>, T: Num + Copy |
| { |
| <span class="kw">let </span>m = a.rows(); |
| <span class="kw">let </span>n = a.cols(); |
| |
| <span class="macro">assert!</span>(x.len() == m); |
| <span class="macro">assert!</span>(y.len() == n); |
| |
| <span class="kw">for </span>i <span class="kw">in </span><span class="number">0 </span>.. m { |
| <span class="kw">let </span><span class="kw-2">mut </span>a_i = a.row_mut(i).raw_slice_mut(); |
| <span class="comment">// Let a_i be the ith row. Then |
| // a_i <- a_i + alpha * x[i] * y |
| // is just an axpy operation |
| </span>axpy(alpha * x[i], <span class="kw-2">&</span>y, <span class="kw-2">&mut </span>a_i); |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use </span>vector::Vector; |
| |
| <span class="kw">use </span><span class="kw">super</span>::nullify_lower_triangular_part; |
| <span class="kw">use </span><span class="kw">super</span>::nullify_upper_triangular_part; |
| <span class="kw">use </span><span class="kw">super</span>::transpose_gemv; |
| <span class="kw">use </span><span class="kw">super</span>::ger; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>nullify_lower_triangular_part_examples() { |
| <span class="kw">let </span><span class="kw-2">mut </span>x = <span class="macro">matrix!</span>[<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>; |
| <span class="number">4.0</span>, <span class="number">5.0</span>, <span class="number">6.0</span>; |
| <span class="number">7.0</span>, <span class="number">8.0</span>, <span class="number">9.0</span>]; |
| nullify_lower_triangular_part(<span class="kw-2">&mut </span>x); |
| <span class="macro">assert_matrix_eq!</span>(x, <span class="macro">matrix!</span>[ |
| <span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>; |
| <span class="number">0.0</span>, <span class="number">5.0</span>, <span class="number">6.0</span>; |
| <span class="number">0.0</span>, <span class="number">0.0</span>, <span class="number">9.0 |
| </span>]); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>nullify_upper_triangular_part_examples() { |
| <span class="kw">let </span><span class="kw-2">mut </span>x = <span class="macro">matrix!</span>[<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>; |
| <span class="number">4.0</span>, <span class="number">5.0</span>, <span class="number">6.0</span>; |
| <span class="number">7.0</span>, <span class="number">8.0</span>, <span class="number">9.0</span>]; |
| nullify_upper_triangular_part(<span class="kw-2">&mut </span>x); |
| <span class="macro">assert_matrix_eq!</span>(x, <span class="macro">matrix!</span>[ |
| <span class="number">1.0</span>, <span class="number">0.0</span>, <span class="number">0.0</span>; |
| <span class="number">4.0</span>, <span class="number">5.0</span>, <span class="number">0.0</span>; |
| <span class="number">7.0</span>, <span class="number">8.0</span>, <span class="number">9.0 |
| </span>]); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>transpose_gemv_examples() { |
| { |
| <span class="kw">let </span>a = <span class="macro">matrix!</span>[<span class="number">3.0</span>, <span class="number">4.0</span>, <span class="number">5.0</span>; |
| <span class="number">2.0</span>, <span class="number">3.0</span>, <span class="number">1.0</span>]; |
| <span class="kw">let </span>x = <span class="macro">vec!</span>[<span class="number">2.0</span>, <span class="number">3.0</span>]; |
| <span class="kw">let </span><span class="kw-2">mut </span>y = <span class="macro">vec!</span>[<span class="number">0.0</span>; <span class="number">3</span>]; |
| transpose_gemv(<span class="kw-2">&</span>a, <span class="kw-2">&</span>x, <span class="kw-2">&mut </span>y); |
| |
| <span class="kw">let </span>y = Vector::new(y); |
| <span class="macro">assert_vector_eq!</span>(y, <span class="macro">vector!</span>[<span class="number">12.0</span>, <span class="number">17.0</span>, <span class="number">13.0</span>]); |
| } |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>ger_examples() { |
| { |
| <span class="kw">let </span><span class="kw-2">mut </span>a = <span class="macro">matrix!</span>[<span class="number">3.0</span>, <span class="number">4.0</span>, <span class="number">5.0</span>; |
| <span class="number">2.0</span>, <span class="number">3.0</span>, <span class="number">1.0</span>]; |
| <span class="kw">let </span>x = <span class="macro">vec!</span>[<span class="number">3.0</span>, <span class="number">4.0</span>]; |
| <span class="kw">let </span>y = <span class="macro">vec!</span>[<span class="number">2.0</span>, <span class="number">1.0</span>, <span class="number">3.0</span>]; |
| <span class="kw">let </span>alpha = <span class="number">3.0</span>; |
| |
| ger(<span class="kw-2">&mut </span>a, alpha, <span class="kw-2">&</span>x, <span class="kw-2">&</span>y); |
| |
| <span class="kw">let </span>expected = <span class="macro">matrix!</span>[<span class="number">21.0</span>, <span class="number">13.0</span>, <span class="number">32.0</span>; |
| <span class="number">26.0</span>, <span class="number">15.0</span>, <span class="number">37.0</span>]; |
| <span class="macro">assert_matrix_eq!</span>(a, expected, comp = float); |
| } |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rulinalg" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
