utils

Documentation

Overview

Package utils provides utilities for testing, benchmarking, and visualizing different algorithms.

Index

• func CompareAlgorithms(a, b func() algorithm.Algorithm)
• func DefaultAlgorithm(numPoints int, image image.Image) algorithm.Algorithm
• func GenerateAlgorithmOutput(outputFile string, algo algorithm.Algorithm, reps int)
• func GenerateProfile(outputFile string, algo algorithm.Algorithm, seconds int)
• func GenerateTrace(outputFile string, algo algorithm.Algorithm)
• func RunAlgorithm(algo algorithm.Algorithm, reps int)

Functions

func CompareAlgorithms

func CompareAlgorithms(a, b func() algorithm.Algorithm)

CompareAlgorithms compares the effectiveness of two algorithms.

func DefaultAlgorithm

func DefaultAlgorithm(numPoints int, image image.Image) algorithm.Algorithm

DefaultAlgorithm returns an algorithm than will be optimal for almost all cases

func GenerateAlgorithmOutput

func GenerateAlgorithmOutput(outputFile string, algo algorithm.Algorithm, reps int)

GenerateAlgorithmOutput runs an algorithm.Algorithm and writes the best point group to a file.

func GenerateProfile

func GenerateProfile(outputFile string, algo algorithm.Algorithm, seconds int)

GenerateProfile creates a CPU profile by running the algorithm.

func GenerateTrace

func GenerateTrace(outputFile string, algo algorithm.Algorithm)

GenerateTrace generates a trace of an algorithm, and is used for debugging and evaluating performance.

func RunAlgorithm

func RunAlgorithm(algo algorithm.Algorithm, reps int)

RunAlgorithm runs an algorithm.Algorithm and prints the fitness after a specified number of repetitions.