# 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. See lesson 1.3.5 on how to compile with C++11.

##### 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 signature and comment block.

Do NOT change any of the function signatures.

5. Write the function definitions below `main()`, and their prototypes above `main()`.
6. Compile and run the code when finished with each function to verify correctness.

Uncomment the function calls from `main()` as you progress. Do NOT change any code in `main()` beyond removing comments to run the code. Also, make sure you are compiling correctly:

```g++ -Wall -Wextra -Wpedantic -std=c++11 -o vectorwork vectorwork.cpp
```
7. Submit this project with the rest of the assignment as described in Deliverables.

#### Project 2: Contact List

A contact list is a collection of names and other information about people. To find information about a person, and to contact them, the user selects a name from a list. In this assignment, we take our `Person` class from Assignment 9 to develop a contact list.

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

`contacts = `
 `string name` `int age` `double income`
`[0]`
 `string name` `int age` `double income`
`[1]`
 `string name` `int age` `double income`
`[2]`

The vector holds each `Person` object, one object to each slot (element) as shown. We can add or delete contacts in the list by adding or removing `Person` 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()`, `getName()`, `setName()` and so on.

##### Project Specifications
1. Using your `Person` class from Assignment 9, develop a contact list application.

Keep the `Person` class name. Do NOT add any new member variables to the class (including vectors) and do not remove or modify any of the member functions specified in the last assignment, unless you had an error that you are correcting. If you had problems with the `Person` class, contact the instructor for help in getting started. 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.

2. You must name the source code file `contacts.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 name. Naming is important in programming.

3. Add a `read()` member function (and no other function) to your `Person` 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 `Person` object in the following order:
1. `name`
2. `age`
3. `income`

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

```Enter the name of the person: Joe Schmoe
Enter the age for Joe Schmoe: 24
Enter the income for Joe Schmoe: 9876.54
```

In the above example, the user entered the values shown in italics (for emphasis). The user must be able to enter spaces in the person's name as shown.

4. Use a vector to store your `Person` objects and add at least three of the persons from the previous assignment to the vector.

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

5. Develop a menu to manage the contacts 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 contacts
3. Delete a contact
4. Change contact income
5. List by age 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. Do NOT change the number of a menu operation.

Hint: Call a function to perform each menu option.

6. 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 italics for information 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 contacts in the contacts list, which includes the information from the `print()` function with a heading and item number starting at one as shown below.
```Please choose one of the following operations:
0. Exit program
1. List contacts
3. Delete a contact
4. Change contact income
5. List by age range
Choice (0-5): 1

Contact list:
# Name                 Age     Income
1 Sophie Engineer       42  102280.00
2 Emma Hacker           24   71916.00
3 John Q Public         37   55775.37
```
2. Add a contact to the contacts list when selecting menu item 2 by calling the `read()` member function of the `Person` class and inserting the new entry at the end of the list.
```Please choose one of the following operations:
0. Exit program
1. List contacts
3. Delete a contact
4. Change contact income
5. List by age range
Choice (0-5): 2

Enter the name of the person: Joe Schmoe
Enter the age for Joe Schmoe: 27
Enter the income for Joe Schmoe: 9876.54
```

Notice that the user can enter spaces within the contact name.

3. Delete a contact from the list when selecting menu item 3 and entering the number of the contact on the list. This operation removes the `Person` object from the vector.
```Please choose one of the following operations:
0. Exit program
1. List contacts
3. Delete a contact
4. Change contact income
5. List by age range
Choice (0-5): 3

Deleting a contact:
Contact list:
# Name                 Age     Income
1 Sophie Engineer       42  102280.00
2 Emma Hacker           24   71916.00
3 John Q Public         37   55775.37
4 Joe Schmoe            27    9876.54
Enter the number of the contact: 1
```

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

4. Changing the income for a contact.
```Please choose one of the following operations:
0. Exit program
1. List contacts
3. Delete a contact
4. Change contact income
5. List by age range
Choice (0-5): 4

Change income for a contact:
Contact list:
# Name                 Age     Income
1 Emma Hacker           24   71916.00
2 John Q Public         37   55775.37
3 Joe Schmoe            27    9876.54
Enter the number of the contact: 2
Enter the new income: 54321.42
```

Which updates the income for the contact.

5. Listing the contacts by age range.
```Please choose one of the following operations:
0. Exit program
1. List contacts
3. Delete a contact
4. Change contact income
5. List by age range
Choice (0-5): 5

Searching by Age
Enter the minimum age: 20
Enter the maximum age: 30
Name                 Age     Income
Emma Hacker           24   71916.00
Joe Schmoe            27    9876.54
```

Which lists only those contacts within the age range.

7. In addition to the `main()` and the `Person` 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.

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

8. Structure your code such to declare non-member function prototypes before `main()` and non-member function definitions after `main()` for all your functions.
9. 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 contact name, remember how `getline()` and `cin >> ws;` work together. See lesson 6.2.4.
4. To update the income:
1. Ask the user for the position of the person in the vector:
`cin >> position;`

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

2. Ask for the income and use the `setIncome()` function to update the income:
```list[position].setIncome(input);
```
5. To see an example of how the program operates, download and run the executable file from the command line:

## 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, 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.
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.
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. You can look at solutions if you miss your first attempt by clicking the "Solution" tab.

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

#### Contacts 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 that matches the name of this assignment, 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. `contacts.cpp`
5. `babynames.cpp` from the Tutorial Lab Exercises

You must submit all the files needed to complete your assignment. Your assignment must work as submitted. 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 25 2017 @00:05:16