Class GameOfLife

java.lang.Object

GameOfLife

public class GameOfLife
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
GameOfLife()

Method Summary

Modifier and Type	Method and Description
static void	clearWorld(boolean[][] world) Sets all the cells in the world to not alive (false).
static boolean[][]	createNewWorld(int numRows, int numColumns) Create a new world
static void	initializeBeacon(boolean[][] world) Initializes the world to the Beacon pattern.
static void	initializeBoat(boolean[][] world) Initializes the world to the Boat pattern.
static void	initializeGlider(boolean[][] world) Initializes the world to the Glider pattern.
static void	initializeRandomWorld(boolean[][] world) Initialize the GameOfLife world with a random selection of cells alive.
static void	initializeRpentomino(boolean[][] world) Initializes the world to the R-pentomino pattern.
static boolean	isCellLivingInNextGeneration(int numLivingNeighbors, boolean cellCurrentlyLiving) Whether a cell is living in the next generation of the game.
static boolean	isNeighborAlive(boolean[][] world, int neighborCellRow, int neighborCellColumn) Whether a specific neighbor is alive.
static void	main(java.lang.String[] args) Program execution starts here.
static void	nextGeneration(boolean[][] currentWorld, boolean[][] newWorld) Creates the next generation of the world.
static int	numNeighborsAlive(boolean[][] world, int cellRow, int cellColumn) Counts the number of neighbors that are currently living around the specified cell.
static void	printWorld(java.lang.String patternName, boolean[][] world, int generationNum) Prints out the world showing each cell as alive or dead.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GameOfLife

public GameOfLife()

Method Detail

main

public static void main(java.lang.String[] args)

Program execution starts here.

Parameters:

args - UNUSED

createNewWorld

public static boolean[][] createNewWorld(int numRows,
                                         int numColumns)

Create a new world

Parameters:

numRows - The number of rows to be in the created world

numColumns - The number of columns to be in the created world

Returns:

A double dimension array of boolean that is numRows by numColumns in size and initialized to all false values.

clearWorld

public static void clearWorld(boolean[][] world)

Sets all the cells in the world to not alive (false).

Parameters:

world - the world to clear all cells

initializeGlider

public static void initializeGlider(boolean[][] world)

Initializes the world to the Glider pattern.

 ..........
 .@........
 ..@@......
 .@@.......
 ..........
 ..........
 ..........
 ..........
 ..........
 ..........
 

Parameters:

world - the existing double dimension array that will be reinitialized to the Glider pattern.

initializeBeacon

public static void initializeBeacon(boolean[][] world)

Initializes the world to the Beacon pattern.

 ..........
 .@@.......
 .@........
 ....@.....
 ...@@.....
 ..........
 ..........
 ..........
 ..........
 ..........
 

Parameters:

world - the existing double dimension array that will be reinitialized to the Beacon pattern.

initializeBoat

public static void initializeBoat(boolean[][] world)

Initializes the world to the Boat pattern.

 ..........
 .@@.......
 .@.@......
 ..@.......
 ..........
 ..........
 ..........
 ..........
 ..........
 ..........
 

Parameters:

world - the existing double dimension array that will be reinitialized to the Boat pattern.

initializeRpentomino

public static void initializeRpentomino(boolean[][] world)

Initializes the world to the R-pentomino pattern.

 ..........
 ..@@......
 .@@.......
 ..@.......
 ..........
 ..........
 ..........
 ..........
 ..........
 ..........
 

Parameters:

world - the existing double dimension array that will be reinitialized to the R-pentomino pattern.

initializeRandomWorld

public static void initializeRandomWorld(boolean[][] world)

Initialize the GameOfLife world with a random selection of cells alive.

Parameters:

world - the existing double dimension array that will be reinitialized to a Random pattern.

isCellLivingInNextGeneration

public static boolean isCellLivingInNextGeneration(int numLivingNeighbors,
                                                   boolean cellCurrentlyLiving)

Whether a cell is living in the next generation of the game. The rules of the game are as follows: 1) Any live cell with fewer than two live neighbors dies, as if caused by under-population. 2) Any live cell with two or three live neighbors lives on to the next generation. 3) Any live cell with more than three live neighbors dies, as if by overcrowding. 4) Any dead cell with exactly three live neighbors becomes a live cell, as if by reproduction.

Parameters:

numLivingNeighbors - The number of neighbors that are currently living.

cellCurrentlyLiving - Whether the cell is currently living.

Returns:

True if this cell is living in the next generation.

isNeighborAlive

public static boolean isNeighborAlive(boolean[][] world,
                                      int neighborCellRow,
                                      int neighborCellColumn)

Whether a specific neighbor is alive. Check whether the specific cell is alive or dead. Note that cellRow and cellColumn may not be valid. If the cellRow is less than 0 or greater than the number of rows -1 then the cell is outside the world. If the cellColumn is less than 0 or is greater than the number of columns -1 then the cell is outside the world. Return false for any cell outside the world.

Parameters:

world - The current world.

neighborCellRow - The row of the cell which we are wanting to know is alive.

neighborCellColumn - The column of the cell for which we are wanting to know is alive.

Returns:

Whether the cell is alive.

numNeighborsAlive

public static int numNeighborsAlive(boolean[][] world,
                                    int cellRow,
                                    int cellColumn)

Counts the number of neighbors that are currently living around the specified cell. A cell has eight neighbors. The neighbors are the cells that are horizontally, vertically and diagonally adjacent. Note that if a specific cell is on the edge of the world then it may not have neighboring cells. For example: for the 0'th row (top row) of the world there are not any rows above it. Assume all those cells are dead (have false values).

Parameters:

world - The current world.

cellRow - The row of the cell for which we are looking for neighbors.

cellColumn - The column of the cell for which we are looking for neighbors.

Returns:

The number of neighbor cells that are currently living.

nextGeneration

public static void nextGeneration(boolean[][] currentWorld,
                                  boolean[][] newWorld)

Creates the next generation of the world.

Parameters:

currentWorld - The world currently shown.

newWorld - The new world to determine by looking at each cells neighbors in the current world.

printWorld

public static void printWorld(java.lang.String patternName,
                              boolean[][] world,
                              int generationNum)

Prints out the world showing each cell as alive or dead. Loops through every cell of the world. If a cell is alive, print out the Config.ALIVE character, otherwise the Config.DEAD character. Tracks how many cells are alive and prints out the number of cells alive or that no cells are alive.

Parameters:

patternName - The name of the pattern chosen by the user.

world - The array representation of the current world.

generationNum - The number of the current generation.