CSC108 Assignment 1: The Slide Game In Assignment 1, you write Python code that will be used by a game called The Slide Game. You can complete the whole assignment with only the concepts from Weeks 1, 2, and 3 of the course. This handout explains the problem being solved, and the tasks to complete, for the assignment. Please read it carefully and in its entirety. Updates 2020-01-25: There is a minor bug in slide_game.py when determining if a player wins in one of the diagonal directions. You do not need to do anything and can ignore this bug. But, if you'd like to fix the bug and you've already started the assignment, you can download this slide game.py and use it to replace the one from the starter files below. Logistics Due Date: Thursday, February 4th at 5 pm (Toronto Time) Submission: You will submit your assignment solution on Markus. Late Policy: There are penalties for submitting the assignment after the due date. These penalties depend on how many hours late your submission is. Please see the syllabus on Quercus for more information. No Remark Requests: No remark requests will be accepted. A syntax error could result in a grade of o on the assignment. Before the deadline, you are responsible for running your code and the checker program to identify and resolve any errors that will prevent our tests from running. The best way to check for this is to run the tests on MarkUs via the Automated Testing tab for this assignment. The work you submit must be your own. Please review The Code of Behaviour on Academic Matters and information for students from the Office of Student Academic Integrity. Goals of this assignment The main goal of this assignment is that students will use the Function Design Recipe to plan, document, implement, and test functions. This entails the following sub-goals: Students will describe what a function does appropriately using docstrings. Students will show how to use a function appropriately with docstring examples. Students will write function bodies using variables, numeric types, strings, and conditional statements. Students will learn to use: Python 3, Wing 101, the provided starter code, a checker module, and other tools. The Slide Game The Slide Game is a two player game played on a two-dimensional game board. The game board has a number of rows and columns specified at the beginning of the game and starts off filled with black squares. The following image is an example of a game board with 4 rows and 5 columns: 1 2 3 3 4 5 1 2 3 4 Each player has an infinite number of squares in one colour (e.g., one player has red squares; the other player has yellow squares). There are two moves that a player can make to get their squares onto the game board: 1. Slide Right 2. Slide Left The first player to place NUM_MATCH of their squares in a straight line wins the game. Here, NUM_MATCH is a number like 3. The straight line can be a horizontal, vertical, or diagonal line of squares on the game board. Slide Right The Slide Right move allows a player to slide one of their squares onto the game board. The player must indicate which row they would like to slide their square onto. Because the size of the game board is fixed, the right-most square in the game board will fall off" to make room for the player's own square. Slide Right Slide Left The "Slide Left" move allows a player to slide one of their squares onto the game board. The player must indicate which row they would like to slide their square onto. Because the size of the game board is fixed, the left-most square in the game board will fall off" to make room for the player's own square. Slide Left Winning the game The objective of the game is to be the first player to connect NUM_MATCH Squares in a row either horizontally (or simply across), vertically (or simply "down"), or diagonally. Diagonal lines come in two orientations: downward to the right and downdward to the left. Assuming NUM_MATCH is 3, here are some examples of where squares should be placed in order to win the game: The Slide Game in Python In this assignment, you will be writing Python code for the Slide Game. Instead of using colourful pictures of squares on a game board (as we saw in the last section), in our Python code we will use text to represent the squares (i.e., Python's str type). In the rest of this section, we provide some details to help you understand how to approach the code you need to write. Starter Code For this assignment, we are giving you some files to help you get started. Please download the Assignment 1 Files and extract the zip archive. In total, we have provided you with three Python files: slide_functions.py This is the file where you will write your solution. Your job is to complete the file by implementing all the required functions. See the What to do section for more details. slide_game.py This is the main program that we have implemented for you. You will not modify this file. But you can run this file to play The Slide Game. Note that this won't be possible until you have correctly completed the functions in slide_functions.py. a1_checker.py This is a checker program that you should use to check your code. You will not modify this file. See below for more information about ai_checker.py. Constants Constants are special variables whose values should not change once assigned - you saw constants in the Week 2 Prepare module. A different naming convention (uppercase pothole) is used for constants, so that programmers know to not change their values. For example, in the starter code, the constant SQUARE_BLACK is assigned the value '-' at the beginning of the module and the value of SQUARE_BLACK should never change in your code. When writing your code, if you need to use a black square, you should use SQUARE_BLACK. The same applies for the other constant values. Using constants simplifies code modifications and improves readability and changeability. For example, if we later decide to use a different character to represent a black square, we would only have to make a change in one place (the SQUARE_BLACK assignment statement), rather than throughout the program. This also makes our code more readable whether we use '-' or any other character to represent a black square, we write our code using the constant SQUARE_BLACK so it is clear to the reader what we mean. Representing the game board A game board can be thought of as a table with rows (see the constant NUM_ROW) and columns (NUM_COL). The size of a game board does not change during the course of a game. For example, here is an empty game board with 4 rows and 5 columns: 1 2 3 3 4 5 1 2 1 1 | 1 1 |-|-|- |-|-|-|- 3 3 - 4 - A location in the game board can be described by indicating the row and then the column. For example, using the empty game board above, (1, 1) indicates the location at the top-left of the game board. And (4, 5) indicates the bottom-right of the game board. We will use strings (i.e., the str type) to represent the squares on a game board. The black squares will be: '-' (SQUARE_BLACK). The red squares will be: 'R' (SQUARE_RED). The yellow squares will be: 'Y' (SQUARE_YELLOW). We have not yet studied how to store 2-dimensional information in Python programs, so we will need a different way to represent our game board. The approach that we will take for this assignment is to store the rows one after another, starting with the first row. Using our empty (all black squares) game board example, this is: -'. Using a slightly more interesting example: 2 st 1 2 1 2 3 4 5 RI | | | | TY RI |-|- Y|- |-|-|- - 3 3 R 4 Would be represented as 'R--------YR--------'. Accessing a square in the game board We have used row and column indices to describe the position of each square in the grid representation of a game board. But each character in a Python str is in a position that is described by a single index. How is the Python program going to translate between row and column indices and str indices? To answer this question, we will have to determine a formula! Consider the following concrete example: 3 st 5 1 2 2 3 1 2 3 4 5 A|B|C| D | E F|G|H|I|J K||M|N|O P Q R S T 4 Which, as a string, is: 'ABCDEFGHIJKLMNOPQRST'. Let us use the table below to derive a formula that calculates the index based on: the location (i.e., row and column) and game board size (i.e., NUM_ROW and/or NUM_COL). location index character (1,1) 0 A (1,2) 1 B (1,3) 2 (1,4) 3 D (1,5) 4. E (2,1) 5 F (2, 2) 6 G (2,3) 7 H (2,4) 8 I (2,5) 9 J (3,1) 10 K (3,2) 11 L From the table above, we see that the character in the square with position (2,1) (i.e., the square at row 2 and column 1) has index 5. The other squares in that row have indices 6, 7, 8 and 9. We conclude that when moving one square across a row, the index increases by 1. The squares in column 3 have indices 2, 7, 12 and 17. Moving one square down a column increases the index by 5, the number of columns of the game board. We conclude that when moving one square down a column, the index increases by the game board's number of columns. Let us now introduce variables that will allow us to express the formula explicitly. Let a variable named str_index refer to the position of a square in the str representation of a game board with size NUM_ROW rows and NUM_COL columns. Let variables row and col refer to the position of the same square in the grid representation of a game board. From what we have seen, we can conclude that str_index depends on row, col, and NUM_COL. That is, the following formula will compute str_index: (row - 1) NUM_COL + (col - 1) The minus is are needed for the arithmetic to work out. This is because we chose to index our rows and columns starting at 1 (as a thought exercise, what would the formula be if we chose to index the rows and columns starting at 0?). What to do At a high-level, your next steps are to: 1. Open the file slide_functions.py. 2. Make sure that the file is in the same directory as slide_game.py, a1_checker.py, and pyta. 3. Complete the function definitions below. Make sure to follow the Function Design Recipe that you have been learning in this course. 4. Test your Python file by using the Python shell and al_checker.py (see below). We have included the type contracts and a specification of every function below; please read through them carefully. We will be evaluating your docstrings in addition to your code; include two examples in your docstrings. You will need to paraphrase the specifications of the functions to get an appropriate docstring description. Make sure you review the CSC108 Python Style Guidelines for the rules on how to write a doestring description. The functions listed below do not need to be completed in order if you get stuck on one, try another! 1. Function: create_empty_board() -> str Specification: This function has no parameters. This function returns a string for storing information about a game board that has NUM_ROW rows and NUM_COL columns. Each character in the returned string is to have been set to the SQUARE_BLACK character. Notes: o We have completed this function for you. You do not need to include docstring examples for this function. 2. Function: is_board_full (str) -> bool Specification: This function has one parameter that refers to a valid game board. This function returns True if and only if all of the squares in the game board are not black. That is, True is returned if and only if there are no SQUARE_BLACK characters in the game board. Notes: We have partially completed this function for you. o You must complete the function body yourself. You do not need to add any more docstring examples for this function. 3. Function: between(str, int, int) -> bool Specification: This function has three parameters. The first parameter refers to a str value, the second to the minimum value for a range of values, and the third to the maximum value for a range of values. Assume that the str value can be converted to an integer. Assume that the value of the second parameter is less than or equal to the value of the third parameter. This function returns True if and only if the converted integer value of the first parameter is not less than the second parameter and not more than the third parameter. In other words, True is returned if and only if the first parameter is between the second and third parameters, or equal to one or both of them. Notes: We have partially completed this function for you. You must complete the function body yourself. You do not need to add any more docstring examples for this function. o 4. Function: calculate_str_index(int, int) -> int Specification: This function has two parameters. The first and second parameters refer to the row and column, respectively, of a location in a valid game board whose size is given by constants NUM_ROW and NUM_COL. Assume that each parameter refers to a valid value. This function returns the index in the string representation of the game board corresponding to the given row and column location. Notes: o Follow the Function Design Recipe to complete this function. Re-read the Accessing a square in the game board if you are stuck. We have given you the formula. 5. Function: calculate_increment(str) -> int Specification: This function has one parameter. The parameter refers to a string that describes one of the four directions: down, across, down-right, or down-left. Assume that the str value is one of: DIR_DOWN, DIR_ACROSS, DIR_DOWN_RIGHT, or DIR_DOWN_LEFT. The game board size is given by the constants NUM_ROW and NUM_COL. This function returns the difference between the str indices of two adjacent squares on a line that goes in the direction specified by the first parameter. Notes: Follow the Function Design Recipe to complete this function. Re-read the Winning the game section to better understand the four different directions. Re-read the Accessing a square in the game board section if you are stuck. 6. Function: get_row(int, str) -> str Specification: This function takes two parameters. The first parameter is a row number and the second parameter is the string representation of a game board. Assume that the row number and game board are valid. The game board size is given by the constants NUM_ROW and NUM_COL. This function returns only the characters in the game board found at the given row in the same left-to-right order as they appear in the row. Notes: o Follow the Function Design Recipe to complete this functions. Review the str: indexing and slicing" material in the PCRS Week 3 Prepare module. Re-read the Accessing a square in the game board if you are stuck. Review the Function Reuse material in the PCRS Week 2 Prepare module. Consider using your calculate_increment and calculate_str_index functions to help. 7. Function: get_column(int, str) -> str Specification: This function takes two parameters. The first parameter is a column number and the second parameter is the string representation of a game board. Assume that the column number and game board are valid. The game board size is given by the constants NUM_ROW and NUM_COL. This function returns only the characters in the game board found at the given column in the same top-to-bottom order as they appear in the column. Notes: 0 Follow the Function Design Recipe to complete this functions. Review the str: indexing and slicing material in the PCRS Week 3 Prepare module. Re-read the Accessing a square in the game board section if you are stuck. Review the Function Reuse material in the PCRS Week 2 Prepare module. Consider using your calculate_increment and calculate_str_index functions to help. 8. slide_right(str, int, str) -> str Specification: This function takes three parameters. The first parameter is the square being added to the game board. The second parameter is a row number and the third parameter is the string representation of a game board. Assume that the square, row number, and game board are valid. This function returns a string that is like the original game board, except that: the square from the first parameter has been slid into the beginning" (i.e., first column) of the given row number; the square at the "end" (i.e., last column) has slid off the game board; o the remaining squares have slid to the right. Notes: Follow the Function Design Recipe to complete this functions. Review the str: indexing and slicing material in the PCRS Week 3 Prepare module. Re-read the Slide right section if you are stuck. Review the Function Reuse material in the PCRS Week 2 Prepare module. Consider using your calculate_str_index function to help. 9. slide_left(str, int, str) -> str Specification: This function takes three parameters. The first parameter is the square being added to the game board. The second parameter is a row and the third parameter is the string representation of a game board. Assume that the square, row number, and game board are valid. This function returns a string that is like the original game board, except that: o the square from the first parameter has been slid into the "end" (i.e., last column) of the given row number; the square at the beginning" (i.e., first column) has slid off the game board; o the remaining squares have slid to the left. Notes: Follow the Function Design Recipe to complete this functions. Review the str: indexing and slicing material in the PCRS Week 3 Prepare module. Re-read the Slide left section if you are stuck. Review the "Function Reuse" material in the PCRS Week 2 Prepare module. Consider using your calculate_str_index function to help