Clusters

Useful traits for clustering algorithms.

This library can be used as a basis for implementing a wide variety of 'distance' based clustering algorithms, such as DBSCAN.

Usage

The library is written entirely in Rust. To use it in your project, add the latest stable version of this crate to your Cargo.toml dependencies.

Cargo.toml

[dependencies]
clusters = "0.1"

In your project, import the library using the following code:

extern crate clusters;
use clusters::{Algorithm, Proximity}

Note that the above code makes the Algorithm and Proximity traits available for usage in the given scope, without needing the clusters:: qualification. For instance:

struct DBSCAN { ... }

impl Algorithm for DBSCAN {...}

Examples

TODO

Tests

TODO

Versioning

This project uses SemVer for versioning. For the versions available, see the releases tagged on this repository.

Authors

Primary: Alan K mailto:[email protected] @savish

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Contributing

Please see CONTRIBUTING.md for the process of contributing to this repo.