Description

Faculty of Engineering and Natural Sciences
CS204 Advanced Programming

Homework 1 – Lost for Words

DISCLAIMER:
Your program should be a robust one such that you have to consider all relevant user mistakes and extreme cases; you are expected to take actions accordingly!

Only checking the sample run cases might not be sufficient as your solution will be checked against a variety of samples different than the provided samples; however checking these cases are highly encouraged and recommended.

Introduction

Inputs to Your Program
Your program should prompt for an input file name and read the file name from the standard input (cin). This file will have the characters of a matrix. The file could look like this:

matrix1.txt
If the input file cannot be successfully opened, your program should clear the error, ask the user for the file name again and try opening it repeatedly until the file is successfully opened.

While reading the file, you must store the matrix in a vector of vectors. Reading the matrix file more than once would clearly be a bad solution.

Your program will also read words, for which the existence will be checked within the provided matrix, from the standard input, which are further explained in the next section.

Format of the Inputs
Please notice that both input file and the words that your program will read will contain only upper-case letters. You can assume that this will be true for all of the test cases that we will be using. A second assumption that you can make is that there will be only alphabetic characters both in the file and in the word inputs, hence you do not need to do any extra check on this particular case as well. (The file will have newline and EOF characters for sure.)

In the data file containing the matrix of characters, the characters of the same row will not be separated by any character, meaning that they will appear consecutively one after another, and the rows will be separated by a newline ( ) character, as seen above in matrix1.txt. Also, there will not be any empty lines in the file. It is the safest approach to extract lines from the file with getline() function and feed the line strings to an istringstream object in order not to have any or characters at the end of the lines. You can then read characters from the istringstream object by forming a while loop on get() function defined in istringstream class.

The number of rows and the number of columns of the matrix can be any arbitrary numbers and you cannot make any assumptions on this (i.e., “It probably is a square matrix.”). Besides, in this file, it cannot be assumed that there are the same number of characters in each row. For the proper execution of the program and for the proper utilization of the vectors, there must be equal number of characters in each row. Your program should check this; give an appropriate error message and halt the execution of the program in case of any such inequalities. Other than this situation, you can assume that there cannot be any other format issues with the file and continue right on.

The words to be searched will be asked to the user through the standard input (cin). This process will continue until the user enters a word of length less than 3. You can assume that there will be only uppercase letters in the input, but no spaces, tabs or anything else.

For any further details, you can see the sample runs.

Task of Searching
This section clarifies the algorithm you need to develop.

After obtaining the required information from the file, your program will search for each word that it gets from the standard input, in the 2D vector that your program had constructed from the file. This search can be done vertically, horizontally or diagonally (anti-diagonal direction is not included for the search). It is also possible to go in the backward directions of these three as well.

The following illustration shows possible directions of search in the matrix:

Calculating the Score
Each word that your program can or cannot find in the matrix effects the score:

– For each word that cannot be found in the matrix, the score will be deducted by 5,
– Words that lay horizontally or vertically increase the score by their number of letters (i.e., the word ‘MONEY’ would contribute 5 points),
– Words that lay diagonally increase the score by their number of letters multiplied by two (i.e., the word ‘BIKE’ would contribute 8 points),
– Words that are longer than 5 characters contribute 2 extra points to the overall score.
– In case of the use of a joker, 2 points will be deducted from the score.
Please note that the total score is allowed to go below zero.

Outputs of Your Program
For each word to be searched, your program will display how they lay on the matrix and how many points they contributed to the score. After all the words are searched and their respective points are accumulated, your program will display the final score as the last output and terminate.

You can see the format of the outputs in the sample runs.

Sample Runs
Below, we provide some sample runs of the program that you will develop. The italic and bold phrases are the standard inputs (cin) taken from the user (i.e., like this ). You have to display the required information in the same order and with the same words as here.

Sample Run 1
—
Enter the matrix file name: data3 Invalid file name!
—
Enter the matrix file name: matrix3 Invalid file name!
—
Enter the matrix file name: matrix3.tx Invalid file name!
—
Enter the matrix file name: matrix3.txt
—
Enter a word: DOGS
DOGS is not found in the matrix. 5 points are deducted.
—
Enter a word: ATOM
ATOM is found in the column level. It contributes 4 points.
—
Enter a word: AS
—
Game has ended.
Total score of the words: -1

Sample Run 2
—
Enter the matrix file name: matrix1.txt
—
Enter a word: NOODLE
NOODLE is found in the diagonal level. It contributes 14 points.
—
Enter a word: VEGETABLE
VEGETABLE is not found in the matrix. 5 points are deducted.
—
Enter a word: SHEEP
SHEEP is found in the row level. It contributes 5 points.
—
Enter a word: STAY
STAY is found in the row level. It contributes 4 points.
—
Enter a word: ATOM
ATOM is found in the column level. It contributes 4 points.
—
Enter a word: PRIDE
PRIDE is not found in the matrix. 5 points are deducted.
—
Enter a word: APART
APART is found in the column level. It contributes 5 points.
—
Enter a word: HEAP
HEAP is not found in the matrix. 5 points are deducted.
—
Enter a word: TARGET
TARGET is not found in the matrix. 5 points are deducted.
—
Enter a word: PART
PART is found in the column level. It contributes 4 points.
—
Enter a word: CLOUD
CLOUD is found in the diagonal level. It contributes 10 points.
—
Enter a word: TABLE
TABLE is found in the row level. It contributes 5 points.
—
Enter a word: GEEK
GEEK is found in the diagonal level. One letter was replaced by joker. It contributes 6 points.
—
Enter a word: LET
LET is found in the diagonal level. One letter was replaced by joker. It contributes 4 points.
—
Enter a word: TRYTRUOAAP
TRYTRUOAAP is found in the row level. It contributes 12 points.
—
Enter a word: A
—
Game has ended.
Total score of the words: 53

Sample Run 3
—
Enter the matrix file name: matrix2.txt
The matrix does not have row equality, terminating…

Some Important Rules

How to get help?
YOU SHOULD USE GRADE CHECKER FOR THIS HOMEWORK!
You should use Grade Checker (http://sky.sabanciuniv.edu:8080/GradeChecker /) to check your expected grade. Just a reminder, you will see a character ¶ which refers to a newline in your expected output.

Make sure you upload the matrix1.txt , matrix2.txt and matrix3.txt files, too.

Common Errors Page: http://sky.sabanciuniv.edu:8080/GradeChecker/commonerrors.js p

You will have a demonstration on how to use Grade Checker and how to avoid these common errors during the first week’s lab. Please do attend.

Submit via SUCourse ONLY! Grade Checker is not considered as a submission. Paper, e-mail or any other methods are not acceptable, neither.

The internal clock of SUCourse might be a couple of minutes skewed, so make sure you do not leave the submission to the last minute. In the case of failing to submit your homework on time:
“No successful submission on SUCourse on time = A grade of 0 directly.”

What and where to submit (PLEASE READ, IMPORTANT)
You should prepare (or at least test) your program using MS Visual Studio 2012 C++. We will use the standard C++ compiler and libraries of the abovementioned platform while testing your homework.

It’d be a good idea to write your name and lastname in the program (as a comment line of course). Do not use any Turkish characters anywhere in your code (not even in comment parts). If your full name is “Duygu Karaoğlan Altop”, and if you want to write it as comment; then you must type it as follows:

// Duygu Karaoglan Altop

Submission guidelines are below. Since the grading process will be automatic, you are expected to strictly follow these guidelines. If you do not follow these guidelines, your grade will be zero. The lack of even one space character in the output will result in your grade being zero, so please test your programs yourself and with the Grade Checker tool explained above.
● Name your cpp file that contains your program as follows:

“SUCourseUserName_hw1.cpp”

Your SUCourse user name is actually your SUNet username which is used for checking sabanciuniv e-mails. Do NOT use any spaces, non-ASCII and Turkish characters in the file name. For example, if your SU e-mail address is atam@sabanciuniv.edu , then the file name must be: “atam_hw1.cpp”

● Please make sure that this file is the latest version of your homework program.

● You should upload matrix1.txt , matrix2.txt and matrix3.txt to SUCourse as well.

● Do not zip any of the documents but upload them as separate files only.

● Submit your work through SUCourse only! You can use the Grade Checker only to see if your program can produce the correct outputs both in the correct order and in the correct format. It will not be considered as the official submission. You must submit your work to SUCourse.

Good Luck!
Tolga Atam, Duygu Karaoğlan Altop