blob: eaf349bea680c274b2960985aa301a0fff0011cf [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="Source of the Rust file `/root/.cargo/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/rusty-machine/src/learning/dbscan.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>dbscan.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>
</pre><pre class="rust"><code><span class="doccomment">//! DBSCAN Clustering
//!
//! *Note: This module is likely to change dramatically in the future and
//! should be treated as experimental.*
//!
//! Provides an implementaton of DBSCAN clustering. The model
//! also implements a `predict` function which uses nearest neighbours
//! to classify the points. To utilize this function you must use
//! `self.set_predictive(true)` before training the model.
//!
//! The algorithm works by specifying `eps` and `min_points` parameters.
//! The `eps` parameter controls how close together points must be to be
//! placed in the same cluster. The `min_points` parameter controls how many
//! points must be within distance `eps` of eachother to be considered a cluster.
//!
//! If a point is not within distance `eps` of a cluster it will be classified
//! as noise. This means that it will be set to `None` in the clusters `Vector`.
//!
//! # Examples
//!
//! ```
//! use rusty_machine::learning::dbscan::DBSCAN;
//! use rusty_machine::learning::UnSupModel;
//! use rusty_machine::linalg::Matrix;
//!
//! let inputs = Matrix::new(6, 2, vec![1.0, 2.0,
//! 1.1, 2.2,
//! 0.9, 1.9,
//! 1.0, 2.1,
//! -2.0, 3.0,
//! -2.2, 3.1]);
//!
//! let mut model = DBSCAN::new(0.5, 2);
//! model.train(&amp;inputs).unwrap();
//!
//! let clustering = model.clusters().unwrap();
//! ```
</span><span class="kw">use </span>learning::{LearningResult, UnSupModel};
<span class="kw">use </span>learning::error::{Error, ErrorKind};
<span class="kw">use </span>linalg::{Matrix, Vector, BaseMatrix};
<span class="kw">use </span>rulinalg::utils;
<span class="kw">use </span>rulinalg::matrix::Row;
<span class="doccomment">/// DBSCAN Model
///
/// Implements clustering using the DBSCAN algorithm
/// via the `UnSupModel` trait.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>DBSCAN {
eps: f64,
min_points: usize,
clusters: <span class="prelude-ty">Option</span>&lt;Vector&lt;<span class="prelude-ty">Option</span>&lt;usize&gt;&gt;&gt;,
predictive: bool,
_visited: Vec&lt;bool&gt;,
_cluster_data: <span class="prelude-ty">Option</span>&lt;Matrix&lt;f64&gt;&gt;,
}
<span class="doccomment">/// Constructs a non-predictive DBSCAN model with the
/// following parameters:
///
/// - `eps` : `0.5`
/// - `min_points` : `5`
</span><span class="kw">impl </span>Default <span class="kw">for </span>DBSCAN {
<span class="kw">fn </span>default() -&gt; DBSCAN {
DBSCAN {
eps: <span class="number">0.5</span>,
min_points: <span class="number">5</span>,
clusters: <span class="prelude-val">None</span>,
predictive: <span class="bool-val">false</span>,
_visited: Vec::new(),
_cluster_data: <span class="prelude-val">None</span>,
}
}
}
<span class="kw">impl </span>UnSupModel&lt;Matrix&lt;f64&gt;, Vector&lt;<span class="prelude-ty">Option</span>&lt;usize&gt;&gt;&gt; <span class="kw">for </span>DBSCAN {
<span class="doccomment">/// Train the classifier using input data.
</span><span class="kw">fn </span>train(<span class="kw-2">&amp;mut </span><span class="self">self</span>, inputs: <span class="kw-2">&amp;</span>Matrix&lt;f64&gt;) -&gt; LearningResult&lt;()&gt; {
<span class="self">self</span>.init_params(inputs.rows());
<span class="kw">let </span><span class="kw-2">mut </span>cluster = <span class="number">0</span>;
<span class="kw">for </span>(idx, point) <span class="kw">in </span>inputs.row_iter().enumerate() {
<span class="kw">let </span>visited = <span class="self">self</span>._visited[idx];
<span class="kw">if </span>!visited {
<span class="self">self</span>._visited[idx] = <span class="bool-val">true</span>;
<span class="kw">let </span>neighbours = <span class="self">self</span>.region_query(point, inputs);
<span class="kw">if </span>neighbours.len() &gt;= <span class="self">self</span>.min_points {
<span class="self">self</span>.expand_cluster(inputs, idx, neighbours, cluster);
cluster += <span class="number">1</span>;
}
}
}
<span class="kw">if </span><span class="self">self</span>.predictive {
<span class="self">self</span>._cluster_data = <span class="prelude-val">Some</span>(inputs.clone());
}
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>predict(<span class="kw-2">&amp;</span><span class="self">self</span>, inputs: <span class="kw-2">&amp;</span>Matrix&lt;f64&gt;) -&gt; LearningResult&lt;Vector&lt;<span class="prelude-ty">Option</span>&lt;usize&gt;&gt;&gt; {
<span class="kw">if </span><span class="self">self</span>.predictive {
<span class="kw">if let </span>(<span class="kw-2">&amp;</span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>cluster_data), <span class="kw-2">&amp;</span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>clusters)) = (<span class="kw-2">&amp;</span><span class="self">self</span>._cluster_data,
<span class="kw-2">&amp;</span><span class="self">self</span>.clusters) {
<span class="kw">let </span><span class="kw-2">mut </span>classes = Vec::with_capacity(inputs.rows());
<span class="kw">for </span>input_point <span class="kw">in </span>inputs.row_iter() {
<span class="kw">let </span><span class="kw-2">mut </span>distances = Vec::with_capacity(cluster_data.rows());
<span class="kw">for </span>cluster_point <span class="kw">in </span>cluster_data.row_iter() {
<span class="kw">let </span>point_distance =
utils::vec_bin_op(input_point.raw_slice(), cluster_point.raw_slice(), |x, y| x - y);
distances.push(utils::dot(<span class="kw-2">&amp;</span>point_distance, <span class="kw-2">&amp;</span>point_distance).sqrt());
}
<span class="kw">let </span>(closest_idx, closest_dist) = utils::argmin(<span class="kw-2">&amp;</span>distances);
<span class="kw">if </span>closest_dist &lt; <span class="self">self</span>.eps {
classes.push(clusters[closest_idx]);
} <span class="kw">else </span>{
classes.push(<span class="prelude-val">None</span>);
}
}
<span class="prelude-val">Ok</span>(Vector::new(classes))
} <span class="kw">else </span>{
<span class="prelude-val">Err</span>(Error::new_untrained())
}
} <span class="kw">else </span>{
<span class="prelude-val">Err</span>(Error::new(ErrorKind::InvalidState,
<span class="string">&quot;Model must be set to predictive. Use `self.set_predictive(true)`.&quot;</span>))
}
}
}
<span class="kw">impl </span>DBSCAN {
<span class="doccomment">/// Create a new DBSCAN model with a given
/// distance episilon and minimum points per cluster.
</span><span class="kw">pub fn </span>new(eps: f64, min_points: usize) -&gt; DBSCAN {
<span class="macro">assert!</span>(eps &gt; <span class="number">0f64</span>, <span class="string">&quot;The model epsilon must be positive.&quot;</span>);
DBSCAN {
eps: eps,
min_points: min_points,
clusters: <span class="prelude-val">None</span>,
predictive: <span class="bool-val">false</span>,
_visited: Vec::new(),
_cluster_data: <span class="prelude-val">None</span>,
}
}
<span class="doccomment">/// Set predictive to true if the model is to be used
/// to classify future points.
///
/// If the model is set as predictive then the input data
/// will be cloned during training.
</span><span class="kw">pub fn </span>set_predictive(<span class="kw-2">&amp;mut </span><span class="self">self</span>, predictive: bool) {
<span class="self">self</span>.predictive = predictive;
}
<span class="doccomment">/// Return an Option pointing to the model clusters.
</span><span class="kw">pub fn </span>clusters(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>Vector&lt;<span class="prelude-ty">Option</span>&lt;usize&gt;&gt;&gt; {
<span class="self">self</span>.clusters.as_ref()
}
<span class="kw">fn </span>expand_cluster(<span class="kw-2">&amp;mut </span><span class="self">self</span>,
inputs: <span class="kw-2">&amp;</span>Matrix&lt;f64&gt;,
point_idx: usize,
neighbour_pts: Vec&lt;usize&gt;,
cluster: usize) {
<span class="macro">debug_assert!</span>(point_idx &lt; inputs.rows(),
<span class="string">&quot;Point index too large for inputs&quot;</span>);
<span class="macro">debug_assert!</span>(neighbour_pts.iter().all(|x| <span class="kw-2">*</span>x &lt; inputs.rows()),
<span class="string">&quot;Neighbour indices too large for inputs&quot;</span>);
<span class="self">self</span>.clusters.as_mut().map(|x| x.mut_data()[point_idx] = <span class="prelude-val">Some</span>(cluster));
<span class="kw">for </span>data_point_idx <span class="kw">in </span><span class="kw-2">&amp;</span>neighbour_pts {
<span class="kw">let </span>visited = <span class="self">self</span>._visited[<span class="kw-2">*</span>data_point_idx];
<span class="kw">if </span>!visited {
<span class="self">self</span>._visited[<span class="kw-2">*</span>data_point_idx] = <span class="bool-val">true</span>;
<span class="kw">let </span>data_point_row = <span class="kw">unsafe </span>{ inputs.row_unchecked(<span class="kw-2">*</span>data_point_idx) };
<span class="kw">let </span>sub_neighbours = <span class="self">self</span>.region_query(data_point_row, inputs);
<span class="kw">if </span>sub_neighbours.len() &gt;= <span class="self">self</span>.min_points {
<span class="self">self</span>.expand_cluster(inputs, <span class="kw-2">*</span>data_point_idx, sub_neighbours, cluster);
}
}
}
}
<span class="kw">fn </span>region_query(<span class="kw-2">&amp;</span><span class="self">self</span>, point: Row&lt;f64&gt;, inputs: <span class="kw-2">&amp;</span>Matrix&lt;f64&gt;) -&gt; Vec&lt;usize&gt; {
<span class="macro">debug_assert!</span>(point.cols() == inputs.cols(),
<span class="string">&quot;point must be of same dimension as inputs&quot;</span>);
<span class="kw">let </span><span class="kw-2">mut </span>in_neighbourhood = Vec::new();
<span class="kw">for </span>(idx, data_point) <span class="kw">in </span>inputs.row_iter().enumerate() {
<span class="comment">//TODO: Use `MatrixMetric` when rulinalg#154 is fixed.
</span><span class="kw">let </span>point_distance = utils::vec_bin_op(data_point.raw_slice(), point.raw_slice(), |x, y| x - y);
<span class="kw">let </span>dist = utils::dot(<span class="kw-2">&amp;</span>point_distance, <span class="kw-2">&amp;</span>point_distance).sqrt();
<span class="kw">if </span>dist &lt; <span class="self">self</span>.eps {
in_neighbourhood.push(idx);
}
}
in_neighbourhood
}
<span class="kw">fn </span>init_params(<span class="kw-2">&amp;mut </span><span class="self">self</span>, total_points: usize) {
<span class="kw">unsafe </span>{
<span class="self">self</span>._visited.reserve(total_points);
<span class="self">self</span>._visited.set_len(total_points);
}
<span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..total_points {
<span class="self">self</span>._visited[i] = <span class="bool-val">false</span>;
}
<span class="self">self</span>.clusters = <span class="prelude-val">Some</span>(Vector::new(<span class="macro">vec!</span>[<span class="prelude-val">None</span>; total_points]));
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span><span class="kw">super</span>::DBSCAN;
<span class="kw">use </span>linalg::{Matrix, BaseMatrix};
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_region_query() {
<span class="kw">let </span>model = DBSCAN::new(<span class="number">1.0</span>, <span class="number">3</span>);
<span class="kw">let </span>inputs = Matrix::new(<span class="number">3</span>, <span class="number">2</span>, <span class="macro">vec!</span>[<span class="number">1.0</span>, <span class="number">1.0</span>, <span class="number">1.1</span>, <span class="number">1.9</span>, <span class="number">3.0</span>, <span class="number">3.0</span>]);
<span class="kw">let </span>m = <span class="macro">matrix!</span>[<span class="number">1.0</span>, <span class="number">1.0</span>];
<span class="kw">let </span>row = m.row(<span class="number">0</span>);
<span class="kw">let </span>neighbours = model.region_query(row, <span class="kw-2">&amp;</span>inputs);
<span class="macro">assert!</span>(neighbours.len() == <span class="number">2</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_region_query_small_eps() {
<span class="kw">let </span>model = DBSCAN::new(<span class="number">0.01</span>, <span class="number">3</span>);
<span class="kw">let </span>inputs = Matrix::new(<span class="number">3</span>, <span class="number">2</span>, <span class="macro">vec!</span>[<span class="number">1.0</span>, <span class="number">1.0</span>, <span class="number">1.1</span>, <span class="number">1.9</span>, <span class="number">1.1</span>, <span class="number">1.1</span>]);
<span class="kw">let </span>m = <span class="macro">matrix!</span>[<span class="number">1.0</span>, <span class="number">1.0</span>];
<span class="kw">let </span>row = m.row(<span class="number">0</span>);
<span class="kw">let </span>neighbours = model.region_query(row, <span class="kw-2">&amp;</span>inputs);
<span class="macro">assert!</span>(neighbours.len() == <span class="number">1</span>);
}
}
</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>