textanalysis

Documentation

Index

• type Any
• type Edge
• type EdgeList
• type Edges
• type Graph
• type Grapher
• type LinkedList
• type ListItem
• type Node
• type Nodes
• type Word
• type Words

Types

type Any

type Any interface{}

type Edge

type Edge interface {

	// Start returns the 'first' node of the edge.
	Start() Node

	// Start returns the 'second' node of the edge.
	End() Node

	// Forward returns the true if the edge is
	// connected in the forward direction.
	Forward() bool

	// Backward returns the true if the edge is
	// connected in the backward direction.
	Backward() bool
}

type EdgeList

type EdgeList []edge

type Edges

type Edges interface {
	First() Edge
}

type Graph

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

type Grapher

type Grapher interface {
	First() Node
	Nodes() []Node
	Edges() EdgeList
}

type LinkedList

type LinkedList interface {

	// First returns the 'first' element of the list.
	First() Node

	// Last returns the 'last' element of the list.
	Last() Node

	// Next returns the 'next' element of the list.
	// If there is no 'current' element, it returns
	// First()
	//
	// If Next() == nil, it returns First() if 'cyclical'
	// is true.
	Next() Node

	// Previous returns the 'previous' element of the list.
	Prev() Node

	// Cyclical returns true if the list is cyclical.
	Cyclical() bool
}

type ListItem

type ListItem interface {
	Node
	Next() Node
	Prev() Node
}

type Node

type Node interface {
	Data() Any      // returns the data contained in the Node
	Graph() Grapher // returns the graph that this node is a member of.

}

type Nodes

type Nodes []Node

type Word

type Word interface {
	Node
}

type Words

type Words map[string]Word

Words is a map of words in a text source. They keys are the actual word as presented in the text. The values are the corresponding structure of properties.