algorithm

Documentation

Index

• Variables
• func List() map[string]MatchAlgorithm
• func Register(algorithm MatchAlgorithm)
• type MatchAlgorithm
  • func Get(name string) (MatchAlgorithm, error)
  • func GetOrFail(name string) MatchAlgorithm

Variables

var (
	MatchAlgorithms map[string]MatchAlgorithm
)

Lookup of Algorthms

Functions

func List

func List() map[string]MatchAlgorithm

List returns known algorithms

func Register

func Register(algorithm MatchAlgorithm)

Register a new backend by name

Types

type MatchAlgorithm

type MatchAlgorithm interface {
	Name() string
	Description() string
	Init(map[string]string) error

	// A MatchAlgorithm needs to take a slot and determine if it matches
	CheckSubsystemEdge(slotNeeds *types.MatchAlgorithmNeeds, edge *types.Edge)

	// Graph backends that support cypher need a cypher query for the algorithm
	GenerateCypher(matchNeeds *types.MatchAlgorithmNeeds) string
}

A SelectionAlgorithm is used by the rainbow scheduler to make a final decision about assigning work to a group of clusters.

func Get

func Get(name string) (MatchAlgorithm, error)

Get a backend by name

func GetOrFail

func GetOrFail(name string) MatchAlgorithm

GetOrFail ensures we can find the entry