blob: 98a0d3d6ed4344adde080b9c7d088742ea40241a [file] [log] [blame]
<!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="Column of a matrix."><meta name="keywords" content="rust, rustlang, rust-lang, Column"><title>Column in rulinalg::matrix - Rust</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="sidebar-items.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 struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../rulinalg/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><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><h2 class="location"><a href="#">Column</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.clone_into_slice">clone_into_slice</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-BaseMatrix%3CT%3E-for-Column%3C%27a%2C%20T%3E">BaseMatrix&lt;T&gt;</a></li><li><a href="#impl-Clone-for-Column%3C%27a%2C%20T%3E">Clone</a></li><li><a href="#impl-Copy-for-Column%3C%27a%2C%20T%3E">Copy</a></li><li><a href="#impl-Debug-for-Column%3C%27a%2C%20T%3E">Debug</a></li><li><a href="#impl-Deref-for-Column%3C%27a%2C%20T%3E">Deref</a></li><li><a href="#impl-From%3CColumn%3C%27a%2C%20T%3E%3E-for-Vector%3CT%3E">From&lt;Column&lt;&#39;a, T&gt;&gt;</a></li><li><a href="#impl-Index%3Cusize%3E-for-Column%3C%27a%2C%20T%3E">Index&lt;usize&gt;</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Column%3C%27a%2C%20T%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Column%3C%27a%2C%20T%3E">!Send</a></li><li><a href="#impl-Sync-for-Column%3C%27a%2C%20T%3E">!Sync</a></li><li><a href="#impl-Unpin-for-Column%3C%27a%2C%20T%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Column%3C%27a%2C%20T%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Column%3C%27a%2C%20T%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Column%3C%27a%2C%20T%3E">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Column%3C%27a%2C%20T%3E">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-Column%3C%27a%2C%20T%3E">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-Column%3C%27a%2C%20T%3E">Into&lt;U&gt;</a></li><li><a href="#impl-ToOwned-for-Column%3C%27a%2C%20T%3E">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Column%3C%27a%2C%20T%3E">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-Column%3C%27a%2C%20T%3E">TryInto&lt;U&gt;</a></li></ul></section><h2><a href="index.html">In rulinalg::matrix</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Struct <a href="../index.html">rulinalg</a>::<wbr><a href="index.html">matrix</a>::<wbr><a class="struct" href="#">Column</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/rulinalg/matrix/mod.rs.html#200-202">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct Column&lt;'a, T:&nbsp;'a&gt; { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Column of a matrix.</p>
<p>This struct points to a <code>MatrixSlice</code>
making up a column in a matrix.
You can deref this struct to retrieve
the raw column <code>MatrixSlice</code>.</p>
<h2 id="example"><a href="#example">Example</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>rulinalg::matrix::BaseMatrix;
<span class="kw">let </span>mat = <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="kw">let </span>col = mat.col(<span class="number">1</span>);
<span class="macro">assert_eq!</span>((<span class="kw-2">*</span>col + <span class="number">2.0</span>).sum(), <span class="number">10.0</span>);</code></pre></div>
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/mod.rs.html#430-444">source</a><a href="#impl-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;'a, T&gt; <a class="struct" href="struct.Column.html" title="struct rulinalg::matrix::Column">Column</a>&lt;'a, T&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Clone,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into_slice" class="method has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/mod.rs.html#437-443">source</a><h4 class="code-header">pub fn <a href="#method.clone_into_slice" class="fnname">clone_into_slice</a>(&amp;self, slice: &amp;mut [T])</h4></section></summary><div class="docblock"><p>Clones the elements of this column into a
slice of compatible size.</p>
<h5 id="panics"><a href="#panics">Panics</a></h5>
<ul>
<li>The slice does not have the same length as
the number of rows in the column.</li>
</ul>
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-BaseMatrix%3CT%3E-for-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/impl_base.rs.html#164-178">source</a><a href="#impl-BaseMatrix%3CT%3E-for-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;'a, T&gt; <a class="trait" href="trait.BaseMatrix.html" title="trait rulinalg::matrix::BaseMatrix">BaseMatrix</a>&lt;T&gt; for <a class="struct" href="struct.Column.html" title="struct rulinalg::matrix::Column">Column</a>&lt;'a, T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.rows" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/impl_base.rs.html#165-167">source</a><a href="#method.rows" class="anchor"></a><h4 class="code-header">fn <a href="trait.BaseMatrix.html#tymethod.rows" class="fnname">rows</a>(&amp;self) -&gt; usize</h4></section></summary><div class='docblock'>Rows in the matrix.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.cols" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/impl_base.rs.html#168-170">source</a><a href="#method.cols" class="anchor"></a><h4 class="code-header">fn <a href="trait.BaseMatrix.html#tymethod.cols" class="fnname">cols</a>(&amp;self) -&gt; usize</h4></section></summary><div class='docblock'>Columns in the matrix.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.row_stride" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/impl_base.rs.html#171-173">source</a><a href="#method.row_stride" class="anchor"></a><h4 class="code-header">fn <a href="trait.BaseMatrix.html#tymethod.row_stride" class="fnname">row_stride</a>(&amp;self) -&gt; usize</h4></section></summary><div class='docblock'>Row stride in the matrix.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_ptr" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/impl_base.rs.html#175-177">source</a><a href="#method.as_ptr" class="anchor"></a><h4 class="code-header">fn <a href="trait.BaseMatrix.html#tymethod.as_ptr" class="fnname">as_ptr</a>(&amp;self) -&gt; *const T</h4></section></summary><div class='docblock'>Top left index of the matrix.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_empty" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/mod.rs.html#55-57">source</a><a href="#method.is_empty" class="anchor"></a><h4 class="code-header">fn <a href="trait.BaseMatrix.html#method.is_empty" class="fnname">is_empty</a>(&amp;self) -&gt; bool</h4></section></summary><div class='docblock'>Returns true if the matrix contais no elements</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_slice" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/mod.rs.html#72-76">source</a><a href="#method.as_slice" class="anchor"></a><h4 class="code-header">fn <a href="trait.BaseMatrix.html#method.as_slice" class="fnname">as_slice</a>(&amp;self) -&gt; <a class="struct" href="struct.MatrixSlice.html" title="struct rulinalg::matrix::MatrixSlice">MatrixSlice</a>&lt;'_, T&gt;</h4></section></summary><div class='docblock'>Returns a <code>MatrixSlice</code> over the whole matrix. <a href="trait.BaseMatrix.html#method.as_slice">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_unchecked" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/mod.rs.html#79-81">source</a><a href="#method.get_unchecked" class="anchor"></a><h4 class="code-header">unsafe fn <a href="trait.BaseMatrix.html#method.get_unchecked" class="fnname">get_unchecked</a>(&amp;self, index: [usize; 2]) -&gt; &amp;T</h4></section></summary><div class='docblock'>Get a reference to an element in the matrix without bounds checking.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/mod.rs.html#101-110">source</a><a href="#method.get" class="anchor"></a><h4 class="code-header">fn <a href="trait.BaseMatrix.html#method.get" class="fnname">get</a>(&amp;self, index: [usize; 2]) -&gt; Option&lt;&amp;T&gt;</h4></section></summary><div class='docblock'>Get a reference to an element in the matrix. <a href="trait.BaseMatrix.html#method.get">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.col" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/mod.rs.html#133-139">source</a><a href="#method.col" class="anchor"></a><h4 class="code-header">fn <a href="trait.BaseMatrix.html#method.col" class="fnname">col</a>(&amp;self, index: usize) -&gt; <a class="struct" href="struct.Column.html" title="struct rulinalg::matrix::Column">Column</a>&lt;'_, T&gt;</h4></section></summary><div class='docblock'>Returns the column of a matrix at the given index.
<code>None</code> if the index is out of bounds. <a href="trait.BaseMatrix.html#method.col">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.col_unchecked" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/mod.rs.html#158-161">source</a><a href="#method.col_unchecked" class="anchor"></a><h4 class="code-header">unsafe fn <a href="trait.BaseMatrix.html#method.col_unchecked" class="fnname">col_unchecked</a>(&amp;self, index: usize) -&gt; <a class="struct" href="struct.Column.html" title="struct rulinalg::matrix::Column">Column</a>&lt;'_, T&gt;</h4></section></summary><div class='docblock'>Returns the column of a matrix at the given
index without doing a bounds check. <a href="trait.BaseMatrix.html#method.col_unchecked">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.row" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/mod.rs.html#183-189">source</a><a href="#method.row" class="anchor"></a><h4 class="code-header">fn <a href="trait.BaseMatrix.html#method.row" class="fnname">row</a>(&amp;self, index: usize) -&gt; <a class="struct" href="struct.Row.html" title="struct rulinalg::matrix::Row">Row</a>&lt;'_, T&gt;</h4></section></summary><div class='docblock'>Returns the row of a matrix at the given index. <a href="trait.BaseMatrix.html#method.row">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.row_unchecked" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/mod.rs.html#207-210">source</a><a href="#method.row_unchecked" class="anchor"></a><h4 class="code-header">unsafe fn <a href="trait.BaseMatrix.html#method.row_unchecked" class="fnname">row_unchecked</a>(&amp;self, index: usize) -&gt; <a class="struct" href="struct.Row.html" title="struct rulinalg::matrix::Row">Row</a>&lt;'_, T&gt;</h4></section></summary><div class='docblock'>Returns the row of a matrix at the given index without doing unbounds checking <a href="trait.BaseMatrix.html#method.row_unchecked">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.iter" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/mod.rs.html#229-241">source</a><a href="#method.iter" class="anchor"></a><h4 class="code-header">fn <a href="trait.BaseMatrix.html#method.iter" class="fnname">iter</a>&lt;'a&gt;(&amp;self) -&gt; <a class="struct" href="struct.SliceIter.html" title="struct rulinalg::matrix::SliceIter">SliceIter</a>&lt;'a, T&gt;<span class="notable-traits"><span class="notable-traits-tooltip"><span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="struct.SliceIter.html" title="struct rulinalg::matrix::SliceIter">SliceIter</a>&lt;'a, T&gt;</span><code class="content"><span class="where fmt-newline">impl&lt;'a, T&gt; Iterator for <a class="struct" href="struct.SliceIter.html" title="struct rulinalg::matrix::SliceIter">SliceIter</a>&lt;'a, T&gt;</span><span class="where fmt-newline"> type <a class="associatedtype">Item</a> = &amp;'a T;</span></code></span></span></span></span><span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'a,</span></h4></section></summary><div class='docblock'>Returns an iterator over the matrix data. <a href="trait.BaseMatrix.html#method.iter">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.col_iter" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/mod.rs.html#262-271">source</a><a href="#method.col_iter" class="anchor"></a><h4 class="code-header">fn <a href="trait.BaseMatrix.html#method.col_iter" class="fnname">col_iter</a>(&amp;self) -&gt; <a class="struct" href="struct.Cols.html" title="struct rulinalg::matrix::Cols">Cols</a>&lt;'_, T&gt;<span class="notable-traits"><span class="notable-traits-tooltip"><span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="struct.Cols.html" title="struct rulinalg::matrix::Cols">Cols</a>&lt;'a, T&gt;</span><code class="content"><span class="where fmt-newline">impl&lt;'a, T&gt; Iterator for <a class="struct" href="struct.Cols.html" title="struct rulinalg::matrix::Cols">Cols</a>&lt;'a, T&gt;</span><span class="where fmt-newline"> type <a class="associatedtype">Item</a> = <a class="struct" href="struct.Column.html" title="struct rulinalg::matrix::Column">Column</a>&lt;'a, T&gt;;</span></code></span></span></span></span></h4></section></summary><div class='docblock'>Iterate over the columns of the matrix. <a href="trait.BaseMatrix.html#method.col_iter">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.row_iter" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/mod.rs.html#292-301">source</a><a href="#method.row_iter" class="anchor"></a><h4 class="code-header">fn <a href="trait.BaseMatrix.html#method.row_iter" class="fnname">row_iter</a>(&amp;self) -&gt; <a class="struct" href="struct.Rows.html" title="struct rulinalg::matrix::Rows">Rows</a>&lt;'_, T&gt;<span class="notable-traits"><span class="notable-traits-tooltip"><span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="struct.Rows.html" title="struct rulinalg::matrix::Rows">Rows</a>&lt;'a, T&gt;</span><code class="content"><span class="where fmt-newline">impl&lt;'a, T&gt; Iterator for <a class="struct" href="struct.Rows.html" title="struct rulinalg::matrix::Rows">Rows</a>&lt;'a, T&gt;</span><span class="where fmt-newline"> type <a class="associatedtype">Item</a> = <a class="struct" href="struct.Row.html" title="struct rulinalg::matrix::Row">Row</a>&lt;'a, T&gt;;</span></code></span></span></span></span></h4></section></summary><div class='docblock'>Iterate over the rows of the matrix. <a href="trait.BaseMatrix.html#method.row_iter">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.diag_iter" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/mod.rs.html#336-357">source</a><a href="#method.diag_iter" class="anchor"></a><h4 class="code-header">fn <a href="trait.BaseMatrix.html#method.diag_iter" class="fnname">diag_iter</a>(&amp;self, k: <a class="enum" href="enum.DiagOffset.html" title="enum rulinalg::matrix::DiagOffset">DiagOffset</a>) -&gt; <a class="struct" href="struct.Diagonal.html" title="struct rulinalg::matrix::Diagonal">Diagonal</a>&lt;'_, T, Self&gt;<span class="notable-traits"><span class="notable-traits-tooltip"><span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="struct.Diagonal.html" title="struct rulinalg::matrix::Diagonal">Diagonal</a>&lt;'a, T, M&gt;</span><code class="content"><span class="where fmt-newline">impl&lt;'a, T, M:&nbsp;<a class="trait" href="trait.BaseMatrix.html" title="trait rulinalg::matrix::BaseMatrix">BaseMatrix</a>&lt;T&gt;&gt; Iterator for <a class="struct" href="struct.Diagonal.html" title="struct rulinalg::matrix::Diagonal">Diagonal</a>&lt;'a, T, M&gt;</span><span class="where fmt-newline"> type <a class="associatedtype">Item</a> = &amp;'a T;</span></code></span></span></span></span></h4></section></summary><div class='docblock'>Iterate over diagonal entries <a href="trait.BaseMatrix.html#method.diag_iter">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.metric" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/mod.rs.html#459-464">source</a><a href="#method.metric" class="anchor"></a><h4 class="code-header">fn <a href="trait.BaseMatrix.html#method.metric" class="fnname">metric</a>&lt;'a, 'b, B, M&gt;(&amp;'a self, mat: &amp;'b B, metric: M) -&gt; T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: 'b + <a class="trait" href="trait.BaseMatrix.html" title="trait rulinalg::matrix::BaseMatrix">BaseMatrix</a>&lt;T&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;M: <a class="trait" href="../norm/trait.MatrixMetric.html" title="trait rulinalg::norm::MatrixMetric">MatrixMetric</a>&lt;'a, 'b, T, Self, B&gt;,</span></h4></section></summary><div class='docblock'>Compute the metric distance between two matrices. <a href="trait.BaseMatrix.html#method.metric">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.diag" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/mod.rs.html#909-911">source</a><a href="#method.diag" class="anchor"></a><h4 class="code-header">fn <a href="trait.BaseMatrix.html#method.diag" class="fnname">diag</a>(&amp;self) -&gt; <a class="struct" href="struct.Diagonal.html" title="struct rulinalg::matrix::Diagonal">Diagonal</a>&lt;'_, T, Self&gt;<span class="notable-traits"><span class="notable-traits-tooltip"><span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="struct.Diagonal.html" title="struct rulinalg::matrix::Diagonal">Diagonal</a>&lt;'a, T, M&gt;</span><code class="content"><span class="where fmt-newline">impl&lt;'a, T, M:&nbsp;<a class="trait" href="trait.BaseMatrix.html" title="trait rulinalg::matrix::BaseMatrix">BaseMatrix</a>&lt;T&gt;&gt; Iterator for <a class="struct" href="struct.Diagonal.html" title="struct rulinalg::matrix::Diagonal">Diagonal</a>&lt;'a, T, M&gt;</span><span class="where fmt-newline"> type <a class="associatedtype">Item</a> = &amp;'a T;</span></code></span></span></span></span></h4></section></summary><div class='docblock'>Extract the diagonal of the matrix <a href="trait.BaseMatrix.html#method.diag">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.split_at" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/mod.rs.html#1079-1115">source</a><a href="#method.split_at" class="anchor"></a><h4 class="code-header">fn <a href="trait.BaseMatrix.html#method.split_at" class="fnname">split_at</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;mid: usize,<br>&nbsp;&nbsp;&nbsp;&nbsp;axis: <a class="enum" href="enum.Axes.html" title="enum rulinalg::matrix::Axes">Axes</a><br>) -&gt; (<a class="struct" href="struct.MatrixSlice.html" title="struct rulinalg::matrix::MatrixSlice">MatrixSlice</a>&lt;'_, T&gt;, <a class="struct" href="struct.MatrixSlice.html" title="struct rulinalg::matrix::MatrixSlice">MatrixSlice</a>&lt;'_, T&gt;)</h4></section></summary><div class='docblock'>Split the matrix at the specified axis returning two <code>MatrixSlice</code>s. <a href="trait.BaseMatrix.html#method.split_at">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.sub_slice" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/base/mod.rs.html#1128-1144">source</a><a href="#method.sub_slice" class="anchor"></a><h4 class="code-header">fn <a href="trait.BaseMatrix.html#method.sub_slice" class="fnname">sub_slice</a>&lt;'a&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;start: [usize; 2],<br>&nbsp;&nbsp;&nbsp;&nbsp;rows: usize,<br>&nbsp;&nbsp;&nbsp;&nbsp;cols: usize<br>) -&gt; <a class="struct" href="struct.MatrixSlice.html" title="struct rulinalg::matrix::MatrixSlice">MatrixSlice</a>&lt;'a, T&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'a,</span></h4></section></summary><div class='docblock'>Produce a <code>MatrixSlice</code> from an existing matrix. <a href="trait.BaseMatrix.html#method.sub_slice">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/mod.rs.html#199">source</a><a href="#impl-Clone-for-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;'a, T:&nbsp;Clone + 'a&gt; Clone for <a class="struct" href="struct.Column.html" title="struct rulinalg::matrix::Column">Column</a>&lt;'a, T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/mod.rs.html#199">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&amp;self) -&gt; <a class="struct" href="struct.Column.html" title="struct rulinalg::matrix::Column">Column</a>&lt;'a, T&gt;</h4></section></summary><div class='docblock'>Returns a copy of the value. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clone_from</a>(&amp;mut self, source: &amp;Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/mod.rs.html#199">source</a><a href="#impl-Debug-for-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;'a, T:&nbsp;Debug + 'a&gt; Debug for <a class="struct" href="struct.Column.html" title="struct rulinalg::matrix::Column">Column</a>&lt;'a, T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/mod.rs.html#199">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&amp;self, f: &amp;mut Formatter&lt;'_&gt;) -&gt; Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Deref-for-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/deref.rs.html#28-34">source</a><a href="#impl-Deref-for-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;'a, T:&nbsp;'a&gt; Deref for <a class="struct" href="struct.Column.html" title="struct rulinalg::matrix::Column">Column</a>&lt;'a, T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Target" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Target" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Target</a> = <a class="struct" href="struct.MatrixSlice.html" title="struct rulinalg::matrix::MatrixSlice">MatrixSlice</a>&lt;'a, T&gt;</h4></section></summary><div class='docblock'>The resulting type after dereferencing.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.deref" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/deref.rs.html#31-33">source</a><a href="#method.deref" class="anchor"></a><h4 class="code-header">fn <a class="fnname">deref</a>(&amp;self) -&gt; &amp;<a class="struct" href="struct.MatrixSlice.html" title="struct rulinalg::matrix::MatrixSlice">MatrixSlice</a>&lt;'a, T&gt;</h4></section></summary><div class='docblock'>Dereferences the value.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3CColumn%3C%27a%2C%20T%3E%3E-for-Vector%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/convert.rs.html#118">source</a><a href="#impl-From%3CColumn%3C%27a%2C%20T%3E%3E-for-Vector%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;'a, T:&nbsp;Clone&gt; From&lt;<a class="struct" href="struct.Column.html" title="struct rulinalg::matrix::Column">Column</a>&lt;'a, T&gt;&gt; for <a class="struct" href="../vector/struct.Vector.html" title="struct rulinalg::vector::Vector">Vector</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/convert.rs.html#118">source</a><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(column: <a class="struct" href="struct.Column.html" title="struct rulinalg::matrix::Column">Column</a>&lt;'a, T&gt;) -&gt; Self</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Index%3Cusize%3E-for-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/impl_ops.rs.html#101-106">source</a><a href="#impl-Index%3Cusize%3E-for-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;'a, T&gt; Index&lt;usize&gt; for <a class="struct" href="struct.Column.html" title="struct rulinalg::matrix::Column">Column</a>&lt;'a, T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Output" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Output</a> = T</h4></section></summary><div class='docblock'>The returned type after indexing.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.index" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/impl_ops.rs.html#103-105">source</a><a href="#method.index" class="anchor"></a><h4 class="code-header">fn <a class="fnname">index</a>(&amp;self, idx: usize) -&gt; &amp;T</h4></section></summary><div class='docblock'>Performs the indexing (<code>container[index]</code>) operation. <a>Read more</a></div></details></div></details><section id="impl-Copy-for-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/mod.rs.html#199">source</a><a href="#impl-Copy-for-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;'a, T:&nbsp;Copy + 'a&gt; Copy for <a class="struct" href="struct.Column.html" title="struct rulinalg::matrix::Column">Column</a>&lt;'a, T&gt;</h3></section></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;'a, T&gt; RefUnwindSafe for <a class="struct" href="struct.Column.html" title="struct rulinalg::matrix::Column">Column</a>&lt;'a, T&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a href="#impl-Send-for-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;'a, T&gt; !Send for <a class="struct" href="struct.Column.html" title="struct rulinalg::matrix::Column">Column</a>&lt;'a, T&gt;</h3></section><section id="impl-Sync-for-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a href="#impl-Sync-for-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;'a, T&gt; !Sync for <a class="struct" href="struct.Column.html" title="struct rulinalg::matrix::Column">Column</a>&lt;'a, T&gt;</h3></section><section id="impl-Unpin-for-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a href="#impl-Unpin-for-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;'a, T&gt; Unpin for <a class="struct" href="struct.Column.html" title="struct rulinalg::matrix::Column">Column</a>&lt;'a, T&gt;</h3></section><section id="impl-UnwindSafe-for-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;'a, T&gt; UnwindSafe for <a class="struct" href="struct.Column.html" title="struct rulinalg::matrix::Column">Column</a>&lt;'a, T&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: RefUnwindSafe,</span></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a href="#impl-Any-for-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Any for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&amp;self) -&gt; TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Borrow&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&amp;self) -&gt; &amp;T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; BorrowMut&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&amp;mut self) -&gt; &amp;mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; From&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from-1" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; Into&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: From&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code>[From]&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a href="#impl-ToOwned-for-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; ToOwned for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Clone,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a class="fnname">to_owned</a>(&amp;self) -&gt; T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone_into</a>(&amp;self, target: &amp;mut T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryFrom&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: Into&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -&gt; Result&lt;T, &lt;T as TryFrom&lt;U&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Column%3C%27a%2C%20T%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Column%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryInto&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: TryFrom&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = &lt;U as TryFrom&lt;T&gt;&gt;::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -&gt; Result&lt;U, &lt;U as TryFrom&lt;T&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></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>