| <!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="DBSCAN Clustering"><meta name="keywords" content="rust, rustlang, rust-lang, dbscan"><title>rusty_machine::learning::dbscan - 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="../../../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 mod"><!--[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="#">Module dbscan</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li></ul></section></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">Module <a href="../../index.html">rusty_machine</a>::<wbr><a href="../index.html">learning</a>::<wbr><a class="mod" href="#">dbscan</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/dbscan.rs.html#1-259">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>DBSCAN Clustering</p> |
| <p><em>Note: This module is likely to change dramatically in the future and |
| should be treated as experimental.</em></p> |
| <p>Provides an implementaton of DBSCAN clustering. The model |
| also implements a <code>predict</code> function which uses nearest neighbours |
| to classify the points. To utilize this function you must use |
| <code>self.set_predictive(true)</code> before training the model.</p> |
| <p>The algorithm works by specifying <code>eps</code> and <code>min_points</code> parameters. |
| The <code>eps</code> parameter controls how close together points must be to be |
| placed in the same cluster. The <code>min_points</code> parameter controls how many |
| points must be within distance <code>eps</code> of eachother to be considered a cluster.</p> |
| <p>If a point is not within distance <code>eps</code> of a cluster it will be classified |
| as noise. This means that it will be set to <code>None</code> in the clusters <code>Vector</code>.</p> |
| <h2 id="examples"><a href="#examples">Examples</a></h2> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>rusty_machine::learning::dbscan::DBSCAN; |
| <span class="kw">use </span>rusty_machine::learning::UnSupModel; |
| <span class="kw">use </span>rusty_machine::linalg::Matrix; |
| |
| <span class="kw">let </span>inputs = Matrix::new(<span class="number">6</span>, <span class="number">2</span>, <span class="macro">vec!</span>[<span class="number">1.0</span>, <span class="number">2.0</span>, |
| <span class="number">1.1</span>, <span class="number">2.2</span>, |
| <span class="number">0.9</span>, <span class="number">1.9</span>, |
| <span class="number">1.0</span>, <span class="number">2.1</span>, |
| -<span class="number">2.0</span>, <span class="number">3.0</span>, |
| -<span class="number">2.2</span>, <span class="number">3.1</span>]); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>model = DBSCAN::new(<span class="number">0.5</span>, <span class="number">2</span>); |
| model.train(<span class="kw-2">&</span>inputs).unwrap(); |
| |
| <span class="kw">let </span>clustering = model.clusters().unwrap();</code></pre></div> |
| </div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.DBSCAN.html" title="rusty_machine::learning::dbscan::DBSCAN struct">DBSCAN</a></div><div class="item-right docblock-short">DBSCAN Model</div></div></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> |
