util

Documentation

Overview

Copyright © 2021 Brian Longmore brianl.ext@gmail.com

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func BruteRunGame(gc GameConfig)
• func ClearAndDrawFrames(gc GameConfig, frameCells Cells)
• func GenBuildFile(bc BuildConfig) error
• func GetConfigListStrings(config GameConfig) (string, string)
• func GetLiveNeighborNumByCoord(bc BuildConfig, frameCells Cells, x, y int) int
• func IsCoordOutOfFrame(bc BuildConfig, x, y int) bool
• func RunBuildFile(rc RunConfig) error
• func RunFrames(gd GameData, rc RunConfig)
• func UpdateCells(bc BuildConfig, frameCells *Cells)
• type BuildConfig
• type Cell
  • func GetCellByCoord(bc BuildConfig, frameCells Cells, x, y int) Cell
  • func GetNewCell(bc BuildConfig, frameCells Cells, cell Cell) Cell
• type Cells
  • func GenCellsFromPattern(bc BuildConfig) Cells
• type Frame
• type Frames
  • func GenFramesFromPattern(bc BuildConfig) Frames
• type GameConfig
• type GameData
  • func GenGameDataFromBuildFile(rc RunConfig) (GameData, error)
• type Pattern
• type RunConfig

Functions

func BruteRunGame

func BruteRunGame(gc GameConfig)

BruteRunGame runs the game with in-time building.

func ClearAndDrawFrames

func ClearAndDrawFrames(gc GameConfig, frameCells Cells)

ClearAndDrawFrames updates the frame that is printed to the command line.

func GenBuildFile

func GenBuildFile(bc BuildConfig) error

GenBuildFile creates a build file from bc.If the destination file already exists, it will be overwritten.

func GetConfigListStrings

func GetConfigListStrings(config GameConfig) (string, string)

GetConfigListStrings returns both game and pattern config strings from config.

func GetLiveNeighborNumByCoord

func GetLiveNeighborNumByCoord(bc BuildConfig, frameCells Cells, x, y int) int

GetLiveNeighborNumByCoord returns the number of cells neighboring the cell at (x,y).

func IsCoordOutOfFrame

func IsCoordOutOfFrame(bc BuildConfig, x, y int) bool

IsCoordOutOfFrame returns whether or not the cell at (x,y) is out of the frame.

func RunBuildFile

func RunBuildFile(rc RunConfig) error

RunBuildFile runs a build file according to the parameters passed in rc.

func RunFrames

func RunFrames(gd GameData, rc RunConfig)

RunFrames runs the frames based on the passed game data and run config.

func UpdateCells

func UpdateCells(bc BuildConfig, frameCells *Cells)

UpdateCells updates the value of the pointer frameCells after evaluating the living states of its cells.

Types

type BuildConfig

type BuildConfig struct {
	BuildFilePath string
	Width         int
	Height        int
	FrameCount    int
	InitPattern   Pattern
}

type Cell

type Cell struct {
	X               int
	Y               int
	IsAlive         bool
	LiveNeighborNum int
}

func GetCellByCoord

func GetCellByCoord(bc BuildConfig, frameCells Cells, x, y int) Cell

GetCellByCoord returns the cell that is at (x,y).

func GetNewCell

func GetNewCell(bc BuildConfig, frameCells Cells, cell Cell) Cell

GetNewCell returns a new cell from the passed cell according to the life conditions.

type Cells

type Cells []Cell

func GenCellsFromPattern

func GenCellsFromPattern(bc BuildConfig) Cells

GenCellsFromPattern converts a pattern string to frame cells.

type Frame

type Frame struct {
	FrameNum int
	Cells
}

type Frames

type Frames []Frame

func GenFramesFromPattern

func GenFramesFromPattern(bc BuildConfig) Frames

GenFramesFromPattern generates and returns Frames according to the values passed in bc.

type GameConfig

type GameConfig struct {
	Width        int
	Height       int
	FrameCount   int
	InitPattern  Pattern
	Interval     time.Duration
	LiveCellChar string
	DeadCellChar string
}

type GameData

type GameData struct {
	BuildConfig
	Frames
}

func GenGameDataFromBuildFile

func GenGameDataFromBuildFile(rc RunConfig) (GameData, error)

GenGameDataFromBuildFile returns GameData that was stored in the targeted json build file.

type Pattern

type Pattern struct {
	FilePath string
	X        int
	Y        int
}

type RunConfig

type RunConfig struct {
	BuildFilePath string
	Interval      time.Duration
	LiveCellChar  string
	DeadCellChar  string
}