pathfinder

README

About

Pathfinder seeks to provide a simple interface to common graph search algorithms.

License

Copyright 2018 Anthony J. Mirabella

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Documentation

Overview

Package pathfinder seeks to provide a small set of useful pathfinding algorithms with a simple, easy-to-use interface.

Index

• type Edge
• type Finder
  • func NewFinder(g Graph) *Finder
  • func (f Finder) AStar(from, to Node) (Path, int, error)
  • func (f Finder) AStarFunc(from Node, to GoalFunc) (Path, int, error)
• type GoalFunc
• type Graph
• type Node
• type Path

Types

type Edge

type Edge struct {
	Target    Node
	Cost      int
	Heuristic int
}

Edge represents a connection from one Node to another.

type Finder

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

Finder holds a Graph and presents pathfinding operations on it.

func NewFinder

func NewFinder(g Graph) *Finder

NewFinder returns a new Finder wrapping your Graph

func (Finder) AStar

func (f Finder) AStar(from, to Node) (Path, int, error)

AStar uses the A* algorithm to find a shortest path between two Nodes. It returns a Path from the source to the destination, the cost of that path, and an error if it was unable to find a path.

func (Finder) AStarFunc

func (f Finder) AStarFunc(from Node, to GoalFunc) (Path, int, error)

AStarFunc can be used to find a shortest path to a node that satisfies a goal function. It returns a Path from the source to the destination, the cost of that path, and an error if it was unable to find a path.

type GoalFunc

type GoalFunc func(Node) bool

GoalFunc represents a search predicate

type Graph

type Graph interface {
	Neighbors(Node) []Edge
}

Graph represents a set of connected nodes.

type Node

type Node interface{}

Node represents a node in the graph that can be traversed. It is important that types that implement the Node interface are comparable. They may be used as map keys.

type Path

type Path []Node

Path represents a path between two Nodes.