| <!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="Source of the Rust file `/root/.cargo/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/rusty-machine/src/learning/toolkit/kernel.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>kernel.rs - source</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="../../../../source-script.js"></script><script defer src="../../../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><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></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../../rusty_machine/index.html"><img class="rust-logo" src="../../../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| <span id="383">383</span> |
| <span id="384">384</span> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| <span id="392">392</span> |
| <span id="393">393</span> |
| <span id="394">394</span> |
| <span id="395">395</span> |
| <span id="396">396</span> |
| <span id="397">397</span> |
| <span id="398">398</span> |
| <span id="399">399</span> |
| <span id="400">400</span> |
| <span id="401">401</span> |
| <span id="402">402</span> |
| <span id="403">403</span> |
| <span id="404">404</span> |
| <span id="405">405</span> |
| <span id="406">406</span> |
| <span id="407">407</span> |
| <span id="408">408</span> |
| <span id="409">409</span> |
| <span id="410">410</span> |
| <span id="411">411</span> |
| <span id="412">412</span> |
| <span id="413">413</span> |
| <span id="414">414</span> |
| <span id="415">415</span> |
| <span id="416">416</span> |
| <span id="417">417</span> |
| <span id="418">418</span> |
| <span id="419">419</span> |
| <span id="420">420</span> |
| <span id="421">421</span> |
| <span id="422">422</span> |
| <span id="423">423</span> |
| <span id="424">424</span> |
| <span id="425">425</span> |
| <span id="426">426</span> |
| <span id="427">427</span> |
| <span id="428">428</span> |
| <span id="429">429</span> |
| <span id="430">430</span> |
| <span id="431">431</span> |
| <span id="432">432</span> |
| <span id="433">433</span> |
| <span id="434">434</span> |
| <span id="435">435</span> |
| <span id="436">436</span> |
| <span id="437">437</span> |
| <span id="438">438</span> |
| <span id="439">439</span> |
| <span id="440">440</span> |
| <span id="441">441</span> |
| <span id="442">442</span> |
| <span id="443">443</span> |
| <span id="444">444</span> |
| <span id="445">445</span> |
| <span id="446">446</span> |
| <span id="447">447</span> |
| <span id="448">448</span> |
| <span id="449">449</span> |
| <span id="450">450</span> |
| <span id="451">451</span> |
| <span id="452">452</span> |
| <span id="453">453</span> |
| <span id="454">454</span> |
| <span id="455">455</span> |
| <span id="456">456</span> |
| <span id="457">457</span> |
| <span id="458">458</span> |
| <span id="459">459</span> |
| <span id="460">460</span> |
| <span id="461">461</span> |
| <span id="462">462</span> |
| <span id="463">463</span> |
| <span id="464">464</span> |
| <span id="465">465</span> |
| <span id="466">466</span> |
| <span id="467">467</span> |
| <span id="468">468</span> |
| <span id="469">469</span> |
| <span id="470">470</span> |
| <span id="471">471</span> |
| <span id="472">472</span> |
| <span id="473">473</span> |
| <span id="474">474</span> |
| <span id="475">475</span> |
| <span id="476">476</span> |
| <span id="477">477</span> |
| <span id="478">478</span> |
| <span id="479">479</span> |
| <span id="480">480</span> |
| <span id="481">481</span> |
| <span id="482">482</span> |
| <span id="483">483</span> |
| <span id="484">484</span> |
| <span id="485">485</span> |
| <span id="486">486</span> |
| <span id="487">487</span> |
| <span id="488">488</span> |
| <span id="489">489</span> |
| <span id="490">490</span> |
| <span id="491">491</span> |
| <span id="492">492</span> |
| <span id="493">493</span> |
| <span id="494">494</span> |
| <span id="495">495</span> |
| <span id="496">496</span> |
| <span id="497">497</span> |
| <span id="498">498</span> |
| <span id="499">499</span> |
| <span id="500">500</span> |
| <span id="501">501</span> |
| <span id="502">502</span> |
| <span id="503">503</span> |
| <span id="504">504</span> |
| <span id="505">505</span> |
| <span id="506">506</span> |
| <span id="507">507</span> |
| <span id="508">508</span> |
| <span id="509">509</span> |
| <span id="510">510</span> |
| <span id="511">511</span> |
| <span id="512">512</span> |
| <span id="513">513</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! Module for kernels |
| //! |
| //! Currently used within Gaussian Processes and SVMs. |
| |
| </span><span class="kw">use </span>std::ops::{Add, Mul}; |
| |
| <span class="kw">use </span>linalg::Vector; |
| <span class="kw">use </span>linalg::norm::{Euclidean, VectorNorm, VectorMetric}; |
| <span class="kw">use </span>rulinalg::utils; |
| |
| <span class="doccomment">/// The Kernel trait |
| /// |
| /// Requires a function mapping two vectors to a scalar. |
| </span><span class="kw">pub trait </span>Kernel { |
| <span class="doccomment">/// The kernel function. |
| /// |
| /// Takes two equal length slices and returns a scalar. |
| </span><span class="kw">fn </span>kernel(<span class="kw-2">&</span><span class="self">self</span>, x1: <span class="kw-2">&</span>[f64], x2: <span class="kw-2">&</span>[f64]) -> f64; |
| } |
| |
| <span class="doccomment">/// The sum of two kernels |
| /// |
| /// This struct should not be directly instantiated but instead |
| /// is created when we add two kernels together. |
| /// |
| /// Note that it will be more efficient to implement the final kernel |
| /// manually yourself. However this provides an easy mechanism to test |
| /// different combinations. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use rusty_machine::learning::toolkit::kernel::{Kernel, Polynomial, HyperTan, KernelArith}; |
| /// |
| /// let poly_ker = Polynomial::new(1f64,2f64,3f64); |
| /// let hypert_ker = HyperTan::new(1f64,2.5); |
| /// |
| /// let poly_plus_hypert_ker = KernelArith(poly_ker) + KernelArith(hypert_ker); |
| /// |
| /// println!("{0}", poly_plus_hypert_ker.kernel(&[1f64,2f64,3f64], |
| /// &[3f64,1f64,2f64])); |
| /// ``` |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>KernelSum<T, U> |
| <span class="kw">where </span>T: Kernel, |
| U: Kernel |
| { |
| k1: T, |
| k2: U, |
| } |
| |
| <span class="doccomment">/// Computes the sum of the two associated kernels. |
| </span><span class="kw">impl</span><T, U> Kernel <span class="kw">for </span>KernelSum<T, U> |
| <span class="kw">where </span>T: Kernel, |
| U: Kernel |
| { |
| <span class="kw">fn </span>kernel(<span class="kw-2">&</span><span class="self">self</span>, x1: <span class="kw-2">&</span>[f64], x2: <span class="kw-2">&</span>[f64]) -> f64 { |
| <span class="self">self</span>.k1.kernel(x1, x2) + <span class="self">self</span>.k2.kernel(x1, x2) |
| } |
| } |
| |
| <span class="doccomment">/// The pointwise product of two kernels |
| /// |
| /// This struct should not be directly instantiated but instead |
| /// is created when we multiply two kernels together. |
| /// |
| /// Note that it will be more efficient to implement the final kernel |
| /// manually yourself. However this provides an easy mechanism to test |
| /// different combinations. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use rusty_machine::learning::toolkit::kernel::{Kernel, Polynomial, HyperTan, KernelArith}; |
| /// |
| /// let poly_ker = Polynomial::new(1f64,2f64,3f64); |
| /// let hypert_ker = HyperTan::new(1f64,2.5); |
| /// |
| /// let poly_plus_hypert_ker = KernelArith(poly_ker) * KernelArith(hypert_ker); |
| /// |
| /// println!("{0}", poly_plus_hypert_ker.kernel(&[1f64,2f64,3f64], |
| /// &[3f64,1f64,2f64])); |
| /// ``` |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>KernelProd<T, U> |
| <span class="kw">where </span>T: Kernel, |
| U: Kernel |
| { |
| k1: T, |
| k2: U, |
| } |
| |
| <span class="doccomment">/// Computes the product of the two associated kernels. |
| </span><span class="kw">impl</span><T, U> Kernel <span class="kw">for </span>KernelProd<T, U> |
| <span class="kw">where </span>T: Kernel, |
| U: Kernel |
| { |
| <span class="kw">fn </span>kernel(<span class="kw-2">&</span><span class="self">self</span>, x1: <span class="kw-2">&</span>[f64], x2: <span class="kw-2">&</span>[f64]) -> f64 { |
| <span class="self">self</span>.k1.kernel(x1, x2) * <span class="self">self</span>.k2.kernel(x1, x2) |
| } |
| } |
| |
| <span class="doccomment">/// A wrapper tuple struct used for kernel arithmetic |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>KernelArith<K: Kernel>(<span class="kw">pub </span>K); |
| |
| <span class="kw">impl</span><T: Kernel, U: Kernel> Add<KernelArith<T>> <span class="kw">for </span>KernelArith<U> { |
| <span class="kw">type </span>Output = KernelSum<U, T>; |
| |
| <span class="kw">fn </span>add(<span class="self">self</span>, ker: KernelArith<T>) -> KernelSum<U, T> { |
| KernelSum { |
| k1: <span class="self">self</span>.<span class="number">0</span>, |
| k2: ker.<span class="number">0</span>, |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><T: Kernel, U: Kernel> Mul<KernelArith<T>> <span class="kw">for </span>KernelArith<U> { |
| <span class="kw">type </span>Output = KernelProd<U, T>; |
| |
| <span class="kw">fn </span>mul(<span class="self">self</span>, ker: KernelArith<T>) -> KernelProd<U, T> { |
| KernelProd { |
| k1: <span class="self">self</span>.<span class="number">0</span>, |
| k2: ker.<span class="number">0</span>, |
| } |
| } |
| } |
| |
| <span class="doccomment">/// The Linear Kernel |
| /// |
| /// k(x,y) = x<sup>T</sup>y + c |
| </span><span class="attribute">#[derive(Clone, Copy, Debug)] |
| </span><span class="kw">pub struct </span>Linear { |
| <span class="doccomment">/// Constant term added to inner product. |
| </span><span class="kw">pub </span>c: f64, |
| } |
| |
| <span class="kw">impl </span>Linear { |
| <span class="doccomment">/// Constructs a new Linear Kernel. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use rusty_machine::learning::toolkit::kernel; |
| /// use rusty_machine::learning::toolkit::kernel::Kernel; |
| /// |
| /// let ker = kernel::Linear::new(5.0); |
| /// |
| /// println!("{0}", ker.kernel(&[1.,2.,3.], &[3.,4.,5.])); |
| /// ``` |
| </span><span class="kw">pub fn </span>new(c: f64) -> Linear { |
| Linear { c: c } |
| } |
| } |
| |
| <span class="doccomment">/// Constructs the default Linear Kernel |
| /// |
| /// The defaults are: |
| /// |
| /// - c = 0 |
| </span><span class="kw">impl </span>Default <span class="kw">for </span>Linear { |
| <span class="kw">fn </span>default() -> Linear { |
| Linear { c: <span class="number">0f64 </span>} |
| } |
| } |
| |
| <span class="kw">impl </span>Kernel <span class="kw">for </span>Linear { |
| <span class="kw">fn </span>kernel(<span class="kw-2">&</span><span class="self">self</span>, x1: <span class="kw-2">&</span>[f64], x2: <span class="kw-2">&</span>[f64]) -> f64 { |
| utils::dot(x1, x2) + <span class="self">self</span>.c |
| } |
| } |
| |
| <span class="doccomment">/// The Polynomial Kernel |
| /// |
| /// k(x,y) = (αx<sup>T</sup>y + c)<sup>d</sup> |
| </span><span class="attribute">#[derive(Clone, Copy, Debug)] |
| </span><span class="kw">pub struct </span>Polynomial { |
| <span class="doccomment">/// Scaling of the inner product. |
| </span><span class="kw">pub </span>alpha: f64, |
| <span class="doccomment">/// Constant added to inner product. |
| </span><span class="kw">pub </span>c: f64, |
| <span class="doccomment">/// The power to raise the sum to. |
| </span><span class="kw">pub </span>d: f64, |
| } |
| |
| <span class="kw">impl </span>Polynomial { |
| <span class="doccomment">/// Constructs a new Polynomial Kernel. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use rusty_machine::learning::toolkit::kernel; |
| /// use rusty_machine::learning::toolkit::kernel::Kernel; |
| /// |
| /// // Constructs a new polynomial with alpha = 1, c = 0, d = 2. |
| /// let ker = kernel::Polynomial::new(1.0, 0.0, 2.0); |
| /// |
| /// println!("{0}", ker.kernel(&[1.,2.,3.], &[3.,4.,5.])); |
| /// ``` |
| </span><span class="kw">pub fn </span>new(alpha: f64, c: f64, d: f64) -> Polynomial { |
| Polynomial { |
| alpha: alpha, |
| c: c, |
| d: d, |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Construct a new polynomial kernel. |
| /// |
| /// The defaults are: |
| /// |
| /// - alpha = 1 |
| /// - c = 0 |
| /// - d = 1 |
| </span><span class="kw">impl </span>Default <span class="kw">for </span>Polynomial { |
| <span class="kw">fn </span>default() -> Polynomial { |
| Polynomial { |
| alpha: <span class="number">1f64</span>, |
| c: <span class="number">0f64</span>, |
| d: <span class="number">1f64</span>, |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Kernel <span class="kw">for </span>Polynomial { |
| <span class="kw">fn </span>kernel(<span class="kw-2">&</span><span class="self">self</span>, x1: <span class="kw-2">&</span>[f64], x2: <span class="kw-2">&</span>[f64]) -> f64 { |
| (<span class="self">self</span>.alpha * utils::dot(x1, x2) + <span class="self">self</span>.c).powf(<span class="self">self</span>.d) |
| } |
| } |
| |
| <span class="doccomment">/// Squared exponential kernel |
| /// |
| /// Equivalently a gaussian function. |
| /// |
| /// k(x,y) = A _exp_(-||x-y||<sup>2</sup> / 2l<sup>2</sup>) |
| /// |
| /// Where A is the amplitude and l the length scale. |
| </span><span class="attribute">#[derive(Clone, Copy, Debug)] |
| </span><span class="kw">pub struct </span>SquaredExp { |
| <span class="doccomment">/// The length scale of the kernel. |
| </span><span class="kw">pub </span>ls: f64, |
| <span class="doccomment">/// The amplitude of the kernel. |
| </span><span class="kw">pub </span>ampl: f64, |
| } |
| |
| <span class="kw">impl </span>SquaredExp { |
| <span class="doccomment">/// Construct a new squared exponential kernel. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use rusty_machine::learning::toolkit::kernel; |
| /// use rusty_machine::learning::toolkit::kernel::Kernel; |
| /// |
| /// // Construct a kernel with lengthscale 2 and amplitude 1. |
| /// let ker = kernel::SquaredExp::new(2f64, 1f64); |
| /// |
| /// println!("{0}", ker.kernel(&[1.,2.,3.], &[3.,4.,5.])); |
| /// ``` |
| </span><span class="kw">pub fn </span>new(ls: f64, ampl: f64) -> SquaredExp { |
| SquaredExp { |
| ls: ls, |
| ampl: ampl, |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Constructs the default Squared Exp kernel. |
| /// |
| /// The defaults are: |
| /// |
| /// - ls = 1 |
| /// - ampl = 1 |
| </span><span class="kw">impl </span>Default <span class="kw">for </span>SquaredExp { |
| <span class="kw">fn </span>default() -> SquaredExp { |
| SquaredExp { |
| ls: <span class="number">1f64</span>, |
| ampl: <span class="number">1f64</span>, |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Kernel <span class="kw">for </span>SquaredExp { |
| <span class="doccomment">/// The squared exponential kernel function. |
| </span><span class="kw">fn </span>kernel(<span class="kw-2">&</span><span class="self">self</span>, x1: <span class="kw-2">&</span>[f64], x2: <span class="kw-2">&</span>[f64]) -> f64 { |
| <span class="macro">assert_eq!</span>(x1.len(), x2.len()); |
| |
| <span class="kw">let </span>diff = Vector::new(x1.to_vec()) - Vector::new(x2.to_vec()); |
| |
| <span class="kw">let </span>x = -diff.dot(<span class="kw-2">&</span>diff) / (<span class="number">2f64 </span>* <span class="self">self</span>.ls * <span class="self">self</span>.ls); |
| (<span class="self">self</span>.ampl * x.exp()) |
| } |
| } |
| |
| <span class="doccomment">/// The Exponential Kernel |
| /// |
| /// k(x,y) = A _exp_(-||x-y|| / 2l<sup>2</sup>) |
| /// |
| /// Where A is the amplitude and l is the length scale. |
| </span><span class="attribute">#[derive(Clone, Copy, Debug)] |
| </span><span class="kw">pub struct </span>Exponential { |
| <span class="doccomment">/// The length scale of the kernel. |
| </span><span class="kw">pub </span>ls: f64, |
| <span class="doccomment">/// The amplitude of the kernel. |
| </span><span class="kw">pub </span>ampl: f64, |
| } |
| |
| <span class="kw">impl </span>Exponential { |
| <span class="doccomment">/// Construct a new squared exponential kernel. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use rusty_machine::learning::toolkit::kernel; |
| /// use rusty_machine::learning::toolkit::kernel::Kernel; |
| /// |
| /// // Construct a kernel with lengthscale 2 and amplitude 1. |
| /// let ker = kernel::Exponential::new(2f64, 1f64); |
| /// |
| /// println!("{0}", ker.kernel(&[1.,2.,3.], &[3.,4.,5.])); |
| /// ``` |
| </span><span class="kw">pub fn </span>new(ls: f64, ampl: f64) -> Exponential { |
| Exponential { |
| ls: ls, |
| ampl: ampl, |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Constructs the default Exponential kernel. |
| /// |
| /// The defaults are: |
| /// |
| /// - ls = 1 |
| /// - amplitude = 1 |
| </span><span class="kw">impl </span>Default <span class="kw">for </span>Exponential { |
| <span class="kw">fn </span>default() -> Exponential { |
| Exponential { |
| ls: <span class="number">1f64</span>, |
| ampl: <span class="number">1f64</span>, |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Kernel <span class="kw">for </span>Exponential { |
| <span class="doccomment">/// The squared exponential kernel function. |
| </span><span class="kw">fn </span>kernel(<span class="kw-2">&</span><span class="self">self</span>, x1: <span class="kw-2">&</span>[f64], x2: <span class="kw-2">&</span>[f64]) -> f64 { |
| <span class="macro">assert_eq!</span>(x1.len(), x2.len()); |
| |
| <span class="kw">let </span>diff = Vector::new(x1.to_vec()) - Vector::new(x2.to_vec()); |
| |
| <span class="kw">let </span>x = -Euclidean.norm(<span class="kw-2">&</span>diff) / (<span class="number">2f64 </span>* <span class="self">self</span>.ls * <span class="self">self</span>.ls); |
| (<span class="self">self</span>.ampl * x.exp()) |
| } |
| } |
| |
| <span class="doccomment">/// The Hyperbolic Tangent Kernel. |
| /// |
| /// ker(x,y) = _tanh_(αx<sup>T</sup>y + c) |
| </span><span class="attribute">#[derive(Clone, Copy, Debug)] |
| </span><span class="kw">pub struct </span>HyperTan { |
| <span class="doccomment">/// The scaling of the inner product. |
| </span><span class="kw">pub </span>alpha: f64, |
| <span class="doccomment">/// The constant to add to the inner product. |
| </span><span class="kw">pub </span>c: f64, |
| } |
| |
| <span class="kw">impl </span>HyperTan { |
| <span class="doccomment">/// Constructs a new Hyperbolic Tangent Kernel. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use rusty_machine::learning::toolkit::kernel; |
| /// use rusty_machine::learning::toolkit::kernel::Kernel; |
| /// |
| /// // Construct a kernel with alpha = 1, c = 2. |
| /// let ker = kernel::HyperTan::new(1.0, 2.0); |
| /// |
| /// println!("{0}", ker.kernel(&[1.,2.,3.], &[3.,4.,5.])); |
| /// ``` |
| </span><span class="kw">pub fn </span>new(alpha: f64, c: f64) -> HyperTan { |
| HyperTan { |
| alpha: alpha, |
| c: c, |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Constructs a default Hyperbolic Tangent Kernel. |
| /// |
| /// The defaults are: |
| /// |
| /// - alpha = 1 |
| /// - c = 0 |
| </span><span class="kw">impl </span>Default <span class="kw">for </span>HyperTan { |
| <span class="kw">fn </span>default() -> HyperTan { |
| HyperTan { |
| alpha: <span class="number">1f64</span>, |
| c: <span class="number">0f64</span>, |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Kernel <span class="kw">for </span>HyperTan { |
| <span class="kw">fn </span>kernel(<span class="kw-2">&</span><span class="self">self</span>, x1: <span class="kw-2">&</span>[f64], x2: <span class="kw-2">&</span>[f64]) -> f64 { |
| (<span class="self">self</span>.alpha * utils::dot(x1, x2) + <span class="self">self</span>.c).tanh() |
| } |
| } |
| |
| <span class="doccomment">/// The Multiquadric Kernel. |
| /// |
| /// k(x,y) = _sqrt_(||x-y||<sup>2</sup> + c<sup>2</sup>) |
| </span><span class="attribute">#[derive(Clone, Copy, Debug)] |
| </span><span class="kw">pub struct </span>Multiquadric { |
| <span class="doccomment">/// Constant added to square of difference. |
| </span><span class="kw">pub </span>c: f64, |
| } |
| |
| <span class="kw">impl </span>Multiquadric { |
| <span class="doccomment">/// Constructs a new Multiquadric Kernel. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use rusty_machine::learning::toolkit::kernel; |
| /// use rusty_machine::learning::toolkit::kernel::Kernel; |
| /// |
| /// // Construct a kernel with c = 2. |
| /// let ker = kernel::Multiquadric::new(2.0); |
| /// |
| /// println!("{0}", ker.kernel(&[1.,2.,3.], &[3.,4.,5.])); |
| /// ``` |
| </span><span class="kw">pub fn </span>new(c: f64) -> Multiquadric { |
| Multiquadric { c: c } |
| } |
| } |
| |
| <span class="doccomment">/// Constructs a default Multiquadric Kernel. |
| /// |
| /// The defaults are: |
| /// |
| /// - c = 0 |
| </span><span class="kw">impl </span>Default <span class="kw">for </span>Multiquadric { |
| <span class="kw">fn </span>default() -> Multiquadric { |
| Multiquadric { c: <span class="number">0f64 </span>} |
| } |
| } |
| |
| <span class="kw">impl </span>Kernel <span class="kw">for </span>Multiquadric { |
| <span class="kw">fn </span>kernel(<span class="kw-2">&</span><span class="self">self</span>, x1: <span class="kw-2">&</span>[f64], x2: <span class="kw-2">&</span>[f64]) -> f64 { |
| <span class="macro">assert_eq!</span>(x1.len(), x2.len()); |
| |
| Euclidean.metric(<span class="kw-2">&</span>(x1.into()), <span class="kw-2">&</span>(x2.into())).hypot(<span class="self">self</span>.c) |
| } |
| } |
| |
| <span class="doccomment">/// The Rational Quadratic Kernel. |
| /// |
| /// k(x,y) = (1 + ||x-y||<sup>2</sup> / (2αl<sup>2</sup>))<sup>-α</sup> |
| </span><span class="attribute">#[derive(Clone, Copy, Debug)] |
| </span><span class="kw">pub struct </span>RationalQuadratic { |
| <span class="doccomment">/// Controls inverse power and difference scale. |
| </span><span class="kw">pub </span>alpha: f64, |
| <span class="doccomment">/// Length scale controls scale of difference. |
| </span><span class="kw">pub </span>ls: f64, |
| } |
| |
| <span class="kw">impl </span>RationalQuadratic { |
| <span class="doccomment">/// Constructs a new Rational Quadratic Kernel. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use rusty_machine::learning::toolkit::kernel; |
| /// use rusty_machine::learning::toolkit::kernel::Kernel; |
| /// |
| /// // Construct a kernel with alpha = 2, ls = 2. |
| /// let ker = kernel::RationalQuadratic::new(2.0, 2.0); |
| /// |
| /// println!("{0}", ker.kernel(&[1.,2.,3.], &[3.,4.,5.])); |
| /// ``` |
| </span><span class="kw">pub fn </span>new(alpha: f64, ls: f64) -> RationalQuadratic { |
| RationalQuadratic { |
| alpha: alpha, |
| ls: ls, |
| } |
| } |
| } |
| |
| <span class="doccomment">/// The default Rational Qaudratic Kernel. |
| /// |
| /// The defaults are: |
| /// |
| /// - alpha = 1 |
| /// - ls = 1 |
| </span><span class="kw">impl </span>Default <span class="kw">for </span>RationalQuadratic { |
| <span class="kw">fn </span>default() -> RationalQuadratic { |
| RationalQuadratic { |
| alpha: <span class="number">1f64</span>, |
| ls: <span class="number">1f64</span>, |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Kernel <span class="kw">for </span>RationalQuadratic { |
| <span class="kw">fn </span>kernel(<span class="kw-2">&</span><span class="self">self</span>, x1: <span class="kw-2">&</span>[f64], x2: <span class="kw-2">&</span>[f64]) -> f64 { |
| <span class="kw">let </span>diff = Vector::new(x1.to_vec()) - Vector::new(x2.to_vec()); |
| |
| (<span class="number">1f64 </span>+ diff.dot(<span class="kw-2">&</span>diff) / (<span class="number">2f64 </span>* <span class="self">self</span>.alpha * <span class="self">self</span>.ls * <span class="self">self</span>.ls)).powf(-<span class="self">self</span>.alpha) |
| } |
| } |
| </code></pre></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> |