kmeans

Documentation

Overview

Package kmeans implements the k-means clustering algorithm See: https://en.wikipedia.org/wiki/K-means_clustering

Index

• type Kmeans
  • func New() Kmeans
  • func NewWithOptions(deltaThreshold float64, plotter Plotter) (Kmeans, error)
  • func (m Kmeans) Partition(dataset clusters.Observations, k int) (clusters.Clusters, error)
• type Plotter

Types

type Kmeans

type Kmeans struct {
	// contains filtered or unexported fields
}

Kmeans configuration/option struct

func New

func New() Kmeans

New returns a Kmeans configuration struct with default settings

func NewWithOptions

func NewWithOptions(deltaThreshold float64, plotter Plotter) (Kmeans, error)

NewWithOptions returns a Kmeans configuration struct with custom settings

func (Kmeans) Partition

func (m Kmeans) Partition(dataset clusters.Observations, k int) (clusters.Clusters, error)

Partition executes the k-means algorithm on the given dataset and partitions it into k clusters

type Plotter

type Plotter interface {
	Plot(cc clusters.Clusters, iteration int) error
}

The Plotter interface lets you implement your own plotters