Skip to content

Commit 9b112d9

Browse files
docs: Update docs (#1532)
1 parent 609d256 commit 9b112d9

File tree

20 files changed

+2734
-2734
lines changed

20 files changed

+2734
-2734
lines changed

library/com.google.maps.android.clustering.algo/-abstract-algorithm/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@
108108
<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>
109109
<div class="cover ">
110110
<h1 class="cover"><span>Abstract</span><wbr></wbr><span><span>Algorithm</span></span></h1>
111-
<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="../-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="../-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="../-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>
111+
<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="../-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="../-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="../-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>
112112
</div>
113113
<div class="tabbedcontent">
114114
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>

library/com.google.maps.android.clustering.algo/-algorithm/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@
108108
<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>
109109
<div class="cover ">
110110
<h1 class="cover"><span><span>Algorithm</span></span></h1>
111-
<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>
111+
<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>
112112
</div>
113113
<div class="tabbedcontent">
114114
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>

library/com.google.maps.android.clustering.algo/-non-hierarchical-distance-based-algorithm/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@
108108
<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>
109109
<div class="cover ">
110110
<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>
111-
<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>
111+
<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>
112112
</div>
113113
<div class="tabbedcontent">
114114
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>

library/com.google.maps.android.clustering.algo/-screen-based-algorithm/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@
108108
<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">ScreenBasedAlgorithm</span></div>
109109
<div class="cover ">
110110
<h1 class="cover"><span>Screen</span><wbr></wbr><span>Based</span><wbr></wbr><span><span>Algorithm</span></span></h1>
111-
<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">ScreenBasedAlgorithm</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">This abstract interface provides two methods: one to determine if the map should recluster when the map moves (<a href="should-recluster-on-map-movement.html">shouldReclusterOnMapMovement</a>), and another method to determine the behavior when the camera moves (<a href="on-camera-change.html">onCameraChange</a> ()})</p><h4 class="">Parameters</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><u><span><span>&lt;T&gt;</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The <a href="../../com.google.maps.android.clustering/-cluster-item/index.html">ClusterItem</a> type</p></div></div></div></div></div><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="../-non-hierarchical-view-based-algorithm/index.html">NonHierarchicalViewBasedAlgorithm</a></div></span></div><div></div></div></div></div></div></div>
111+
<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">ScreenBasedAlgorithm</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">This abstract interface provides two methods: one to determine if the map should recluster when the map moves (<a href="should-recluster-on-map-movement.html">shouldReclusterOnMapMovement</a>), and another method to determine the behavior when the camera moves (<a href="on-camera-change.html">onCameraChange</a> ()})</p><h4 class="">Parameters</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><u><span><span>&lt;T&gt;</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The <a href="../../com.google.maps.android.clustering/-cluster-item/index.html">ClusterItem</a> type</p></div></div></div></div></div><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="../-screen-based-algorithm-adapter/index.html">ScreenBasedAlgorithmAdapter</a></div></span></div><div></div></div></div></div></div></div>
112112
</div>
113113
<div class="tabbedcontent">
114114
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>

0 commit comments

Comments
 (0)