Skip to content

Commit 43200f3

Browse files
author
Documenter.jl
committed
build based on a3768b6 
1 parent d63f413 commit 43200f3

16 files changed

+533
-519
lines changed

‎dev/.documenter-siteinfo.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2025-01-05T22:56:28","documenter_version":"1.8.0"}}
1+
{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2025-01-06T05:59:18","documenter_version":"1.8.0"}}

‎dev/affprop.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
<!DOCTYPE html>
22
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Affinity Propagation · Clustering.jl</title><meta name="title" content="Affinity Propagation · Clustering.jl"/><meta property="og:title" content="Affinity Propagation · Clustering.jl"/><meta property="twitter:title" content="Affinity Propagation · Clustering.jl"/><meta name="description" content="Documentation for Clustering.jl."/><meta property="og:description" content="Documentation for Clustering.jl."/><meta property="twitter:description" content="Documentation for Clustering.jl."/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="index.html"><img src="assets/logo.png" alt="Clustering.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="index.html">Clustering.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="index.html">Introduction</a></li><li><span class="tocitem">Algorithms</span><ul><li><a class="tocitem" href="algorithms.html">Basics</a></li><li><a class="tocitem" href="init.html">Initialization</a></li><li><a class="tocitem" href="kmeans.html">K-means</a></li><li><a class="tocitem" href="kmedoids.html">K-medoids</a></li><li><a class="tocitem" href="hclust.html">Hierarchical Clustering</a></li><li><a class="tocitem" href="mcl.html">MCL (Markov Cluster Algorithm)</a></li><li class="is-active"><a class="tocitem" href="affprop.html">Affinity Propagation</a></li><li><a class="tocitem" href="dbscan.html">DBSCAN</a></li><li><a class="tocitem" href="fuzzycmeans.html">Fuzzy C-means</a></li></ul></li><li><a class="tocitem" href="validate.html">Evaluation &amp; Validation</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Algorithms</a></li><li class="is-active"><a href="affprop.html">Affinity Propagation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="affprop.html">Affinity Propagation</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaStats/Clustering.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaStats/Clustering.jl/blob/master/docs/source/affprop.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Affinity-Propagation"><a class="docs-heading-anchor" href="#Affinity-Propagation">Affinity Propagation</a><a id="Affinity-Propagation-1"></a><a class="docs-heading-anchor-permalink" href="#Affinity-Propagation" title="Permalink"></a></h1><p><a href="http://en.wikipedia.org/wiki/Affinity_propagation">Affinity propagation</a> is a clustering algorithm based on <em>message passing</em> between data points. Similar to <a href="kmedoids.html#K-medoids">K-medoids</a>, it looks at the (dis)similarities in the data, picks one <em>exemplar</em> data point for each cluster, and assigns every point in the data set to the cluster with the closest <em>exemplar</em>.</p><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Clustering.affinityprop" href="#Clustering.affinityprop"><code>Clustering.affinityprop</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">affinityprop(S::AbstractMatrix; [maxiter=200], [tol=1e-6], [damp=0.5],
3-
[display=:none]) -&gt; AffinityPropResult</code></pre><p>Perform affinity propagation clustering based on a similarity matrix <code>S</code>.</p><p><span>$S_{ij}$</span> (<span>$i ≠ j$</span>) is the similarity (or the negated distance) between the <span>$i$</span>-th and <span>$j$</span>-th points, <span>$S_{ii}$</span> defines the <em>availability</em> of the <span>$i$</span>-th point as an <em>exemplar</em>.</p><p><strong>Arguments</strong></p><ul><li><code>damp::Real</code>: the dampening coefficient, <span>$0 ≤ \mathrm{damp} &lt; 1$</span>. Larger values indicate slower (and probably more stable) update. <span>$\mathrm{damp} = 0$</span> disables dampening.</li><li><code>maxiter</code>, <code>tol</code>, <code>display</code>: see <a href="algorithms.html#common_options">common options</a></li></ul><p><strong>References</strong></p><blockquote><p>Brendan J. Frey and Delbert Dueck. <em>Clustering by Passing Messages Between Data Points.</em> Science, vol 315, pages 972-976, 2007.</p></blockquote></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaStats/Clustering.jl/blob/24a30ae4d449b74c1c350648360170525c3313f4/src/affprop.jl#L35-L54">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Clustering.AffinityPropResult" href="#Clustering.AffinityPropResult"><code>Clustering.AffinityPropResult</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">AffinityPropResult &lt;: ClusteringResult</code></pre><p>The output of affinity propagation clustering (<a href="affprop.html#Clustering.affinityprop"><code>affinityprop</code></a>).</p><p><strong>Fields</strong></p><ul><li><code>exemplars::Vector{Int}</code>: indices of <em>exemplars</em> (cluster centers)</li><li><code>assignments::Vector{Int}</code>: cluster assignments for each data point</li><li><code>iterations::Int</code>: number of iterations executed</li><li><code>converged::Bool</code>: converged or not</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaStats/Clustering.jl/blob/24a30ae4d449b74c1c350648360170525c3313f4/src/affprop.jl#L11-L21">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="mcl.html">« MCL (Markov Cluster Algorithm)</a><a class="docs-footer-nextpage" href="dbscan.html">DBSCAN »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Sunday 5 January 2025 22:56">Sunday 5 January 2025</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
3+
[display=:none]) -&gt; AffinityPropResult</code></pre><p>Perform affinity propagation clustering based on a similarity matrix <code>S</code>.</p><p><span>$S_{ij}$</span> (<span>$i ≠ j$</span>) is the similarity (or the negated distance) between the <span>$i$</span>-th and <span>$j$</span>-th points, <span>$S_{ii}$</span> defines the <em>availability</em> of the <span>$i$</span>-th point as an <em>exemplar</em>.</p><p><strong>Arguments</strong></p><ul><li><code>damp::Real</code>: the dampening coefficient, <span>$0 ≤ \mathrm{damp} &lt; 1$</span>. Larger values indicate slower (and probably more stable) update. <span>$\mathrm{damp} = 0$</span> disables dampening.</li><li><code>maxiter</code>, <code>tol</code>, <code>display</code>: see <a href="algorithms.html#common_options">common options</a></li></ul><p><strong>References</strong></p><blockquote><p>Brendan J. Frey and Delbert Dueck. <em>Clustering by Passing Messages Between Data Points.</em> Science, vol 315, pages 972-976, 2007.</p></blockquote></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaStats/Clustering.jl/blob/a3768b6a8d78abb8fd513ce73a9f3fb8b21c3ff2/src/affprop.jl#L35-L54">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Clustering.AffinityPropResult" href="#Clustering.AffinityPropResult"><code>Clustering.AffinityPropResult</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">AffinityPropResult &lt;: ClusteringResult</code></pre><p>The output of affinity propagation clustering (<a href="affprop.html#Clustering.affinityprop"><code>affinityprop</code></a>).</p><p><strong>Fields</strong></p><ul><li><code>exemplars::Vector{Int}</code>: indices of <em>exemplars</em> (cluster centers)</li><li><code>assignments::Vector{Int}</code>: cluster assignments for each data point</li><li><code>iterations::Int</code>: number of iterations executed</li><li><code>converged::Bool</code>: converged or not</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaStats/Clustering.jl/blob/a3768b6a8d78abb8fd513ce73a9f3fb8b21c3ff2/src/affprop.jl#L11-L21">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="mcl.html">« MCL (Markov Cluster Algorithm)</a><a class="docs-footer-nextpage" href="dbscan.html">DBSCAN »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Monday 6 January 2025 05:59">Monday 6 January 2025</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)