Struct ClusterInfo

pub struct ClusterInfo { /* private fields */ }

Information describing a cluster of points.

Implementations

impl ClusterInfo

pub fn id(&self) -> ClusterId

If this is a cluster (i.e. cluster() is true)

If this is not a cluster (i.e. cluster() is false), this references the positional index of data originall added via SuperclusterBuilder.

pub fn x(&self) -> f64

The longitude of the cluster

pub fn y(&self) -> f64

The latitude of the cluster

pub fn is_cluster(&self) -> bool

Whether this object represents a cluster of containing points or a single input point.

If true, references a cluster with containing data. Otherwise, is an original point that was added to the index.

pub fn count(&self) -> usize

The number of points contained in this cluster

This will always be 1 if is_cluster is false.

Trait Implementations

impl Clone for ClusterInfo

fn clone(&self) -> ClusterInfo

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClusterInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&ClusterInfo> for ClusterId

fn from(value: &ClusterInfo) -> Self

Converts to this type from the input type.

impl From<ClusterInfo> for ClusterId

fn from(value: ClusterInfo) -> Self

Converts to this type from the input type.