blob: 456f778c8b11b7398f7e61df51731d8871f8c5b1 [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="The Kernel trait"><meta name="keywords" content="rust, rustlang, rust-lang, Kernel"><title>Kernel in rusty_machine::learning::toolkit::kernel - 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="#">Kernel</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.kernel">kernel</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In rusty_machine::learning::toolkit::kernel</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">kernel</a>::<wbr><a class="trait" href="#">Kernel</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/kernel.rs.html#14-19">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 Kernel {
fn <a href="#tymethod.kernel" class="fnname">kernel</a>(&amp;self, x1: &amp;[f64], x2: &amp;[f64]) -&gt; f64;
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The Kernel trait</p>
<p>Requires a function mapping two vectors to a scalar.</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.kernel" class="method has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/kernel.rs.html#18">source</a><h4 class="code-header">fn <a href="#tymethod.kernel" class="fnname">kernel</a>(&amp;self, x1: &amp;[f64], x2: &amp;[f64]) -&gt; f64</h4></section></summary><div class="docblock"><p>The kernel function.</p>
<p>Takes two equal length slices and returns a scalar.</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-Kernel-for-Exponential" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/kernel.rs.html#346-356">source</a><a href="#impl-Kernel-for-Exponential" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Kernel.html" title="trait rusty_machine::learning::toolkit::kernel::Kernel">Kernel</a> for <a class="struct" href="struct.Exponential.html" title="struct rusty_machine::learning::toolkit::kernel::Exponential">Exponential</a></h3></section><section id="impl-Kernel-for-HyperTan" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/kernel.rs.html#406-410">source</a><a href="#impl-Kernel-for-HyperTan" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Kernel.html" title="trait rusty_machine::learning::toolkit::kernel::Kernel">Kernel</a> for <a class="struct" href="struct.HyperTan.html" title="struct rusty_machine::learning::toolkit::kernel::HyperTan">HyperTan</a></h3></section><section id="impl-Kernel-for-Linear" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/kernel.rs.html#167-171">source</a><a href="#impl-Kernel-for-Linear" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Kernel.html" title="trait rusty_machine::learning::toolkit::kernel::Kernel">Kernel</a> for <a class="struct" href="struct.Linear.html" title="struct rusty_machine::learning::toolkit::kernel::Linear">Linear</a></h3></section><section id="impl-Kernel-for-Multiquadric" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/kernel.rs.html#451-457">source</a><a href="#impl-Kernel-for-Multiquadric" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Kernel.html" title="trait rusty_machine::learning::toolkit::kernel::Kernel">Kernel</a> for <a class="struct" href="struct.Multiquadric.html" title="struct rusty_machine::learning::toolkit::kernel::Multiquadric">Multiquadric</a></h3></section><section id="impl-Kernel-for-Polynomial" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/kernel.rs.html#226-230">source</a><a href="#impl-Kernel-for-Polynomial" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Kernel.html" title="trait rusty_machine::learning::toolkit::kernel::Kernel">Kernel</a> for <a class="struct" href="struct.Polynomial.html" title="struct rusty_machine::learning::toolkit::kernel::Polynomial">Polynomial</a></h3></section><section id="impl-Kernel-for-RationalQuadratic" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/kernel.rs.html#507-513">source</a><a href="#impl-Kernel-for-RationalQuadratic" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Kernel.html" title="trait rusty_machine::learning::toolkit::kernel::Kernel">Kernel</a> for <a class="struct" href="struct.RationalQuadratic.html" title="struct rusty_machine::learning::toolkit::kernel::RationalQuadratic">RationalQuadratic</a></h3></section><section id="impl-Kernel-for-SquaredExp" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/kernel.rs.html#284-294">source</a><a href="#impl-Kernel-for-SquaredExp" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Kernel.html" title="trait rusty_machine::learning::toolkit::kernel::Kernel">Kernel</a> for <a class="struct" href="struct.SquaredExp.html" title="struct rusty_machine::learning::toolkit::kernel::SquaredExp">SquaredExp</a></h3></section><section id="impl-Kernel-for-KernelProd%3CT%2C%20U%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/kernel.rs.html#94-101">source</a><a href="#impl-Kernel-for-KernelProd%3CT%2C%20U%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="trait.Kernel.html" title="trait rusty_machine::learning::toolkit::kernel::Kernel">Kernel</a> for <a class="struct" href="struct.KernelProd.html" title="struct rusty_machine::learning::toolkit::kernel::KernelProd">KernelProd</a>&lt;T, U&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="trait.Kernel.html" title="trait rusty_machine::learning::toolkit::kernel::Kernel">Kernel</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="trait.Kernel.html" title="trait rusty_machine::learning::toolkit::kernel::Kernel">Kernel</a>,</span></h3></section><div class="docblock"><p>Computes the product of the two associated kernels.</p>
</div><section id="impl-Kernel-for-KernelSum%3CT%2C%20U%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/rusty_machine/learning/toolkit/kernel.rs.html#53-60">source</a><a href="#impl-Kernel-for-KernelSum%3CT%2C%20U%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="trait.Kernel.html" title="trait rusty_machine::learning::toolkit::kernel::Kernel">Kernel</a> for <a class="struct" href="struct.KernelSum.html" title="struct rusty_machine::learning::toolkit::kernel::KernelSum">KernelSum</a>&lt;T, U&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="trait.Kernel.html" title="trait rusty_machine::learning::toolkit::kernel::Kernel">Kernel</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="trait.Kernel.html" title="trait rusty_machine::learning::toolkit::kernel::Kernel">Kernel</a>,</span></h3></section><div class="docblock"><p>Computes the sum of the two associated kernels.</p>
</div></div><script src="../../../../implementors/rusty_machine/learning/toolkit/kernel/trait.Kernel.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>