# A11-Keeping Lists

## Objectives

• Code vectors to store data.
• Implement common vector algorithms.
• Write functions to manipulate vectors.
• Explore code reuse with classes
• Write member functions for classes that read data from the console.
• Write member functions for classes that write data to the console.
• Code vectors to work with objects

Read the Scholastic Honesty Policy and Assignment Integrity policies of the syllabus. Here are some clarifications for this particular assignment:

• You are encouraged to work with one other student of this class following the rules of Pair Programming for Homework Assignments. If you choose to pair program, there is a bonus applied.
• You may not give a copy of your code to your designated pair-programming partner if you did not develop the code together.
• You may not look at another person's code until you complete and submit this assignment, except for code you develop code together with your pair-programming partner.
• You may get help from people other than your pair-programming partner if you get stuck, but only if they do not show or tell you the code to type.

## Preparation

1. Make sure you have completed the exercises from lesson 10 and lesson 11.
2. Complete the Review Exercises in CodeLab 10 and 11. These exercises will help prepare you for the problem-solving programs and should be completed first.

## Project Specifications

Your solutions to these projects must use only techniques we have covered so far.

#### Programming Style

For all programs, remember to follow all the style rules we have covered, as well as the newer rules, including:

1. Class naming conventions (See: Class Names)
2. Indentation in classes and placement of curly braces
3. Every function declaration (prototype) in the class, including constructor functions, have a function comment block
4. Every file has a file comment block
5. No magic numbers (See: No Magic Numbers)

#### Project 1: Vector Function Worksheet

Vectors are a convenient way to store and process a list of data. They work much like arrays but can grow and shrink to accommodate the number of elements needed.

Use this worksheet to improve your understanding of vectors and functions. Refer to lesson 10 for more information on vectors.

##### Project Specifications

Keep the same filename and add to the existing code to complete the project. Leave the existing code unchanged, except for comments as instructed.

2. Add your name and the date to the file comment block at the top of the file, replacing the words Your Name with your first and last name and Date Here with the current date.
3. No user input is required for this project and do not add any.
4. Write the required functions as described by the function header and comment block.

Do NOT change any of the function headers.

5. Write the function definitions below `main()`, and their prototypes above `main()`.
6. Do not turn in code with `cout` in any function besides `printVector()` and the `cout` statements already coded in `main()`.

You may add `cout` to debug code but please remove it before turning in your code.

7. Compile and run the code when finished with each function to verify correctness. Check the test results and make any alterations to your function definitions as necessary. Do NOT change any code in `main()` beyond removing comments to call the functions and do not change the function headers.

When you first start you will see warnings when compiling. Remember that code with warnings compiles but the warning is giving you hints about problems with the code.

8. Example Run: The outputs of the program must look exactly like the following for full credit, including the same order and format of the output. There is no user input.
```***Testing findFirst42***
findFirst42a should be 2: 2
findFirst42b should be 3: 3
findFirst42c should be -1: -1

***Testing is123***
is123a should be true: true
is123b should be false: false
is123c should be true: true

***Testing printVector***
printVector1 should be 1 2 3 1: 1 2 3 1
printVector2 should be 1 2 4 1: 1 2 4 1
printVector3 should be 7: 7

***Testing eraseFirst42***
eraseFirst42a should be 1 2 3 1: 1 2 3 1
eraseFirst42b should be 1 2 3 42 1: 1 2 3 42 1
eraseFirst42c should be 1 2 3: 1 2 3

***Testing at2Insert42***
at2Insert42a should be 1 2 42 3: 1 2 42 3
at2Insert42b should be 1 2 42 3 2: 1 2 42 3 2
at2Insert42c should be 1 0 42: 1 0 42

***End of Tests***
```
9. When all of the tests pass, upload your completed source code file with the rest of the assignment as described in Deliverables.

#### Project 2: Favorite Movie List

Many people like to make and share lists of movies that they enjoy watching. To find more information about a movie, the user selects a title from a list. In this assignment, we take our `Movie` class from Assignment 9 to develop a favorite movie's list.

We are using a vector to make our list of movies. Visualize the vector as a series of entries in a list. Each element of the vector represents a movie. The entries are identified by a number as shown below.

`movies = `
 `string title` `int year` `double revenue`
`[0]`
 `string title` `int year` `double revenue`
`[1]`
 `string title` `int year` `double revenue`
`[2]`

The vector stores each `Movie` object, one object to each box (element) as shown. We can add or delete movies in the list by adding or removing `Movie` objects to and from the vector. Each object listed above holds three pieces of data. To access the data inside an object we use member functions like `read()`, `print()`, `getTitle()`, `setTitle()` and so on.

##### Project Specifications
1. Correct any errors in your `Movie` class from Assignment 9.

If you had problems with your the `Movie` class and are not sure how to correct them, ask the instructor for help.

2. Using your (possible corrected) `Movie` class from Assignment 9, develop a movie list application.

Keep the same name for the `Movie` class. Do NOT add any new member variables to the class (including vectors) and do not remove or modify any of the existing member functions specified in the last assignment, unless you had an error that you are correcting. Make sure to `#include <climits>` if you use `INT_MAX` and `#include <cstdlib>` if you use `exit()` to ensure the program compiles on all computers.

3. Name the source code file `movielist.cpp` and include all your code in this single file.

Be careful of the spelling, including capitalization, as you will lose points for a misspelled title. Naming is important in programming.

4. Add a `read()` member function (and no other function) to your `Movie` class. The function has no parameters and returns nothing. The `read()` function reads data from `cin` and stores it into the member variables of the `Movie` object in the following order:
1. `title`
2. `year`
3. `revenue`

The `read()` function must operate like the following:

```Enter the title of the movie: Finding Nemo
Enter the year for Finding Nemo 2003
Enter the revenue for Finding Nemo 940.0
```

In the above example, the user entered the values shown in aqua italics (for emphasis). The user must be able to enter any number of words for the movies's title with spaces between each word as shown.

5. Use a vector to store your `Movie` objects and add at least three of the movies from assignment 9 to the vector near the start of `main()`.

Thus, your movies list will have at least three movies included automatically when your program starts.

6. Develop a menu to manage the movies list that is redisplayed after each option is completed and looks like the following:
```Please choose one of the following operations:
0. Exit program
1. List movies
3. Delete a movie
4. Change movie revenue
5. List by year range
Choice (0-5): _
```

The user enters the number of the operation on the line labeled "Choice" where the underbar "`_`" is shown. The underbar "_" is shown for information only and is not part of the program display.

Entering a `0` exits the program and that is the only way to exit the program. However, if the user enters a number not on the menu then output an error message and continue operating.

```Choice (0-5): 9999

Invalid choice!

Please choose one of the following operations:
0. Exit program
1. List movies
3. Delete a movie
4. Change movie revenue
5. List by year
Choice (0-5): _
```

Do NOT change the number of a menu operation nor have any input before the menu input.

Design hint: Place your menu in `main()` and call a non-member function to perform each menu option.

7. In addition to `main()` and the `Movie` class member functions, define between three and eight non-member functions and call all the non-member functions at least once to perform an action.

Remember that a non-member function does not have a prototype declared inside the class.

8. Structure your code to declare non-member function prototypes before `main()` and non-member function definitions after `main()` for all your functions.
9. Example Run: The input prompts and outputs of the program must look like the following for full credit, including the same order of input and wording of the output. Data entry is shown in aqua italics for clarity only and is not part of the program display. For the input shown you must get the same output. However, the output must change properly if the inputs are different.

1. List the movies in the list when selecting menu item 1, The listing includes the information from the `print()` function with a heading and item number starting at one (1) as shown below. Do NOT print movie lists unless the user enters menu item 1.
```Welcome to the Movie List Manger!

Please choose one of the following operations:
0. Exit program
1. List movies
3. Delete a movie
4. Change movie revenue
5. List by year range
Choice (0-5): 1

Famous Movie List:
# Title                                Year  Revenue (m\$)*
1 Avatar                               2009   3251.0
2 Star Wars, Episode IV: A New Hope    1977   3041.3
3 Black Panther                        2018   1346.9
*m\$: millions of dollars
```
2. Add a movie to the movies list when selecting menu item 2 by calling the `read()` member function of the `Movie` class and inserting the new entry at the end of the list.
```Please choose one of the following operations:
0. Exit program
1. List movies
3. Delete a movie
4. Change movie revenue
5. List by year range
Choice (0-5): 2

Enter the title of the movie: Finding Nemo
Enter the year for Finding Nemo 2003
Enter the revenue for Finding Nemo 940
```

Notice that the user can enter spaces within the movie title.

3. Delete a movie from the list when selecting menu item 3. Present a list of movies and allow the user to enter the number of the movie to remove form the list. This operation removes the `Movie` object from the vector.
```Please choose one of the following operations:
0. Exit program
1. List movies
3. Delete a movie
4. Change movie revenue
5. List by year range
Choice (0-5): 3

Deleting a movie:
Famous Movie List:
# Title                                Year  Revenue (m\$)*
1 Avatar                               2009   3251.0
2 Star Wars, Episode IV: A New Hope    1977   3041.3
3 Black Panther                        2018   1346.9
4 Finding Nemo                         2003    940.0
*m\$: millions of dollars
Enter the number of the movie: 1
```

Notice that the program inserted the movie from the previous step into the system at the requested location.

4. Change the revenue for a movie when selecting menu item 4. Present a numbered list for the user to choose from and allow the user to choose which movie to change by entering their number.
```Please choose one of the following operations:
0. Exit program
1. List movies
3. Delete a movie
4. Change movie revenue
5. List by year range
Choice (0-5): 4

Change revenue for a movie:
Famous Movie List:
# Title                                Year  Revenue (m\$)*
1 Star Wars, Episode IV: A New Hope    1977   3041.3
2 Black Panther                        2018   1346.9
3 Finding Nemo                         2003    940.0
*m\$: millions of dollars
Enter the number of the movie: 2
Enter the new revenue: 3210.123
```

Which updates the revenue for the movie.

5. List the movies if their year are within a specified range by selecting menu item 5. Allow the user to enter the minimum and then maximum year before listing the movies.
```Please choose one of the following operations:
0. Exit program
1. List movies
3. Delete a movie
4. Change movie revenue
5. List by year range
Choice (0-5): 5

Searching by year
Enter the starting year: 2000
Enter the ending year: 2018
Title                                Year  Revenue
Black Panther                        2018   3210.1
Finding Nemo                         2003    940.0
```

Which lists only those movies within the year range. Notice that the numbering of each movie is optional because the user does not select a movie from the listing.

10. Submit this project with the rest of the assignment as described in Deliverables.
Hints:
1. For the menu, use a sentinel controlled loop with conditional statements to select the operations. See Exercise 10.4 step 8.
2. To set the three initial objects in a vector, see the "Partial Listing of `prodvector.cpp`" in Exercise 10.4. Another way is to use the `push_back()` function on an empty vector like:
```vector<Product> list;
Product milk("Milk", 3.95);
list.push_back(milk); ```
3. When adding a movie title, remember how `getline()` and `cin >> ws;` work together. See lesson 6.1.4.
4. To update the revenue:
1. Ask the user for the position of the movie in the vector:
`cin >> position;`

Adjust the position entered as needed to match the vector index.

2. Ask for the revenue and use the `setRevenue()` function to update the revenue:
```list[position].setRevenue(input);
```
5. To see an example of how the program operates, download and run the executable file from the command line:
1. List of highest-grossing films: Wikipedia

## Extra Credit

The following are worth extra credit points if the main program works well:

1. Complete the assignment using pair programming. (1 point)
2. Create your own interesting vector function problem for the vector-function worksheet. (1 point for completing correctly, 1 point for robust test cases, and 1 point for interest and creativity)
1. Submit the extra function and its `main()` function in a file named `xcvectorwork.cpp`.
2. The function must have a vector parameter and must find, insert or delete values in the vector.
3. Do not have any user input in the extra credit file.
4. Label the tests in `main()` with a `cout` statement with the words "Testing Extra Credit" followed by the function name, like:
```*** Testing Extra Credit myFabFun ***
```
5. Following the label, include at least 3 test cases calling the extra function in `main()`, testing different aspects like the test cases in the standard project. Each case must display all on one line and have an expected result like:
```myFabFun should be 42: 42
```
6. Be sure to credit the source of the extra function, even if yourself, in both the source code file and README.txt.

Describe any extra credit attempted in your `README.txt` file.

## Tutorial Lab

To prepare for the next lesson, complete the following exercises.

1. Type the `babynames.cpp` program from the textbook on pages 354-357 (332 -333) into a text editor, and then compile and run the program. Submit the source code file (`babynames.cpp`) to Canvas for grading. Use the babynames.txt file to test your program.
2. Complete the Tutorial Exercises in CodeLab 10 and 11 before the specified due date. Refer to the assigned reading for the next lesson to help you understand the problems. Also, you can use the online lecture notes for more information as the notes become available. Click the "Solution" tab if you get stuck on a Tutorial problem.

The instructor will evaluate your assignment using the following criteria. Thus you should check your assignment against these criteria to maximize your score.

Each criteria represents a specific achievement of your assignment and has a scoring guide. The scoring guide explains the possible scores you can receive. Some scoring guides have a list of indicators. These indicators are a sign of meeting, or a symptom of not meeting, the specific criterion. Note that a single indicator may not always be reliable or appropriate in a given context. However, as a group, they show the condition of meeting the criterion.

For information on grading policies, including interpretation of scores, see the syllabus.

#### Lesson Exercises

• 2: All lesson exercises attempted and turned in
• 1: Some lesson exercises completed and turned in
• 0: No lesson exercises completed or turned in

#### Vector Function Worksheet Functionality

• 4: All functions completed and program generates the correct output without error
• 3: All functions completed but has a minor error
• 2: Most functions completed or has some small errors
• 1: Few functions completed or has many errors
• 0: Does not compile or wrong file turned in

#### Favorite Movie List Functionality

• 10: Demonstrates mastery of the assignment
• Applies concepts from the lessons appropriately
• Meets all specifications (see above) with particularly elegant solutions
• Runs to completion with no abnormal error conditions
• Generates correct output given correct input
• Behaves in a reasonable way in response to incorrect data
• 8: Has all the functionality expected of the assignment
• Demonstrates many techniques from the lesson
• Attempts to meet all specifications (see above)
• Implementation seems more complicated than necessary.
• May have one minor error
• 6: Has most of the functionality expected of the assignment
• Demonstrates some techniques from the lesson
• Attempts to meet all but one of the specifications (see above)
• Implementation seems excessively complicated.
• May have 2-3 minor errors
• 4: Has some of the functionality expected of the assignment
• Demonstrates some techniques from the lesson
• Attempts to meet at least 1/2 of the specifications (see above)
• Implementation seems excessively complicated.
• May have more than 3 minor errors
• 2: Serious functional problems but shows some effort and understanding
• Attempts to meet less than 1/2 of the of the specifications (see above)
• Has a major error or many minor errors
• Implementation seems very convoluted
• Demonstrates few techniques from the lesson
• 1: Does not compile or wrong file turned in
• 0: Does not execute, not turned in or uses techniques not covered in course

#### Program Style

• 4: Code is well-documented including:
• 3: Code has a minor documentation error
• 2: Code has some documentation errors
• 1: Code has many documentation errors
• 0: No apparent attempt to follow documentation standards or write documentation comments

#### CodeLab and Other Tutorial Exercises

• Number CodeLab completed correctly / number exercises * 8 and rounded up to the nearest integer.
• -1 if the tutorial exercise file does not compile
• -2 if the tutorial exercise file is not turned in

#### `README.txt` File

• 2: `README.txt` file submitted following the instructions
• 1: `README.txt` file submitted but some information was missing
• 0: No `README.txt` file submitted

Total possible: 30, plus extra credit

## Deliverables

Submit your assignment to Canvas, in the assignment folder A11-Keeping Lists, following the instructions for submitting homework. Include the following items for grading:

1. `README.txt` file
2. All the exercise files from lesson 10 and lesson 11
3. `vectorwork.cpp`
4. `movielist.cpp`
5. `babynames.cpp` from the Tutorial Lab Exercises

Your assignment must work as submitted, so submit all the files needed to complete your assignment. Remember to test and double check your files before submitting them. If you make a mistake, you can resubmit up to the deadline. If you resubmit, you must include all your assignment files in the last submission as Canvas hides prior submissions.

Last Updated: November 18 2018 @17:38:40