Program 1
Objectives of the assignment
The objectives of this programming assignment are:
● Reviewing most of the concepts learned in ECS 36a and ECS 36b (object-oriented
programming, file manipulation, command line arguments, operator overloading, and
recursion, Makefile, etc.)
● Understanding how computational complexity can apply to real-life programs.
● Running test measurements and analyzing the results in order to provide an argued
answer to the given problem.
Program description
Introduction
You are helping the library catalog books, and provide books to departments upon request.
The librarian received new shipments of books. The books are identified with an ISBN number,
language( "english","french", "chinese","spanish”) and type: “new”, “used”, or digital.
They also receive requests for books with different ISBN numbers, languages, and in either
new, used, or digital format. You will only have one unique request item at a time, no duplicate
requests will be made. (ISBN: this is the number the publisher assigns An ISBN is assigned to
each edition and variation of a book)
For example the Library may receive a shipment of 5 books
$ cat newbooks.dat
$cat request.dat
30,english,used
24,english,new
105,chinese,new
32,spanish,digital
37,spanish,newProgramming Assignment:
Create a program SearchNewBooks.cpp that given as command line input newbooks.dat and
request.dat and a method of search either binary or linear, creates a file of the number of books
found from the request list
$SearchNewBooks newbooks.dat request.dat //run program
$Choice of search method ([l]inear, [b]inary, [r]ecursiveBinary)?
b
CPU time: 10.777 microseconds
$cat found.dat
1
Written:
By running the program multiple times and with inputs of different size explain the pros and cons
of linear search versus sorting first and using binary search, with respect to computational
complexity. Try to explain if it is possible to determine a ratio between the number of new books
N and the number of requests to search M, that makes either linear search or binary search the
best option.
Constraints
Your program must be compatible with C++ only and use the standard functions provided by the
C++ Standard Library.
Your program cannot be linked to any other external libraries (e.g., Boost).
Your code should try follow the Google C++ Style Guide this is for your benefit and is not
required
Your program should be properly commented when necessary.
Grading
Your grade for this assignment will be broken down in several scores:
● Grading Guide:
○ 75% of graded correctness
○ 2% Makefile
○ 3% Unit tests Phase 6○ 5 % of grade -
■ good commenting explain what your code is doing to someone who
doesn’t know c++
■ Overloading operators
■ Code structure and style
○ 15% written assignment
Suggested work phases
Phase 0: preliminary work
Copy files
In this preliminary phase, copy the few provided files from canvas to your project directory on
csif or preferred work space
● create_testData: a program that generates sample datasets in order to test your program
with inputs of various sizes.
○ It expects two command line arguments when being run:
■ The number of newBooks to generate in the output newbooks.dat file
■ The number of requested books to generate in the output requests.dat file
○ For example:
$ create_testData 5 3
$ ls newbooks.dat
newbooks.dat
$ create_testData 5 3
$ cat newbooks.dat
$ cat request.dat● https://github.com/google/styleguide/tree/gh-pages/cpplint, the C++ linter developed by
Google to ensure that code conforms to their style guide. I will not grade on this but
just want you to see the results you would get.
● With this python file located in the same directory as your program, you can run the
linter as shown in the example below and fix the reported warnings:
● $ python cpplint.py SearchNewBooks.cpp
Done processing SearchNewBooks.cpp
Makefile
Write a simple Makefile that generates the executable SearchNewBooks from the file
SearchNewBooks.cpp, using g++.
The compiler should be run with the -Wall (enable all warnings) and -Werror (treat all warnings
as errors) options.
There should also be a clean rule that removes any generated files (executables, datasets, etc.)
and puts the directory back in its original state.
Phase 1: reading in the dataset
In this phase, your program should receive two filenames as command line arguments, the new
books file and request file, which the program should read in. The list of new books and list of
requested books should be stored in only two std::vector containers.
Because some code to open these two files will probably be equivalent, you are encouraged to
write generic functions in order to avoid code duplication.
New Books file
The first file contains a list of new books identified by ISBN number and type, one per line. Each
line has an integer value and two strings.
Example of new books file:
$cat newBooks.dat
30,english,used
24,english,new
105,chinese,new
32,spanish,digital
37,spanish,new
You should write a class for representing books as a combination of both the ISBN number,
language and type, so that each vector is an object of that class. For debugging purposes, you
can overload the << operator to print positional vectors in a pretty way.Requested Books file
The second file contains a list of Requested books, one per line and expressed as an integer
value, and 2 strings
Example of file:
$ cat request.dat
36,spanish,used
9,french,used
Phase 2: searching strategies
In this phase, you will need to implement three search strategies in order to find the given
requested books in the list of new arrivals: a linear search and a binary search, and a
recursive binary search.
The user will choose between using one of these three strategies every time the program is run.
If the user input is invalid, they should be asked again, as shown in the example below. The
error message should be printed to std::cerr.
$ ./SearchNewBooks newBooks.dat request.dat result1.dat
Choice of search method ([l]inear, [b]inary, [r]ecursiveBinary)?
J
Incorrect choice
2
Incorrect choice
l
CPU time: 10.777 microseconds
$
-------------------------
The general search algorithm is:
count = 0
for (b in request)
if (search if b is in newBooks)
count += 1
For the binary search, the vector of new books should be sorted by their ISBN number, type,
and followed by language beforehand with the following criteria:
ISBN number is organized from smallest to largest, if ISBN is equal then by type in order “new”,
“used”, “digital”, if type is equal then by language in alphabetical order.
For the sorting, you must use std::sort and overload the < operator of your positional vector
class, this function can easily be applied for sorting all of objects contained in a vector container:
std::sort(vect_list.begin(), vect_list.end());You can overload other operators.
You should create a separate file that codes the searching strategies called
Phase 3: processing time measurements
Create a class for counting the number of elapsed microseconds, which you will use to measure
the performance of the search strategies. Your class should a high resolution clock, as defined
by std::chrono::high_resolution_clock, and convert the time into microseconds for display.
Because the linter provided by Google doesn’t like the use of chrono, we have to turn the linter
down for the include line specifically as shown in the example.
Here is an example of how to use the relevant functions defined in std::chrono:
#include <chrono> // NOLINT (build/c++11)
...
std::chrono::high_resolution_clock::time_point start;
start = std::chrono::high_resolution_clock::now();
... /* some computation happening */
auto end = std::chrono::high_resolution_clock::now();
double elapsed_us = std::chrono::duration<double, std::micro>(end - start).count();
std::cout << "CPU time: " << elapsed_us << " microseconds";
...
If you declare ct as an object of such class, your program’s main fragment of code could look
like:
print "Choice of search method ([l]inear, [b]inary, [r]recursiveBinary)?"
get choice from user
ct.Reset()
switch (choice)
case 'l':
run linear search
break;
case 'b':
sort vector of books
Run non recursive binary search on all requests
break;
case 'r':
sort vector of books
run recursive binary search
break;default:
print "Incorrect choice"
go back to getting user choice
print "CPU time: " << ct.CurrentTime() << " microsec"
Optionally, you can overload the class’ << operator and simply display object ct directly (e.g.:
std::cout << ct << std::endl;).
Phase 4: writing the result
Your program should now receive a third and last command-line argument, specifying the name
of the output file. If no file is named it will be written to a default file named “found.dat”. The
found file will contain only the total count of the books found. Each book only needs to be
found once any additional copies are not relevant.
The number of requested books found in the list of new arrivals should be written in the output
file.
$SearchNewBooks newbooks.dat request.dat //run program
$Choice of search method ([l]inear, [b]inary, [r]ecursiveBinary)?
1
CPU time: 10.777 microseconds
$cat found.dat
1
Error management
At this point, your program should handle errors properly.
In case of any errors, i.e., if the wrong number of arguments is given or if a file cannot be
opened, your program should print the relevant error message on std::cerr as shown in the
example below.
$ ./SearchNewBooks
Usage: .SearchNewBooks <newBooks.dat> <request.dat> <result_file.dat>
$ ./SearchNewBooksh toto
Usage: .SearchNewBooks <newBooks.dat> <request.dat> <result_file.dat>
$ ./SearchNewBooks toto titi tata
Error: cannot open file toto
$Phase 5: measurement analysis
In this last phase, you need to generate various datasets of different sizes and run them with
your program. It is advised to run each dataset at least three times and average the running
time to make sure the measurements are steady.
Find a collection of datasets that allows you to make some analysis regarding the choice
between the two searching strategies.
Write everything in a PDF document name report.pdf that you will submit via gradescope.
Submission
Please follow the handin instructions, no late work will be accepted.
Content
You should submit the following files:
● author.txt: your student ID, last name, first name on one line.
● Makefile: a Makefile that compiles your source code without any errors or warnings (on
CSIF computers), and builds an executable named SearchNewBooks.
● SearchNewBooks.cpp, search.cpp, search.h, book.h and book.cpp AND test.cpp and
any other source code files if applicable.
Do not submit any other files to csif. Please submit the report to gradescope.
Hand in to Gradescope
Hadnin all .cpp,.h files and the makefiles
Academic integrity
You are expected to write this project from scratch, thus avoiding to use any existing source
code available on the Internet, and alone. Asking someone else to write your code (e.g., on
website such as Chegg.com) is not acceptable and will result in severe sanctions.
You must specify in your report any sources that you have viewed to help you complete this
assignment. All of the submissions will be compared with MOSS to determine if students have
excessively collaborated, or have used the work of past students.Any failure to respect the class rules, as explained above or in the syllabus, or the UC Davis
Code of Conduct will automatically result in the matter being transferred to Student Judicial
Affairs.
