ndarray-linalg 0.1.0

Linear algebra package for rust-ndarray using LAPACK
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

<!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 `SquareMatrix` trait in crate `ndarray_linalg`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, SquareMatrix">

    <title>ndarray_linalg::square_matrix::SquareMatrix - Rust</title>

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

    
    
</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">
        
        <p class='location'><a href='../index.html'>ndarray_linalg</a>::<wbr><a href='index.html'>square_matrix</a></p><script>window.sidebarCurrent = {name: 'SquareMatrix', ty: 'trait', 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 trait">
<h1 class='fqn'><span class='in-band'>Trait <a href='../index.html'>ndarray_linalg</a>::<wbr><a href='index.html'>square_matrix</a>::<wbr><a class='trait' href=''>SquareMatrix</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-369' class='srclink' href='../../src/ndarray_linalg/src/square_matrix.rs.html#9-30' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait SquareMatrix: <a class='trait' href='../../ndarray_linalg/matrix/trait.Matrix.html' title='ndarray_linalg::matrix::Matrix'>Matrix</a> {
    fn <a href='#tymethod.eigh' class='fnname'>eigh</a>(self) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a>&lt;<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>(</a>Self::Vector, Self<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>)</a>,&nbsp;<a class='enum' href='../../ndarray_linalg/error/enum.LinalgError.html' title='ndarray_linalg::error::LinalgError'>LinalgError</a>&gt;;
    fn <a href='#tymethod.inv' class='fnname'>inv</a>(self) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a>&lt;Self,&nbsp;<a class='enum' href='../../ndarray_linalg/error/enum.LinalgError.html' title='ndarray_linalg::error::LinalgError'>LinalgError</a>&gt;;
    fn <a href='#tymethod.trace' class='fnname'>trace</a>(&amp;self) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a>&lt;Self::Scalar,&nbsp;<a class='enum' href='../../ndarray_linalg/error/enum.LinalgError.html' title='ndarray_linalg::error::LinalgError'>LinalgError</a>&gt;;
    fn <a href='#tymethod.ssqrt' class='fnname'>ssqrt</a>(self) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a>&lt;Self,&nbsp;<a class='enum' href='../../ndarray_linalg/error/enum.LinalgError.html' title='ndarray_linalg::error::LinalgError'>LinalgError</a>&gt;;

    fn <a href='#method.check_square' class='fnname'>check_square</a>(&amp;self) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a>&lt;<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>,&nbsp;<a class='struct' href='../../ndarray_linalg/error/struct.NotSquareError.html' title='ndarray_linalg::error::NotSquareError'>NotSquareError</a>&gt; { ... }
}</pre>
            <h2 id='required-methods'>Required Methods</h2>
            <div class='methods'>
        <h3 id='tymethod.eigh' class='method stab '><code>fn <a href='#tymethod.eigh' class='fnname'>eigh</a>(self) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a>&lt;<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>(</a>Self::Vector, Self<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>)</a>,&nbsp;<a class='enum' href='../../ndarray_linalg/error/enum.LinalgError.html' title='ndarray_linalg::error::LinalgError'>LinalgError</a>&gt;</code></h3><div class='docblock'><p>eigenvalue decomposition for Hermite matrix</p>
</div><h3 id='tymethod.inv' class='method stab '><code>fn <a href='#tymethod.inv' class='fnname'>inv</a>(self) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a>&lt;Self,&nbsp;<a class='enum' href='../../ndarray_linalg/error/enum.LinalgError.html' title='ndarray_linalg::error::LinalgError'>LinalgError</a>&gt;</code></h3><div class='docblock'><p>inverse of matrix</p>
</div><h3 id='tymethod.trace' class='method stab '><code>fn <a href='#tymethod.trace' class='fnname'>trace</a>(&amp;self) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a>&lt;Self::Scalar,&nbsp;<a class='enum' href='../../ndarray_linalg/error/enum.LinalgError.html' title='ndarray_linalg::error::LinalgError'>LinalgError</a>&gt;</code></h3><h3 id='tymethod.ssqrt' class='method stab '><code>fn <a href='#tymethod.ssqrt' class='fnname'>ssqrt</a>(self) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a>&lt;Self,&nbsp;<a class='enum' href='../../ndarray_linalg/error/enum.LinalgError.html' title='ndarray_linalg::error::LinalgError'>LinalgError</a>&gt;</code></h3></div>
            <h2 id='provided-methods'>Provided Methods</h2>
            <div class='methods'>
        <h3 id='method.check_square' class='method stab '><code>fn <a href='#method.check_square' class='fnname'>check_square</a>(&amp;self) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a>&lt;<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>,&nbsp;<a class='struct' href='../../ndarray_linalg/error/struct.NotSquareError.html' title='ndarray_linalg::error::NotSquareError'>NotSquareError</a>&gt;</code></h3></div>
        <h2 id='implementors'>Implementors</h2>
        <ul class='item-list' id='implementors-list'>
    <li><code>impl&lt;A:&nbsp;<a class='trait' href='../../ndarray_linalg/scalar/trait.LapackScalar.html' title='ndarray_linalg::scalar::LapackScalar'>LapackScalar</a> + Float&gt; SquareMatrix for <a class='type' href='http://bluss.github.io/rust-ndarray/master/ndarray/type.Array.html' title='ndarray::Array'>Array</a>&lt;A,&nbsp;<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>(</a><a class='type' href='http://bluss.github.io/rust-ndarray/master/ndarray/type.Ix.html' title='ndarray::Ix'>Ix</a>, <a class='type' href='http://bluss.github.io/rust-ndarray/master/ndarray/type.Ix.html' title='ndarray::Ix'>Ix</a><a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>)</a>&gt;</code></li>
</ul><script type="text/javascript" async
                         src="../../implementors/ndarray_linalg/square_matrix/trait.SquareMatrix.js">
                 </script></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 = "ndarray_linalg";
        window.playgroundUrl = "";
    </script>
    <script src="../../jquery.js"></script>
    <script src="../../main.js"></script>
    
    <script defer src="../../search-index.js"></script>
</body>
</html>