graph

Documentation

Overview

Package graph contains code and logic for computing the [Markov cluster](https://micans.org/mcl/) from a graph of keywords with edges weighted by the similarity scores among them.

Index

• type ClusterGroup
• type Graph
  • func New(options ...Option) *Graph
  • func (g Graph) FindClusters(kd rankings.KeywordData) ([]ClusterGroup, error)
• type Option
  • func WithClusterInflation(i int) Option
  • func WithClusterMaxIterations(i int) Option
  • func WithClusterPower(p int) Option
  • func WithRBOPValue(p float64) Option

Types

type ClusterGroup

type ClusterGroup struct {
	Name     string
	Keywords []string
}

ClusterGroup is a cluster of highly-related keywords with respect to the similarity of their SERP members

type Graph

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

Graph builds a network of keywords and their relationship to other keywords with respect to the similarity of their SERPs

func New

func New(options ...Option) *Graph

New creates a new Graph configured by options

func (Graph) FindClusters

func (g Graph) FindClusters(kd rankings.KeywordData) ([]ClusterGroup, error)

FindClusters adds gathered SERP data to a graph, computes the RBO weights among all SERPs, and returns clusters of keywords whose SERP members are similar

type Option

type Option func(g *Graph)

Option configures a graph

func WithClusterInflation

func WithClusterInflation(i int) Option

WithClusterInflation configures the graph to use the specified inflation value to compute graph clusters

func WithClusterMaxIterations

func WithClusterMaxIterations(i int) Option

WithClusterMaxIterations configures the graph to limit the number of computation steps used when computing graph clusters

func WithClusterPower

func WithClusterPower(p int) Option

WithClusterPower configures the graph to use the specified power value to compute graph clusters

func WithRBOPValue

func WithRBOPValue(p float64) Option

WithRBOPValue configures the graph to use the specified RBO probability value