blob: 606e95e389f2a102fafa92289dcdb25413c48b4c [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="Hyperbolic tangent activation function"><meta name="keywords" content="rust, rustlang, rust-lang, Tanh"><title>Tanh in rusty_machine::learning::toolkit::activ_fn - 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="../../../../rusty_machine/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="../../../../rusty_machine/index.html"><div class="logo-container"><img class="rust-logo" src="../../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Tanh</a></h2><div class="sidebar-elems"><section><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-ActivationFunc-for-Tanh">ActivationFunc</a></li><li><a href="#impl-Clone-for-Tanh">Clone</a></li><li><a href="#impl-Copy-for-Tanh">Copy</a></li><li><a href="#impl-Debug-for-Tanh">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Tanh">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Tanh">Send</a></li><li><a href="#impl-Sync-for-Tanh">Sync</a></li><li><a href="#impl-Unpin-for-Tanh">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Tanh">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Tanh">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Tanh">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Tanh">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-Tanh">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-Tanh">Into&lt;U&gt;</a></li><li><a href="#impl-NetLayer-for-Tanh">NetLayer</a></li><li><a href="#impl-ToOwned-for-Tanh">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Tanh">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-Tanh">TryInto&lt;U&gt;</a></li><li><a href="#impl-VZip%3CV%3E-for-Tanh">VZip&lt;V&gt;</a></li></ul></section><h2><a href="index.html">In rusty_machine::learning::toolkit::activ_fn</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">rusty_machine</a>::<wbr><a href="../../index.html">learning</a>::<wbr><a href="../index.html">toolkit</a>::<wbr><a href="index.html">activ_fn</a>::<wbr><a class="struct" href="#">Tanh</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/rusty_machine/learning/toolkit/activ_fn.rs.html#103">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 Tanh;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Hyperbolic tangent activation function</p>
</div></details><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-ActivationFunc-for-Tanh" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/activ_fn.rs.html#105-122">source</a><a href="#impl-ActivationFunc-for-Tanh" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ActivationFunc.html" title="trait rusty_machine::learning::toolkit::activ_fn::ActivationFunc">ActivationFunc</a> for <a class="struct" href="struct.Tanh.html" title="struct rusty_machine::learning::toolkit::activ_fn::Tanh">Tanh</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.func" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/activ_fn.rs.html#106-108">source</a><a href="#method.func" class="anchor"></a><h4 class="code-header">fn <a href="trait.ActivationFunc.html#tymethod.func" class="fnname">func</a>(x: f64) -&gt; f64</h4></section></summary><div class='docblock'>The activation function.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.func_grad" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/activ_fn.rs.html#110-113">source</a><a href="#method.func_grad" class="anchor"></a><h4 class="code-header">fn <a href="trait.ActivationFunc.html#tymethod.func_grad" class="fnname">func_grad</a>(x: f64) -&gt; f64</h4></section></summary><div class='docblock'>The gradient of the activation function.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.func_grad_from_output" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/activ_fn.rs.html#115-117">source</a><a href="#method.func_grad_from_output" class="anchor"></a><h4 class="code-header">fn <a href="trait.ActivationFunc.html#tymethod.func_grad_from_output" class="fnname">func_grad_from_output</a>(y: f64) -&gt; f64</h4></section></summary><div class='docblock'>The gradient of the activation function calculated using the output of the function.
Calculates f’(x) given f(x) as an input <a href="trait.ActivationFunc.html#tymethod.func_grad_from_output">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.func_inv" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/activ_fn.rs.html#119-121">source</a><a href="#method.func_inv" class="anchor"></a><h4 class="code-header">fn <a href="trait.ActivationFunc.html#tymethod.func_inv" class="fnname">func_inv</a>(x: f64) -&gt; f64</h4></section></summary><div class='docblock'>The inverse of the activation function.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-Tanh" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/activ_fn.rs.html#102">source</a><a href="#impl-Clone-for-Tanh" class="anchor"></a><h3 class="code-header">impl Clone for <a class="struct" href="struct.Tanh.html" title="struct rusty_machine::learning::toolkit::activ_fn::Tanh">Tanh</a></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/rusty_machine/learning/toolkit/activ_fn.rs.html#102">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.Tanh.html" title="struct rusty_machine::learning::toolkit::activ_fn::Tanh">Tanh</a></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-Tanh" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/activ_fn.rs.html#102">source</a><a href="#impl-Debug-for-Tanh" class="anchor"></a><h3 class="code-header">impl Debug for <a class="struct" href="struct.Tanh.html" title="struct rusty_machine::learning::toolkit::activ_fn::Tanh">Tanh</a></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/rusty_machine/learning/toolkit/activ_fn.rs.html#102">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><section id="impl-Copy-for-Tanh" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/activ_fn.rs.html#102">source</a><a href="#impl-Copy-for-Tanh" class="anchor"></a><h3 class="code-header">impl Copy for <a class="struct" href="struct.Tanh.html" title="struct rusty_machine::learning::toolkit::activ_fn::Tanh">Tanh</a></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-Tanh" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Tanh" class="anchor"></a><h3 class="code-header">impl RefUnwindSafe for <a class="struct" href="struct.Tanh.html" title="struct rusty_machine::learning::toolkit::activ_fn::Tanh">Tanh</a></h3></section><section id="impl-Send-for-Tanh" class="impl has-srclink"><a href="#impl-Send-for-Tanh" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.Tanh.html" title="struct rusty_machine::learning::toolkit::activ_fn::Tanh">Tanh</a></h3></section><section id="impl-Sync-for-Tanh" class="impl has-srclink"><a href="#impl-Sync-for-Tanh" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.Tanh.html" title="struct rusty_machine::learning::toolkit::activ_fn::Tanh">Tanh</a></h3></section><section id="impl-Unpin-for-Tanh" class="impl has-srclink"><a href="#impl-Unpin-for-Tanh" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.Tanh.html" title="struct rusty_machine::learning::toolkit::activ_fn::Tanh">Tanh</a></h3></section><section id="impl-UnwindSafe-for-Tanh" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Tanh" class="anchor"></a><h3 class="code-header">impl UnwindSafe for <a class="struct" href="struct.Tanh.html" title="struct rusty_machine::learning::toolkit::activ_fn::Tanh">Tanh</a></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-Tanh" class="impl has-srclink"><a href="#impl-Any-for-Tanh" 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-Tanh" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Tanh" 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-Tanh" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Tanh" 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-Tanh" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Tanh" 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" 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" 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-Tanh" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Tanh" 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-NetLayer-for-Tanh" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/nnet/net_layer.rs.html#156-185">source</a><a href="#impl-NetLayer-for-Tanh" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="../../nnet/net_layer/trait.NetLayer.html" title="trait rusty_machine::learning::nnet::net_layer::NetLayer">NetLayer</a> for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="trait.ActivationFunc.html" title="trait rusty_machine::learning::toolkit::activ_fn::ActivationFunc">ActivationFunc</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.forward" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/nnet/net_layer.rs.html#158-164">source</a><a href="#method.forward" class="anchor"></a><h4 class="code-header">fn <a href="../../nnet/net_layer/trait.NetLayer.html#tymethod.forward" class="fnname">forward</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;input: &amp;<a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;f64&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="struct" href="../../../linalg/struct.MatrixSlice.html" title="struct rusty_machine::linalg::MatrixSlice">MatrixSlice</a>&lt;'_, f64&gt;<br>) -&gt; Result&lt;<a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;f64&gt;, <a class="struct" href="../../error/struct.Error.html" title="struct rusty_machine::learning::error::Error">Error</a>&gt;</h4></section></summary><div class="docblock"><p>Applies the activation function to each element of the input</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.back_input" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/nnet/net_layer.rs.html#166-172">source</a><a href="#method.back_input" class="anchor"></a><h4 class="code-header">fn <a href="../../nnet/net_layer/trait.NetLayer.html#tymethod.back_input" class="fnname">back_input</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;out_grad: &amp;<a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;f64&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;<a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;f64&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;output: &amp;<a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;f64&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="struct" href="../../../linalg/struct.MatrixSlice.html" title="struct rusty_machine::linalg::MatrixSlice">MatrixSlice</a>&lt;'_, f64&gt;<br>) -&gt; <a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;f64&gt;</h4></section></summary><div class='docblock'>The gradient of the output of this layer with respect to its input</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.back_params" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/nnet/net_layer.rs.html#174-176">source</a><a href="#method.back_params" class="anchor"></a><h4 class="code-header">fn <a href="../../nnet/net_layer/trait.NetLayer.html#tymethod.back_params" class="fnname">back_params</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;<a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;f64&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;<a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;f64&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;<a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;f64&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="struct" href="../../../linalg/struct.MatrixSlice.html" title="struct rusty_machine::linalg::MatrixSlice">MatrixSlice</a>&lt;'_, f64&gt;<br>) -&gt; <a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;f64&gt;</h4></section></summary><div class='docblock'>The gradient of the output of this layer with respect to its parameters</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default_params" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/nnet/net_layer.rs.html#178-180">source</a><a href="#method.default_params" class="anchor"></a><h4 class="code-header">fn <a href="../../nnet/net_layer/trait.NetLayer.html#tymethod.default_params" class="fnname">default_params</a>(&amp;self) -&gt; Vec&lt;f64, Global&gt;</h4></section></summary><div class='docblock'>The default value of the parameters of this layer before training</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.param_shape" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/nnet/net_layer.rs.html#182-184">source</a><a href="#method.param_shape" class="anchor"></a><h4 class="code-header">fn <a href="../../nnet/net_layer/trait.NetLayer.html#tymethod.param_shape" class="fnname">param_shape</a>(&amp;self) -&gt; (usize, usize)</h4></section></summary><div class='docblock'>The shape of the parameters used by this layer</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.num_params" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/nnet/net_layer.rs.html#33-36">source</a><a href="#method.num_params" class="anchor"></a><h4 class="code-header">fn <a href="../../nnet/net_layer/trait.NetLayer.html#method.num_params" class="fnname">num_params</a>(&amp;self) -&gt; usize</h4></section></summary><div class='docblock'>The number of parameters used by this layer</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-Tanh" class="impl has-srclink"><a href="#impl-ToOwned-for-Tanh" 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-Tanh" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-Tanh" 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-Tanh" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Tanh" 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><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-VZip%3CV%3E-for-Tanh" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/ppv_lite86/types.rs.html#221">source</a><a href="#impl-VZip%3CV%3E-for-Tanh" class="anchor"></a><h3 class="code-header">impl&lt;V, T&gt; <a class="trait" href="../../../../ppv_lite86/types/trait.VZip.html" title="trait ppv_lite86::types::VZip">VZip</a>&lt;V&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;V: <a class="trait" href="../../../../ppv_lite86/types/trait.MultiLane.html" title="trait ppv_lite86::types::MultiLane">MultiLane</a>&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><section id="method.vzip" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../../src/ppv_lite86/types.rs.html#226">source</a><a href="#method.vzip" class="anchor"></a><h4 class="code-header">fn <a href="../../../../ppv_lite86/types/trait.VZip.html#tymethod.vzip" class="fnname">vzip</a>(self) -&gt; V</h4></section></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="rusty_machine" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>