Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
vdelacruzb committed Apr 3, 2024
1 parent 3c1302d commit e4c86d7
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 0 deletions.
4 changes: 4 additions & 0 deletions clouds/bigquery/modules/doc/clustering/ST_CLUSTERKMEANS.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ Takes a set of points as input and partitions them into clusters using the k-mea
* `geog`: `ARRAY<GEOGRAPHY>` points to be clustered.
* `numberOfClusters`: `INT64`|`NULL` numberOfClusters that will be generated. If `NULL` the default value `Math.sqrt(<NUMBER OF POINTS>/2)` is used.

````hint:info
The resulting geometries are unique. So duplicated points will be removed from the input array
````

**Return type**

`ARRAY<STRUCT<cluster INT64, geom GEOGRAPHY>>`
Expand Down
4 changes: 4 additions & 0 deletions clouds/redshift/modules/doc/clustering/ST_CLUSTERKMEANS.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ Takes a set of points as input and partitions them into clusters using the k-mea
* `geog`: `GEOMETRY` points to be clustered.
* `numberOfClusters` (optional): `INT` number of clusters that will be generated. It defaults to the square root of half the number of points (`sqrt(<NUMBER OF POINTS>/2)`).

````hint:info
The resulting geometries are unique. So duplicated points will be removed from the input multipoint
````

**Return type**

`SUPER`: containing objects with `cluster` as the cluster id and `geom` as the geometry in GeoJSON format.
Expand Down
4 changes: 4 additions & 0 deletions clouds/snowflake/modules/doc/clustering/ST_CLUSTERKMEANS.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ Takes a set of points as input and partitions them into clusters using the k-mea
* `geojsons`: `ARRAY` points to be clustered.
* `numberOfClusters` (optional): `INT` numberOfClusters that will be generated. By default `numberOfClusters` is `Math.sqrt(<NUMBER OF POINTS>/2)`.

````hint:info
The resulting geometries are unique. So duplicated points will be removed from the input array
````

**Return type**

`ARRAY`: containing objects with `cluster`, as the cluster id, and `geom`, as the geometry geojson.
Expand Down

0 comments on commit e4c86d7

Please sign in to comment.