base

Documentation

Index

• Constants
• func GetTestdataFilePath(filename string) (string, error)
• type GolConf
  • func NewDefaultGolConf() *GolConf
  • func NewGolConf(overwrittenAttrs map[string]interface{}) *GolConf
  • func (gc *GolConf) ColLimitation() string
  • func (gc *GolConf) Generation() int
  • func (gc *GolConf) GridType() string
  • func (gc *GolConf) NeighborhoodType() int
  • func (gc *GolConf) RowLimitation() string
  • func (gc *GolConf) Rules() string
• type GolInterface

Constants

const DefaultColLimitation = "limited"

const DefaultGeneration = 0

const DefaultGridType = "dok"

const DefaultNeighborhoodType = neighborhood.MOORE

const DefaultRowLimitation = "limited"

const DefaultRules = "23/3"

Functions

func GetTestdataFilePath

func GetTestdataFilePath(filename string) (string, error)

GetTestdataFilePath : return the test data file path for the file name passed as argument.

Types

type GolConf

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

GolConf : configuration for Game of Life instances

func NewDefaultGolConf

func NewDefaultGolConf() *GolConf

NewDefaultGolConf : returns a default configuration for Game of Life instances

func NewGolConf

func NewGolConf(overwrittenAttrs map[string]interface{}) *GolConf

NewGolConf : returns a default configuration but overwritting the fields that are passed as a map

func (*GolConf) ColLimitation

func (gc *GolConf) ColLimitation() string

func (*GolConf) Generation

func (gc *GolConf) Generation() int

func (*GolConf) GridType

func (gc *GolConf) GridType() string

func (*GolConf) NeighborhoodType

func (gc *GolConf) NeighborhoodType() int

func (*GolConf) RowLimitation

func (gc *GolConf) RowLimitation() string

func (*GolConf) Rules

func (gc *GolConf) Rules() string

type GolInterface

type GolInterface interface {
	// Initializer of a Gol
	InitFromConf(name, description string, rows, cols int, gconf *GolConf)
	// Dummy-property methods
	Name() string
	Description() string
	// Row and cols related methods
	Rows() int
	Cols() int
	LimitRows() bool
	SetLimitRows(limitRows bool)
	LimitCols() bool
	SetLimitCols(limitCols bool)
	// Cloning
	Clone() GolInterface
	// Indexing methods
	Get(i int, j int) int
	Set(i int, j int, value int)
	SetAll(value int)
	// Rules methods
	Rules() string
	SetRules(rules string)
	// Debug methods
	DbgStdout()
	// Generation methods
	Generation() int
	SetGeneration(generation int)
	// Equality methods
	GridEquals(g GolInterface, mode string) bool
	Equals(g GolInterface) bool
	EqualsError(g GolInterface) error
	// NeighborhoodType-related methods
	NeighborhoodTypeString() string
	SetNeighborhoodType(neighborhoodType int)
	SetNeighborhoodTypeString(neighborhoodType string)
	// Concurrency-related methods
	Processes() int
	SetProcesses(processes int)
	ThreadPoolSize() int
	SetThreadPoolSize(threadPoolSize int)
	// Changes that can be applied at any moment
	// without calling nextGeneration
	ChangeCells(changes [][]int) GolInterface
	// FastForward a number of generations
	FastForward(generations int) GolInterface
	// Compute the next generation for a game of life instance
	NextGeneration() GolInterface
}

GolInterface : minimal Gol interface.