| <!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/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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> |
| </pre><pre class="rust"><code><span class="doccomment">//! # The rulinalg crate. |
| //! |
| //! A crate that provides high-dimensional linear algebra |
| //! implemented entirely in Rust. |
| //! |
| //! --- |
| //! |
| //! This crate provides two core data structures: `Matrix` and |
| //! `Vector`. These structs are designed to behave as you would expect |
| //! with relevant operator overloading. |
| //! |
| //! The library currently contains (at least) the following linear algebra |
| //! methods: |
| //! |
| //! - Matrix inversion |
| //! - LUP decomposition |
| //! - QR decomposition |
| //! - SVD decomposition |
| //! - Cholesky decomposition |
| //! - Eigenvalue decomposition |
| //! - Upper Hessenberg decomposition |
| //! - Linear system solver |
| //! - Other standard transformations, e.g. Transposing, concatenation, etc. |
| //! |
| //! --- |
| //! |
| //! ## Usage |
| //! |
| //! Specific usage of modules is described within the modules themselves. This section |
| //! will highlight the basic usage. |
| //! |
| //! We can create new matrices. |
| //! |
| //! ``` |
| //! use rulinalg::matrix::Matrix; |
| //! |
| //! // A new matrix with 3 rows and 2 columns. |
| //! let a = Matrix::new(3, 2, vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0]); |
| //! ``` |
| //! |
| //! The matrices are stored in row-major order. This means in the example above the top |
| //! row will be [1, 2]. |
| //! |
| //! We can perform operations on matrices. |
| //! |
| //! ``` |
| //! use rulinalg::matrix::Matrix; |
| //! |
| //! // A new matrix with 3 rows and 2 columns. |
| //! let a = Matrix::new(3, 2, vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0]); |
| //! let b = Matrix::new(3, 2, vec![6.0, 5.0, 4.0, 3.0, 2.0, 1.0]); |
| //! |
| //! // Produces a 3x2 matrix filled with sevens. |
| //! let c = a + b; |
| //! ``` |
| //! |
| //! Sometimes we want to construct small matrices by hand, usually for writing unit tests |
| //! or examples. For this purpose, `rulinalg` provides the `matrix!` macro: |
| //! |
| //! ``` |
| //! // Remember to enable macro usage in rulinalg! |
| //! #[macro_use] |
| //! extern crate rulinalg; |
| //! |
| //! # fn main() { |
| //! // Construct a 3x3 matrix of f64 |
| //! // Commas separate columns and semi-colons separate rows |
| //! let mat = matrix![1.0, 2.0, 3.0; |
| //! 4.0, 5.0, 6.0; |
| //! 7.0, 8.0, 9.0]; |
| //! # } |
| //! ``` |
| //! |
| //! Of course the library can support more complex operations but you should check the individual |
| //! modules for more information. |
| //! |
| //! # Matrix Slices |
| //! |
| //! Often times it is desirable to operate on only a sub-section of a `Matrix` without copying this block. |
| //! Rulinalg allows this via the `MatrixSlice` and `MatrixSliceMut` structs. These structs can be created |
| //! from `Matrix` structs and follow all of the borrowing rules of Rust. |
| //! |
| //! Note finally that much of the `Matrix`/`MatrixSlice`/`MatrixSliceMut` functionality is contained behind |
| //! the `BaseMatrix`/`BaseMatrixMut` traits. This allows us to be generic over matrices or slices. |
| |
| </span><span class="attribute">#![deny(missing_docs)] |
| #![warn(missing_debug_implementations)] |
| |
| </span><span class="kw">extern crate </span>num <span class="kw">as </span>libnum; |
| <span class="kw">extern crate </span>matrixmultiply; |
| |
| <span class="comment">// macros should be at the top in order for macros to be accessible in subsequent modules |
| </span><span class="attribute">#[macro_use] |
| </span><span class="kw">pub mod </span>macros; |
| <span class="kw">pub mod </span>matrix; |
| <span class="kw">pub mod </span>convert; |
| <span class="kw">pub mod </span>error; |
| <span class="kw">pub mod </span>utils; |
| <span class="kw">pub mod </span>vector; |
| <span class="kw">pub mod </span>ulp; |
| <span class="kw">pub mod </span>norm; |
| |
| <span class="kw">mod </span>internal_utils; |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>testsupport; |
| |
| <span class="attribute">#[cfg(test)] |
| #[macro_use] |
| </span><span class="kw">extern crate </span>quickcheck; |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">extern crate </span>itertools; |
| |
| <span class="kw">pub use </span>norm::{VectorNorm, MatrixNorm}; |
| <span class="kw">pub use </span>norm::{VectorMetric, MatrixMetric}; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"io"</span>)] |
| </span><span class="kw">extern crate </span>csv <span class="kw">as </span>libcsv; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"io"</span>)] |
| </span><span class="kw">extern crate </span>rustc_serialize; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"io"</span>)] |
| </span><span class="kw">pub mod </span>io; |
| </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> |