<WRAP centeralign round box>
<WRAP><color red><fs 200%>Corning Community College</fs></color></WRAP>
<WRAP><fs 150%>CSCS1320 C/C++ Programming</fs></WRAP>
</WRAP>

~~TOC~~

======Project: OPTIMIZING ALGORITHMS - PRIME NUMBER CALCULATION (pnc1)======

=====Objective=====
To apply your skills in algorithmic optimization through the implementation of improved prime number calculating programs.

=====Algorithmic Complexity=====
A concept in Computer Science curriculum is the notion of computational/algorithmic complexity.

Basically, a solution to a problem exists on a spectrum of efficiency (typically constrained by time vs. space): if optimizing for time, the code size tends to grow.

Additionally, if optimizing for time (specifically to reduce the amount of time taken), strategic approaches are taken to reduce unnecessary or redundant operations (yet still achieving the desired end results).

This project will endeavor to introduce you to the notion that the algorithms and constructs you use in coding your solution can and do make a difference to the overall runtime of your code.

=====Optimizing the prime number calculation=====
We should be fairly familiar with the process of computing primes by now, which is an essential beginning step to accomplish before pursuing optimization. Following will be some optimizations I'd like you to implement (as separate programs) so we can analyze the differences in approaches, and how they influence runtimes.

====odds (primeodds)====
Some optimizations can be the result of sheer common sense observations. For instance, with the exception of 2, all primes are odd numbers.

So does it make sense to check an even number for primality? No, it doesn't.

And can we predict even numbers? Yes, we can: they occur every other number.

Therefore, we can start our number checking at 3, and skip 2 values each time (3, 5, 7, 9, 11, etc.).

To make our output correct, we would simply display the "2" outright. We know it is prime, and will make that assumption with this program.

This program should be an optimization based on your **primebruteopt** program from pnc0.

====square root (primesqrt)====
An optimization to the computation of prime numbers is the square root trick. Basically, if we've processed numbers up to the square root of the number we're testing, and none have proven to be evenly divisible, we can also assume primality and bail out.

The C library has a **sqrt()** function available through including the **math.h** header file, and linking against the math library at compile time (add **-lm** to your gcc line).

To use **sqrt()**, we pass in the value we wish to obtain the square root of, and assign the result to an **int**:

<code c>
int x = 25;
int y = 0;

y = sqrt(x);

// y should be 5 as a result
</code>

For instance, the number 37 (using the square root optimization), we find the square root (whole number) of 37 is 6, so we only need to check 2-6:

<code>
37 % 2 = 1 (2 is not a factor of 37)
37 % 3 = 1 (3 is not a factor of 37)
37 % 4 = 1 (4 is not a factor of 37)
37 % 5 = 2 (5 is not a factor of 37)
37 % 6 = 1 (6 is not a factor of 37)
</code>

Because none of these values evenly divides, we can give 37 a pass: **it is a prime**

This will dramatically improve the runtime, and offers a nice comparison against our brute force baseline.

NOTE: You will be reverting to checking all numbers (both even and odd) with this program.

This program should be an optimization based on your **primebruteopt** program from pnc0.

====sqrt() odds (primesqrtodds)====
In the previous program we used **sqrt()** against all the values, even or odd.

This program will eliminate the even values, checking only the odds.

This program should be an optimization of your **primesqrt** program.

====sqrt()-less square root (primesqrtopt)====
An optimization to the previous process, which used **sqrt()**, this variation will do the exact same thing, but without using the **sqrt()** function. It will approximate the square root.

We know that a square root (especially a whole numbered square root), is when we have whole number factors that are squared. But in addition, only considering the whole number aspect of the square root, we start seeing series of values with the same whole square root value:

<cli>
lab46:~$ count=0; for ((i=2; i<152; i++)); do printf "[%3d] %2d " "${i}" `echo "sqrt($i)" | bc -q`; let count=count+1; if [ "${count}" -eq 10 ]; then echo; count=0; fi; done; echo
[  2]  1 [  3]  1 [  4]  2 [  5]  2 [  6]  2 [  7]  2 [  8]  2 [  9]  3 [ 10]  3 [ 11]  3
[ 12]  3 [ 13]  3 [ 14]  3 [ 15]  3 [ 16]  4 [ 17]  4 [ 18]  4 [ 19]  4 [ 20]  4 [ 21]  4
[ 22]  4 [ 23]  4 [ 24]  4 [ 25]  5 [ 26]  5 [ 27]  5 [ 28]  5 [ 29]  5 [ 30]  5 [ 31]  5
[ 32]  5 [ 33]  5 [ 34]  5 [ 35]  5 [ 36]  6 [ 37]  6 [ 38]  6 [ 39]  6 [ 40]  6 [ 41]  6
[ 42]  6 [ 43]  6 [ 44]  6 [ 45]  6 [ 46]  6 [ 47]  6 [ 48]  6 [ 49]  7 [ 50]  7 [ 51]  7
[ 52]  7 [ 53]  7 [ 54]  7 [ 55]  7 [ 56]  7 [ 57]  7 [ 58]  7 [ 59]  7 [ 60]  7 [ 61]  7
[ 62]  7 [ 63]  7 [ 64]  8 [ 65]  8 [ 66]  8 [ 67]  8 [ 68]  8 [ 69]  8 [ 70]  8 [ 71]  8
[ 72]  8 [ 73]  8 [ 74]  8 [ 75]  8 [ 76]  8 [ 77]  8 [ 78]  8 [ 79]  8 [ 80]  8 [ 81]  9
[ 82]  9 [ 83]  9 [ 84]  9 [ 85]  9 [ 86]  9 [ 87]  9 [ 88]  9 [ 89]  9 [ 90]  9 [ 91]  9
[ 92]  9 [ 93]  9 [ 94]  9 [ 95]  9 [ 96]  9 [ 97]  9 [ 98]  9 [ 99]  9 [100] 10 [101] 10
[102] 10 [103] 10 [104] 10 [105] 10 [106] 10 [107] 10 [108] 10 [109] 10 [110] 10 [111] 10
[112] 10 [113] 10 [114] 10 [115] 10 [116] 10 [117] 10 [118] 10 [119] 10 [120] 10 [121] 11
[122] 11 [123] 11 [124] 11 [125] 11 [126] 11 [127] 11 [128] 11 [129] 11 [130] 11 [131] 11
[132] 11 [133] 11 [134] 11 [135] 11 [136] 11 [137] 11 [138] 11 [139] 11 [140] 11 [141] 11
[142] 11 [143] 11 [144] 12 [145] 12 [146] 12 [147] 12 [148] 12 [149] 12 [150] 12 [151] 12
</cli>

Square root of 81 is 9, but so is the square root of 82, 83, 84... etc. up until we hit 100.

If we were checking 87 to be prime, we'd only have to check up to 9.

We don't need a **sqrt()** function to tell us this, we can determine the approximate square root point ourselves- by squaring the current factor being tested, and so long as it hasn't exceeded the value we're checking, we know to continue.

There are some important lessons at play here:

  * approximation can be powerful
  * approximation can result in a simpler algorithm, improving runtime
    * **sqrt()** is more complex than you may be aware, not to mention it is in a function. By avoiding that function call, we eliminate some overhead, and that can make a big difference in runtime performance.

NOTE: Again, for comparison sake, check ALL numbers (even and odd) for this variant.

This program should be an optimization of your **primesqrt** program.

====sqrt()-less odds (primesqrtoptodds)====
And, to round out our analysis, enhance the optimized sqrt variant to only check odd values. 

This program should be an optimization of your **primesqrtopt** program.

=====Program=====
It is your task to write some optimized prime number calculating programs:

  - **primeodds.c**: checking only odd values
  - **primesqrt.c**: for your **sqrt()**-based implementation
  - **primesqrtodds.c**: **sqrt()**-based implementation only checking odds
  - **primesqrtopt.c**: for your **sqrt()**-less square root approximated implementation
  - **primesqrtoptodds.c**: **sqrt()**-less square root only checking odds 

Your program should:
  * obtain 1 parameter from the command-line (see **command-line arguments** section below):
    * argv[1]: maximum value to calculate to (your program should run from (approximately) 2 through that number (inclusive of that number)
    * this value should be a positive integer value; you can make the assumption that the user will always do the right thing.
  * do the specified algorithmic optimizations
    * please take note in differences in run-time, contemplating the impact the various algorithms and approaches have on performance.
  * start your stopwatch (see **timing** section below):
  * perform the correct algorithm against the input
  * display (to STDOUT) the prime numbers found in the range
  * output the processing run-time to STDERR
  * your output **MUST** be conformant to the example output in the **execution** section below. This is also a test to see how well you can implement to specifications. Basically:
    * as primes are being displayed, they are space-separated (first prime hugs the left margin), and when all said and done, a newline is issued.
    * the timing information will be displayed in accordance to code I will provide (in the **timing** section).

=====Command-Line Arguments=====
To automate our comparisons, we will be making use of command-line arguments in our programs. As we have yet to really get into arrays, I will provide you same code that you can use that will allow you to utilize them for the purposes of this project.

====header files====
We don't need any extra header files to use command-line arguments, but we will need an additional header file to use the **atoi(3)** function, which we'll use to quickly turn the command-line parameter into an integer, and that header file is **stdlib.h**, so be sure to include it with the others:

<code c>
#include <stdio.h>
#include <stdlib.h>
</code>

====setting up main()====
To accept (or rather, to gain access) to arguments given to your program at runtime, we need to specify two parameters to the main() function. While the names don't matter, the types do.. I like the traditional **argc** and **argv** names, although it is also common to see them abbreviated as **ac** and **av**.

Please declare your main() function as follows:

<code c>
int main(int argc, char **argv)
</code>

The arguments are accessible via the argv array, in the order they were specified:

  * argv[0]: program invocation (path + program name)
  * argv[1]: our maximum / upper bound

====Simple argument checks====
Although I'm not going to require extensive argument parsing or checking for this project, we should check to see if the minimal number of arguments has been provided:

<code c>
    if (argc < 2)  // if less than 2 arguments have been provided
    {
        fprintf(stderr, "Not enough arguments!\n");
        exit(1);
    }
</code>

====Grab and convert max====
Finally, we need to put the argument representing the maximum value into a variable.

I'd recommend declaring a variable of type **int**.

We will use the **atoi(3)** function to quickly convert the command-line arguments into **int** values:

<code c>
    max  = atoi(argv[1]);
</code>

And now we can proceed with the rest of our prime implementation.

=====Timing=====
Often times, when checking the efficiency of a solution, a good measurement (especially for comparison), is to time how long the processing takes.

In order to do that in our prime number programs, we are going to use C library functions that obtain the current time, and use it as a stopwatch: we'll grab the time just before starting processing, and then once more when done. The total time will then be the difference between the two (end_time - start_time).

We are going to use the **gettimeofday(2)** function to aid us in this, and to use it, we'll need to do the following:

====header file====
In order to use the **gettimeofday(2)** function in our program, we'll need to include the **sys/time.h** header file, so be sure to add it in with the existing ones:

<code c>
#include <stdio.h>
#include <stdlib.h>
#include <sys/time.h>
</code>

====timeval variables====
**gettimeofday(2)** uses a **struct timeval** data type, of which we'll need to declare two variables in our programs (one for storing the starting time, and the other for the ending time).

Please declare these with your other variables, up at the top of main() (but still WITHIN main()-- you do not need to declare global variables).

<code c>
    struct timeval time_start; // starting time
    struct timeval time_end;   // ending time
</code>

====Obtaining the time====
To use **gettimeofday(2)**, we merely place it at the point in our code we wish to take the time.

For our prime number programs, you'll want to grab the start time **AFTER** you've declared variables and processed arguments, but **JUST BEFORE** starting the driving loop doing the processing.

That call will look something like this:

<code c>
    gettimeofday(&time_start, 0);
</code>

The ending time should be taken immediately after all processing (and prime number output) is completed, and right before we display the timing information to STDERR:

<code c>
    gettimeofday(&time_end, 0);
</code>

====Displaying the runtime====
Once we having the starting and ending times, we can display this to STDERR. You'll want this line:

<code c>
    fprintf(stderr, "%10.6lf\n", time_end.tv_sec - time_start.tv_sec + ((time_end.tv_usec - time_start.tv_usec) / 1000000.0));
</code>

For clarity sake, that format specifier is "%10.6lf", where the "lf" is "long float", that is **NOT** a number one but a lowercase letter 'ell'.

And with that, we can compute an approximate run-time of our programs. The timing won't necessarily be accurate down to that level of precision, but it will be informative enough for our purposes.

=====Execution=====
Your program output should be as follows (given the specified range):

<cli>
lab46:~/src/cprog/pnc1$ ./primesqrt 90
2 3 5 7 11 13 17 19 23 29 31 37 41 43 47 53 59 61 67 71 73 79 83 89 
  0.000088
lab46:~/src/cprog/pnc1$ 
</cli>

The execution of the programs is short and simple- grab the parameters, do the processing, produce the output, and then terminate.

=====Check Results=====
If you'd like to compare your implementations, I rigged up a script called **primerun** which you can run.

In order to work, you **MUST** be in the directory where your **primesqrt**, **primesqrtopt** and **primemap** binaries reside, and must be named as such. You'll also want to copy in your **primebrute** and **primebruteopt** binaries to truly get the full picture.

For instance (running on my implementations of the programs):

<cli>
lab46:~/src/cprog/pnc1$ primerun
====================================================================================================
    range        brute     bruteopt         odds         sqrt     sqrtodds      sqrtopt  sqrtoptodds 
====================================================================================================
      128     0.000179     0.000139     0.000124     0.000108     0.000085     0.000112     0.000078 
      256     0.000401     0.000161     0.000120     0.000149     0.000128     0.000119     0.000085 
      512     0.001535     0.000345     0.000213     0.000207     0.000179     0.000134     0.000134 
     1024     0.005385     0.000919     0.000542     0.000428     0.000268     0.000184     0.000159 
     2048     0.019076     0.002767     0.001481     0.000857     0.000517     0.000335     0.000302 
     4096     0.070836     0.009331     0.004770     0.002034     0.001148     0.000708     0.000480 
     8192     0.270955     0.032402     0.016253     0.004934     0.002525     0.001575     0.000950 
    16384     1.059970     0.116575     0.058424     0.012190     0.006239     0.003676     0.002117 
    32768     4.209891     0.424113     0.212701     0.030711     0.015568     0.008867     0.004950 
    65536   ----------     1.626774     0.787444     0.078278     0.039605     0.022158     0.012015 
   131072   ----------     7.769508     3.954632     0.211732     0.105749     0.066574     0.035054 
   262144   ----------   ----------   ----------     0.553307     0.275414     0.175391     0.091195 
   524288   ----------   ----------   ----------     1.440572     0.713855     0.444240     0.229179 
  1048576   ----------   ----------   ----------     3.743303     1.856485     1.137094     0.574455 
  2097152   ----------   ----------   ----------   ----------     4.857408     2.923402     1.451850 
  4194304   ----------   ----------   ----------   ----------   ----------   ----------     3.708858 
  8388608   ----------   ----------   ----------   ----------   ----------   ----------   ---------- 
====================================================================================================
 verify:       OK           OK           OK           OK           OK           OK           OK      
====================================================================================================
lab46:~/src/cprog/pnc1$ 
</cli>

For evaluation, each test is run 4 times, and the resulting time is averaged. During development, I have it set to only run each test once.

If the runtime of a particular prime variant exceeds an upper threshold (likely to be set at 2 seconds), it will be omitted from further tests, and a series of dashes will instead appear in the output.

If you don't feel like waiting, simply hit **CTRL-c** and the script will terminate.

I also include a validation check- to ensure your prime programs are actually producing the correct list of prime numbers. If the check is successful, you will see "OK" displayed beneath in the appropriate column; if unsuccessful, you will see "MISMATCH".

=====Submission=====
To successfully complete this project, the following criteria must be met:

  * Code must compile cleanly (no warnings or errors)
  * Output must be correct, and match the form given in the sample output above.
  * Code must be nicely and consistently indented (you may use the **indent** tool)
  * Code must utilize the algorithm(s) presented above.
    * **primeodds.c**
    * **primesqrt.c**
    * **primesqrtodds.c**
    * **primesqrtopt.c**
    * **primesqrtoptodds.c**
  * Code must be commented
    * have a properly filled-out comment banner at the top
      * be sure to include any compiling instructions
    * have at least 20% of your program consist of **<nowiki>//</nowiki>**-style descriptive comments
  * Output Formatting (including spacing) of program must conform to the provided output (see above).
  * Track/version the source code in a repository
  * Submit a copy of your source code to me using the **submit** tool.

To submit this program to me using the **submit** tool, run the following command at your lab46 prompt:

<cli>
$ submit cprog pnc1 primeodds.c primesqrt.c primesqrtodds.c primesqrtopt.c primesqrtoptodds.c
Submitting cprog project "pnc1":
    -> primeodds.c(OK)
    -> primesqrt.c(OK)
    -> primesqrtodds.c(OK)
    -> primesqrtopt.c(OK)
    -> primesqrtoptodds.c(OK)

SUCCESSFULLY SUBMITTED
</cli>

You should get some sort of confirmation indicating successful submission if all went according to plan. If not, check for typos and or locational mismatches.

What I will be looking for:

<code>
78:pnc1:final tally of results (78/78)
*:pnc1:submit all programs correctly named using submit tool [3/3]
*:pnc1:primeodds.c no negative compiler messages [2/2]
*:pnc1:primeodds.c implements only specified algorithm [4/4]
*:pnc1:primeodds.c adequate indentation and comments [3/3]
*:pnc1:primeodds.c output conforms to specifications [3/3]
*:pnc1:primeodds.c primerun runtime tests succeed [3/3]
*:pnc1:primesqrt.c no negative compiler messages [2/2]
*:pnc1:primesqrt.c implements only specified algorithm [4/4]
*:pnc1:primesqrt.c adequate indentation and comments [3/3]
*:pnc1:primesqrt.c output conforms to specifications [3/3]
*:pnc1:primesqrt.c primerun runtime tests succeed [3/3]
*:pnc1:primesqrtodds.c no negative compiler messages [2/2]
*:pnc1:primesqrtodds.c implements only specified algorithm [4/4]
*:pnc1:primesqrtodds.c adequate indentation and comments [3/3]
*:pnc1:primesqrtodds.c output conforms to specifications [3/3]
*:pnc1:primesqrtodds.c primerun runtime tests succeed [3/3]
*:pnc1:primesqrtopt.c no negative compiler messages [2/2]
*:pnc1:primesqrtopt.c implements only specified algorithm [4/4]
*:pnc1:primesqrtopt.c adequate indentation and comments [3/3]
*:pnc1:primesqrtopt.c output conforms to specifications [3/3]
*:pnc1:primesqrtopt.c primerun runtime tests succeed [3/3]
*:pnc1:primesqrtoptodds.c no negative compiler messages [2/2]
*:pnc1:primesqrtoptodds.c implements only specified algorithm [4/4]
*:pnc1:primesqrtoptodds.c adequate indentation and comments [3/3]
*:pnc1:primesqrtoptodds.c output conforms to specifications [3/3]
*:pnc1:primesqrtoptodds.c primerun runtime tests succeed [3/3]
</code>