| <!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="Trait for cost functions in models."><meta name="keywords" content="rust, rustlang, rust-lang, CostFunc"><title>CostFunc in rusty_machine::learning::toolkit::cost_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 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">☰</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="#">CostFunc</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.cost">cost</a></li><li><a href="#tymethod.grad_cost">grad_cost</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In rusty_machine::learning::toolkit::cost_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">Trait <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">cost_fn</a>::<wbr><a class="trait" href="#">CostFunc</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/cost_fn.rs.html#15-21">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 trait"><code>pub trait CostFunc<T> { |
| fn <a href="#tymethod.cost" class="fnname">cost</a>(outputs: &T, targets: &T) -> f64; |
| <span class="item-spacer"></span> fn <a href="#tymethod.grad_cost" class="fnname">grad_cost</a>(outputs: &T, targets: &T) -> T; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for cost functions in models.</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.cost" class="method has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/cost_fn.rs.html#17">source</a><h4 class="code-header">fn <a href="#tymethod.cost" class="fnname">cost</a>(outputs: &T, targets: &T) -> f64</h4></section></summary><div class="docblock"><p>The cost function.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.grad_cost" class="method has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/cost_fn.rs.html#20">source</a><h4 class="code-header">fn <a href="#tymethod.grad_cost" class="fnname">grad_cost</a>(outputs: &T, targets: &T) -> T</h4></section></summary><div class="docblock"><p>The gradient of the cost function.</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-CostFunc%3CMatrix%3Cf64%3E%3E-for-CrossEntropyError" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/cost_fn.rs.html#63-79">source</a><a href="#impl-CostFunc%3CMatrix%3Cf64%3E%3E-for-CrossEntropyError" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.CostFunc.html" title="trait rusty_machine::learning::toolkit::cost_fn::CostFunc">CostFunc</a><<a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><f64>> for <a class="struct" href="struct.CrossEntropyError.html" title="struct rusty_machine::learning::toolkit::cost_fn::CrossEntropyError">CrossEntropyError</a></h3></section><section id="impl-CostFunc%3CMatrix%3Cf64%3E%3E-for-MeanSqError" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/cost_fn.rs.html#29-42">source</a><a href="#impl-CostFunc%3CMatrix%3Cf64%3E%3E-for-MeanSqError" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.CostFunc.html" title="trait rusty_machine::learning::toolkit::cost_fn::CostFunc">CostFunc</a><<a class="struct" href="../../../linalg/struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><f64>> for <a class="struct" href="struct.MeanSqError.html" title="struct rusty_machine::learning::toolkit::cost_fn::MeanSqError">MeanSqError</a></h3></section><section id="impl-CostFunc%3CVector%3Cf64%3E%3E-for-CrossEntropyError" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/cost_fn.rs.html#81-97">source</a><a href="#impl-CostFunc%3CVector%3Cf64%3E%3E-for-CrossEntropyError" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.CostFunc.html" title="trait rusty_machine::learning::toolkit::cost_fn::CostFunc">CostFunc</a><<a class="struct" href="../../../linalg/struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a><f64>> for <a class="struct" href="struct.CrossEntropyError.html" title="struct rusty_machine::learning::toolkit::cost_fn::CrossEntropyError">CrossEntropyError</a></h3></section><section id="impl-CostFunc%3CVector%3Cf64%3E%3E-for-MeanSqError" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/cost_fn.rs.html#44-57">source</a><a href="#impl-CostFunc%3CVector%3Cf64%3E%3E-for-MeanSqError" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.CostFunc.html" title="trait rusty_machine::learning::toolkit::cost_fn::CostFunc">CostFunc</a><<a class="struct" href="../../../linalg/struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a><f64>> for <a class="struct" href="struct.MeanSqError.html" title="struct rusty_machine::learning::toolkit::cost_fn::MeanSqError">MeanSqError</a></h3></section></div><script src="../../../../implementors/rusty_machine/learning/toolkit/cost_fn/trait.CostFunc.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> |
