Skip to content

docs: Update docs #1560

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@
<div class="breadcrumbs"><a href="../../../index.html">library</a><span class="delimiter">/</span><a href="../index.html">com.google.maps.android.clustering.algo</a><span class="delimiter">/</span><span class="current">AbstractAlgorithm</span></div>
<div class="cover ">
<h1 class="cover"><span>Abstract</span><wbr></wbr><span><span>Algorithm</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">class </span><a href="index.html">AbstractAlgorithm</a><span class="token operator">&lt;</span><a href="index.html">T</a><span class="token operator"> : </span><a href="../../com.google.maps.android.clustering/-cluster-item/index.html">ClusterItem</a><span class="token operator">?</span><span class="token operator">&gt;</span> : <a href="../-algorithm/index.html">Algorithm</a><span class="token operator">&lt;</span><a href="../-algorithm/index.html">T</a><span class="token operator">&gt; </span></div><p class="paragraph">Base Algorithm class that implements lock/unlock functionality.</p><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-screen-based-algorithm-adapter/index.html">ScreenBasedAlgorithmAdapter</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-grid-based-algorithm/index.html">GridBasedAlgorithm</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-non-hierarchical-distance-based-algorithm/index.html">NonHierarchicalDistanceBasedAlgorithm</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-pre-caching-algorithm-decorator/index.html">PreCachingAlgorithmDecorator</a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">class </span><a href="index.html">AbstractAlgorithm</a><span class="token operator">&lt;</span><a href="index.html">T</a><span class="token operator"> : </span><a href="../../com.google.maps.android.clustering/-cluster-item/index.html">ClusterItem</a><span class="token operator">?</span><span class="token operator">&gt;</span> : <a href="../-algorithm/index.html">Algorithm</a><span class="token operator">&lt;</span><a href="../-algorithm/index.html">T</a><span class="token operator">&gt; </span></div><p class="paragraph">Base Algorithm class that implements lock/unlock functionality.</p><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-pre-caching-algorithm-decorator/index.html">PreCachingAlgorithmDecorator</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-grid-based-algorithm/index.html">GridBasedAlgorithm</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-non-hierarchical-distance-based-algorithm/index.html">NonHierarchicalDistanceBasedAlgorithm</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-screen-based-algorithm-adapter/index.html">ScreenBasedAlgorithmAdapter</a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@
<div class="breadcrumbs"><a href="../../../index.html">library</a><span class="delimiter">/</span><a href="../index.html">com.google.maps.android.clustering.algo</a><span class="delimiter">/</span><span class="current">Algorithm</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Algorithm</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">interface </span><a href="index.html">Algorithm</a><span class="token operator">&lt;</span><a href="index.html">T</a><span class="token operator"> : </span><a href="../../com.google.maps.android.clustering/-cluster-item/index.html">ClusterItem</a><span class="token operator">?</span><span class="token operator">&gt;</span></div><p class="paragraph">Logic for computing clusters</p><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-abstract-algorithm/index.html">AbstractAlgorithm</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-screen-based-algorithm/index.html">ScreenBasedAlgorithm</a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">interface </span><a href="index.html">Algorithm</a><span class="token operator">&lt;</span><a href="index.html">T</a><span class="token operator"> : </span><a href="../../com.google.maps.android.clustering/-cluster-item/index.html">ClusterItem</a><span class="token operator">?</span><span class="token operator">&gt;</span></div><p class="paragraph">Logic for computing clusters</p><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-screen-based-algorithm/index.html">ScreenBasedAlgorithm</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-abstract-algorithm/index.html">AbstractAlgorithm</a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@
<div class="breadcrumbs"><a href="../../../index.html">library</a><span class="delimiter">/</span><a href="../index.html">com.google.maps.android.clustering.algo</a><span class="delimiter">/</span><span class="current">NonHierarchicalDistanceBasedAlgorithm</span></div>
<div class="cover ">
<h1 class="cover"><span>Non</span><wbr></wbr><span>Hierarchical</span><wbr></wbr><span>Distance</span><wbr></wbr><span>Based</span><wbr></wbr><span><span>Algorithm</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">class </span><a href="index.html">NonHierarchicalDistanceBasedAlgorithm</a><span class="token operator">&lt;</span><a href="index.html">T</a><span class="token operator"> : </span><a href="../../com.google.maps.android.clustering/-cluster-item/index.html">ClusterItem</a><span class="token operator">?</span><span class="token operator">&gt;</span> : <a href="../-abstract-algorithm/index.html">AbstractAlgorithm</a><span class="token operator">&lt;</span><a href="../-abstract-algorithm/index.html">T</a><span class="token operator">&gt; </span></div><p class="paragraph">A simple clustering algorithm with O(nlog n) performance. Resulting clusters are not hierarchical. </p><p class="paragraph"> High level algorithm: 1. Iterate over items in the order they were added (candidate clusters). 2. Create a cluster with the center of the item. 3. Add all items that are within a certain distance to the cluster. 4. Move any items out of an existing cluster if they are closer to another cluster. 5. Remove those items from the list of candidate clusters. </p><p class="paragraph"> Clusters have the center of the first element (not the centroid of the items within it).</p><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-non-hierarchical-view-based-algorithm/index.html">NonHierarchicalViewBasedAlgorithm</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-centroid-non-hierarchical-distance-based-algorithm/index.html">CentroidNonHierarchicalDistanceBasedAlgorithm</a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">class </span><a href="index.html">NonHierarchicalDistanceBasedAlgorithm</a><span class="token operator">&lt;</span><a href="index.html">T</a><span class="token operator"> : </span><a href="../../com.google.maps.android.clustering/-cluster-item/index.html">ClusterItem</a><span class="token operator">?</span><span class="token operator">&gt;</span> : <a href="../-abstract-algorithm/index.html">AbstractAlgorithm</a><span class="token operator">&lt;</span><a href="../-abstract-algorithm/index.html">T</a><span class="token operator">&gt; </span></div><p class="paragraph">A simple clustering algorithm with O(nlog n) performance. Resulting clusters are not hierarchical. </p><p class="paragraph"> High level algorithm: 1. Iterate over items in the order they were added (candidate clusters). 2. Create a cluster with the center of the item. 3. Add all items that are within a certain distance to the cluster. 4. Move any items out of an existing cluster if they are closer to another cluster. 5. Remove those items from the list of candidate clusters. </p><p class="paragraph"> Clusters have the center of the first element (not the centroid of the items within it).</p><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-centroid-non-hierarchical-distance-based-algorithm/index.html">CentroidNonHierarchicalDistanceBasedAlgorithm</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-non-hierarchical-view-based-algorithm/index.html">NonHierarchicalViewBasedAlgorithm</a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@
<div class="breadcrumbs"><a href="../../../index.html">library</a><span class="delimiter">/</span><a href="../index.html">com.google.maps.android.clustering.view</a><span class="delimiter">/</span><span class="current">ClusterRenderer</span></div>
<div class="cover ">
<h1 class="cover"><span>Cluster</span><wbr></wbr><span><span>Renderer</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">interface </span><a href="index.html">ClusterRenderer</a><span class="token operator">&lt;</span><a href="index.html">T</a><span class="token operator"> : </span><a href="../../com.google.maps.android.clustering/-cluster-item/index.html">ClusterItem</a><span class="token operator">?</span><span class="token operator">&gt;</span></div><p class="paragraph">Renders clusters.</p><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-default-advanced-markers-cluster-renderer/index.html">DefaultAdvancedMarkersClusterRenderer</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-default-cluster-renderer/index.html">DefaultClusterRenderer</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-cluster-renderer-multiple-items/index.html">ClusterRendererMultipleItems</a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">interface </span><a href="index.html">ClusterRenderer</a><span class="token operator">&lt;</span><a href="index.html">T</a><span class="token operator"> : </span><a href="../../com.google.maps.android.clustering/-cluster-item/index.html">ClusterItem</a><span class="token operator">?</span><span class="token operator">&gt;</span></div><p class="paragraph">Renders clusters.</p><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-cluster-renderer-multiple-items/index.html">ClusterRendererMultipleItems</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-default-advanced-markers-cluster-renderer/index.html">DefaultAdvancedMarkersClusterRenderer</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":library:dokkaHtml/release" data-filterable-set=":library:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-default-cluster-renderer/index.html">DefaultClusterRenderer</a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
Expand Down
Loading