clusterer

Documentation

Overview

clusterer exposes basic iteration clustering functionality

Index

• type Cluster
• type ClusterFactory
• type Clusterable
• type Clusterer
  • func NewClusterer(criteria Criteria, ClusterF ClusterFactory, ClusterConstructor func(Cluster), ...) *Clusterer
  • func (c *Clusterer) Cluster(cs []Clusterable) error
  • func (c *Clusterer) GenerateClusters() error
  • func (c *Clusterer) ReEvaluateClusters() error
• type Criteria

Types

type Cluster

type Cluster interface {
	AddPoint(Clusterable) error
	RemovePoint(Clusterable)
	Points() []Clusterable
	CalculateCenter() interface{}
	SetCenter(interface{})
}

type ClusterFactory

type ClusterFactory func(func(Cluster)) Cluster

type Clusterable

type Clusterable interface {
	GetCluster() Cluster
	SetCluster(Cluster)
}

type Clusterer

type Clusterer struct {
	Clusters            []Cluster
	Clusterables        []Clusterable
	Criteria            Criteria
	ClusterF            ClusterFactory
	ClusterConstructor  func(Cluster)
	ReEvaluationCircles int
}

Clusterer struct

func NewClusterer

func NewClusterer(criteria Criteria, ClusterF ClusterFactory, ClusterConstructor func(Cluster), ReEvaluationCircles int) *Clusterer

NewClusterer creates a new Clusterer instance

func (*Clusterer) Cluster

func (c *Clusterer) Cluster(cs []Clusterable) error

Start clustering

func (*Clusterer) GenerateClusters

func (c *Clusterer) GenerateClusters() error

GenerateClusters forms clusters

func (*Clusterer) ReEvaluateClusters

func (c *Clusterer) ReEvaluateClusters() error

ReEvaluateClusters performs a re evaluation on the generated clusters

type Criteria

type Criteria func(Clusterable, Cluster) (bool, error)