| <!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="Sigmoid activation function."><meta name="keywords" content="rust, rustlang, rust-lang, Sigmoid"><title>Sigmoid 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">☰</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="#">Sigmoid</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-Sigmoid">ActivationFunc</a></li><li><a href="#impl-Clone-for-Sigmoid">Clone</a></li><li><a href="#impl-Copy-for-Sigmoid">Copy</a></li><li><a href="#impl-Debug-for-Sigmoid">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Sigmoid">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Sigmoid">Send</a></li><li><a href="#impl-Sync-for-Sigmoid">Sync</a></li><li><a href="#impl-Unpin-for-Sigmoid">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Sigmoid">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Sigmoid">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Sigmoid">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Sigmoid">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-Sigmoid">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-Sigmoid">Into<U></a></li><li><a href="#impl-NetLayer-for-Sigmoid">NetLayer</a></li><li><a href="#impl-ToOwned-for-Sigmoid">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Sigmoid">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-Sigmoid">TryInto<U></a></li><li><a href="#impl-VZip%3CV%3E-for-Sigmoid">VZip<V></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="#">Sigmoid</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#31">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct Sigmoid;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Sigmoid 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-Sigmoid" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/activ_fn.rs.html#33-55">source</a><a href="#impl-ActivationFunc-for-Sigmoid" 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.Sigmoid.html" title="struct rusty_machine::learning::toolkit::activ_fn::Sigmoid">Sigmoid</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#37-39">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: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></h4></section></summary><div class="docblock"><p>Sigmoid function.</p> |
| <p>Returns 1 / ( 1 + e^-t).</p> |
| </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#44-46">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: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></h4></section></summary><div class="docblock"><p>Gradient of sigmoid function.</p> |
| <p>Evaluates to (1 - e^-t) / (1 + e^-t)^2</p> |
| </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#48-50">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: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></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#52-54">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: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></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-Sigmoid" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/activ_fn.rs.html#30">source</a><a href="#impl-Clone-for-Sigmoid" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.Sigmoid.html" title="struct rusty_machine::learning::toolkit::activ_fn::Sigmoid">Sigmoid</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#30">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="struct" href="struct.Sigmoid.html" title="struct rusty_machine::learning::toolkit::activ_fn::Sigmoid">Sigmoid</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">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="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/clone.rs.html#132-134">source</a></span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-Sigmoid" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/activ_fn.rs.html#30">source</a><a href="#impl-Debug-for-Sigmoid" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Sigmoid.html" title="struct rusty_machine::learning::toolkit::activ_fn::Sigmoid">Sigmoid</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#30">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><section id="impl-Copy-for-Sigmoid" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/activ_fn.rs.html#30">source</a><a href="#impl-Copy-for-Sigmoid" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="struct.Sigmoid.html" title="struct rusty_machine::learning::toolkit::activ_fn::Sigmoid">Sigmoid</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-Sigmoid" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Sigmoid" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Sigmoid.html" title="struct rusty_machine::learning::toolkit::activ_fn::Sigmoid">Sigmoid</a></h3></section><section id="impl-Send-for-Sigmoid" class="impl has-srclink"><a href="#impl-Send-for-Sigmoid" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Sigmoid.html" title="struct rusty_machine::learning::toolkit::activ_fn::Sigmoid">Sigmoid</a></h3></section><section id="impl-Sync-for-Sigmoid" class="impl has-srclink"><a href="#impl-Sync-for-Sigmoid" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Sigmoid.html" title="struct rusty_machine::learning::toolkit::activ_fn::Sigmoid">Sigmoid</a></h3></section><section id="impl-Unpin-for-Sigmoid" class="impl has-srclink"><a href="#impl-Unpin-for-Sigmoid" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Sigmoid.html" title="struct rusty_machine::learning::toolkit::activ_fn::Sigmoid">Sigmoid</a></h3></section><section id="impl-UnwindSafe-for-Sigmoid" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Sigmoid" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Sigmoid.html" title="struct rusty_machine::learning::toolkit::activ_fn::Sigmoid">Sigmoid</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-Sigmoid" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#200">source</a><a href="#impl-Any-for-Sigmoid" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</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 class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#201">source</a><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Sigmoid" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211">source</a><a href="#impl-Borrow%3CT%3E-for-Sigmoid" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</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="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Sigmoid" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220">source</a><a href="#impl-BorrowMut%3CT%3E-for-Sigmoid" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</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="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#221">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Sigmoid" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#733">source</a><a href="#impl-From%3CT%3E-for-Sigmoid" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> 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="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#736">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> 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-Sigmoid" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#717">source</a><a href="#impl-Into%3CU%3E-for-Sigmoid" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</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="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#725">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> 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><a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="From">From</a><T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-NetLayer-for-Sigmoid" 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-Sigmoid" class="anchor"></a><h3 class="code-header">impl<T> <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> 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> &self,<br> input: &<a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>,<br> <a class="struct" href="../../../linalg/struct.MatrixSlice.html" title="struct rusty_machine::linalg::MatrixSlice">MatrixSlice</a><'_, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>, <a class="struct" href="../../error/struct.Error.html" title="struct rusty_machine::learning::error::Error">Error</a>></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> &self,<br> out_grad: &<a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>,<br> &<a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>,<br> output: &<a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>,<br> <a class="struct" href="../../../linalg/struct.MatrixSlice.html" title="struct rusty_machine::linalg::MatrixSlice">MatrixSlice</a><'_, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>><br>) -> <a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>></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> &self,<br> &<a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>,<br> &<a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>,<br> &<a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>>,<br> <a class="struct" href="../../../linalg/struct.MatrixSlice.html" title="struct rusty_machine::linalg::MatrixSlice">MatrixSlice</a><'_, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>><br>) -> <a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>></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>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/alloc/struct.Global.html" title="struct alloc::alloc::Global">Global</a>></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>(&self) -> (<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</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>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></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-Sigmoid" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#83">source</a><a href="#impl-ToOwned-for-Sigmoid" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</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 href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" 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 class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#88">source</a><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">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 class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#92">source</a><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-Sigmoid" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#775">source</a><a href="#impl-TryFrom%3CU%3E-for-Sigmoid" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</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 href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></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="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#781">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></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-Sigmoid" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#760">source</a><a href="#impl-TryInto%3CU%3E-for-Sigmoid" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</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 href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></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="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#766">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></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-Sigmoid" 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-Sigmoid" class="anchor"></a><h3 class="code-header">impl<V, T> <a class="trait" href="../../../../ppv_lite86/types/trait.VZip.html" title="trait ppv_lite86::types::VZip">VZip</a><V> for T<span class="where fmt-newline">where<br> V: <a class="trait" href="../../../../ppv_lite86/types/trait.MultiLane.html" title="trait ppv_lite86::types::MultiLane">MultiLane</a><T>,</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) -> 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> |
