blob: f9e400b02c8a747605e15c4ab747d30e624c95ae [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="Naive Bayes Distribution."><meta name="keywords" content="rust, rustlang, rust-lang, Distribution"><title>Distribution in rusty_machine::learning::naive_bayes - 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 trait"><!--[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="#">Distribution</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.from_model_params">from_model_params</a></li><li><a href="#tymethod.joint_log_lik">joint_log_lik</a></li><li><a href="#tymethod.update_params">update_params</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In rusty_machine::learning::naive_bayes</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">Trait <a href="../../index.html">rusty_machine</a>::<wbr><a href="../index.html">learning</a>::<wbr><a href="index.html">naive_bayes</a>::<wbr><a class="trait" href="#">Distribution</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/naive_bayes.rs.html#213-227">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 trait"><code>pub trait Distribution {
fn <a href="#tymethod.from_model_params" class="fnname">from_model_params</a>(class_count: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, features: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; Self;
<span class="item-spacer"></span> fn <a href="#tymethod.update_params" class="fnname">update_params</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;data: &amp;<a class="struct" href="../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;class: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="type" href="../type.LearningResult.html" title="type rusty_machine::learning::LearningResult">LearningResult</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.joint_log_lik" class="fnname">joint_log_lik</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;data: &amp;<a class="struct" href="../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;class_prior: &amp;[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>]<br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="type" href="../type.LearningResult.html" title="type rusty_machine::learning::LearningResult">LearningResult</a>&lt;<a class="struct" href="../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt;&gt;;
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Naive Bayes Distribution.</p>
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.from_model_params" class="method has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/naive_bayes.rs.html#215">source</a><h4 class="code-header">fn <a href="#tymethod.from_model_params" class="fnname">from_model_params</a>(class_count: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, features: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; Self</h4></section></summary><div class="docblock"><p>Initialize the distribution parameters.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.update_params" class="method has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/naive_bayes.rs.html#218">source</a><h4 class="code-header">fn <a href="#tymethod.update_params" class="fnname">update_params</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self,<br>&nbsp;&nbsp;&nbsp;&nbsp;data: &amp;<a class="struct" href="../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;class: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br>) -&gt; <a class="type" href="../type.LearningResult.html" title="type rusty_machine::learning::LearningResult">LearningResult</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Updates the distribution parameters.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.joint_log_lik" class="method has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/naive_bayes.rs.html#223-226">source</a><h4 class="code-header">fn <a href="#tymethod.joint_log_lik" class="fnname">joint_log_lik</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;data: &amp;<a class="struct" href="../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;class_prior: &amp;[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>]<br>) -&gt; <a class="type" href="../type.LearningResult.html" title="type rusty_machine::learning::LearningResult">LearningResult</a>&lt;<a class="struct" href="../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>&gt;&gt;</h4></section></summary><div class="docblock"><p>Compute the joint log likelihood of the data.</p>
<p>Returns a matrix with rows containing the probability that the input lies in each class.</p>
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-Distribution-for-Bernoulli" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/naive_bayes.rs.html#331-382">source</a><a href="#impl-Distribution-for-Bernoulli" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Distribution.html" title="trait rusty_machine::learning::naive_bayes::Distribution">Distribution</a> for <a class="struct" href="struct.Bernoulli.html" title="struct rusty_machine::learning::naive_bayes::Bernoulli">Bernoulli</a></h3></section><section id="impl-Distribution-for-Gaussian" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/naive_bayes.rs.html#257-308">source</a><a href="#impl-Distribution-for-Gaussian" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Distribution.html" title="trait rusty_machine::learning::naive_bayes::Distribution">Distribution</a> for <a class="struct" href="struct.Gaussian.html" title="struct rusty_machine::learning::naive_bayes::Gaussian">Gaussian</a></h3></section><section id="impl-Distribution-for-Multinomial" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rusty_machine/learning/naive_bayes.rs.html#404-444">source</a><a href="#impl-Distribution-for-Multinomial" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Distribution.html" title="trait rusty_machine::learning::naive_bayes::Distribution">Distribution</a> for <a class="struct" href="struct.Multinomial.html" title="struct rusty_machine::learning::naive_bayes::Multinomial">Multinomial</a></h3></section></div><script src="../../../implementors/rusty_machine/learning/naive_bayes/trait.Distribution.js" async></script></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>