api

Documentation

Index

• type IConfig
• type ILogger
• type INetwork
• type INeuron
• type IVisStimInput

Types

type IConfig

type IConfig interface {
	ErrLogFileName() string
	InfoLogFileName() string
	LogRoot() string

	ExitState() string
	SetExitState(string)

	DataRoot() string
	Save()
}

IConfig holds configuration and runtime properties.

type ILogger

type ILogger interface {
	LogError(string)
	LogInfo(string)
	Close()
}

ILogger is a general logging interface

type INetwork

type INetwork interface {

	// Load from either a previous simulation or start new.
	// Use IConfig to determine if we need to load a previous
	// construction or start new
	Load(IConfig)

	// Save the network's construction and configuration.
	Save()
}

INetwork represents the network of neurons under simulation.

type INeuron

type INeuron interface {

	// Integrate processes the current time tick.
	// This is considered the First pass.
	Integrate() float64

	// Next transfers the internal state to the output.
	// This is considered the Second pass.
	Next()

	// Load from either a previous simulation or start new.
	// Use IConfig to determine if we need to load a previous
	// construction or start new
	Load(IConfig)

	// Save the construction and configuration.
	Save()
}

INeuron represents a single neuron.

type IVisStimInput

type IVisStimInput interface {
	Configure(imageFile string) error

	SetSize(string)

	EnableExpand(bool)
	SetExpand(string)
	Expand(value int) string

	EnablePreCache(bool)

	SetStimulusAt(x, y int)
	SetStimulusFast(x, y int)

	GetStimulus() []int

	// Given an int returns a binary bit slice representation
	GetStimulusComp(value int) []int
}

IVisStimInput is stimulus from an image