<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>

======Project: MENTAL MATH - ALL FROM NINE (afn0)======

=====Objective=====
To implement a programmatic solution (ie simulation) of a real life process- the mental math trick of subtracting certain potentially large numbers from left to right.

=====Prerequisites/Corequisites=====
In addition to the new skills required on previous projects, to successfully accomplish/perform this project, the listed resources/experiences need to be consulted/achieved:

  * can perform this trick in your head/by hand (if you can't do it on your own, you have no business trying to tell the computer how to do it)
  * understand the pattern/process to doing it for any length number (2-digit through 18-digit)
  * ability to deploy loops to simplify your process
  * ability to use arrays to facilitate the storage of your processed values
  * use of functions to modularize your code

=====Scope=====
The allure of using (and learning) a programming language is to be able to effectively use it to solve problems, which in and of themselves are simulations of some process we can do in "the real world".

In this case, we will be writing a program which will implement the mental math techniques for subtracting certain numbers from left to right-- seemingly against the grain from everything we've been taught.

=====Background=====
This trick's full name is "All from Nine, the Last from Ten", and refers to a central detail of the process we will be undertaking.

For starters, let us try it out:

<code>
 1000
- 941
 ====
  059 
</code>

The thing is, we aren't going to be solving this the usual way. We're going to do it from left to right. So, a walkthrough of what just happened:

  * We start with the left-most digit to digit subtraction (the 0 - 9). As this isn't the last (right-most) subtraction, our key value is 9 (all from 9). So: how much to add to 9 to get 9? **0**. That's our answer for that place.
  * Move one place to the right (0 - 4)... how much to add to 4 to get 9? **5**. Bam.
  * Move one place to the right-- we're now at the last digit. And last is from 10. So, how much to add to 1 to get 10? **9**.
  * We see our answer is **059**. 

Clearly, there are some prerequisites that need to be met in order to use this trick:

  * the top number needs to be 1 followed by all zeros (the zeros is key).
  * the number we're subtracting is smaller than the number we're subtracting from.

Try your hand at another:

<code>
 1000000000000000
- 928573956013453
 ================
</code>

Go ahead and try it (work it out on paper).

The answer is: **071426043986547**


=====Task=====
The task at hand can benefit from loop and array assistance.

For instance, taking the number input and processing it so each digit occupies its own array element would facilitate your efforts in the overall task.
=====Functions=====

Specifically, we will look at modularizing aspects of our solution, using functions, to make for a cleaner, more organized codebase.

We've been using functions all along (everytime you use **fprintf()** or **fscanf()**, for instance), but the value is not just in using pre-existing ones, but also in making our own to use.

====Function prototype====
Like variables, functions need to be declared.

We can declare them at various scopes (file/global, block/local)... if you wish for the function to be accessible by all functions within a program, you will want to declare it with a global scope.

If a particular function is only to be used by a specific function, and no others, you can opt to declare it local scope (ie within the function that will be calling it).

A function is basically a module or subroutine. It is a mini-program, focusing on the performing of a particular process.

Like a program, it takes input, does processing, and provides output.

Unlike a program, its input may not come from the keyboard, but instead from particular variables, and may not send output to the screen, but instead channel output in a way that it can be stored into a variable.

This distinctions aside, a function can in many ways be viewed as a micro- or sub-program/routine. We use functions to assist us in making our code more readable/organized/navigable.

Keeping everything in ONE file, ONE big function in that one file, is rather monolithic. In time, with sufficiently large programs, such an arrangement would become a tad unwieldy. So functions help to keep our focus short yet attentive.

To create a function we must first declare (or prototype) it. This needs to happen BEFORE said function is ever used (just as with variables- you must declare a variable before it is first used, otherwise the compiler yells).

A function, in many ways, is like a programmable variable (or is a variable with programming attached).

As such, it has a return value of a type (the function's output), a name, and parameters (input).

We see this with main()... here are two variations of a **main()** function declaration (technically also the start of the definition as well, in the case of **main()**):

===Parameterless function===

<code c>
int main()
</code>

In this example, we see the declaration of main() where it has a return value of **int**, meaning, upon completion, main() will return a value corresponding with an int data type (also in main()'s case, being the first function run, we tend to return a status code to the operating system-- 0 for success, non-zero for some sort of error or deferred success).

main(), in this case, takes no parameters (just an empty set of parenthesis)... due to this, we refer to this function as a parameterless function. A function without parameters. Without input.

Now: this is technically a different form of input and output than you are used to. Input doesn't ALWAYS have to come from the keyboard, nor does output ALWAYS have to go to the screen. Input instead is desired informating being acquired for the process at hand, and output is the byproduct of performing the operation. Sometimes this means keyboard input and screen output- but not always.

Additionally, with or without parameters, we can always perform additional input (and output) within a given function, through the use of various input and output methods (like **fprintf()/fscanf()**).

===Parametered function===

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

In this case, our **main()** function actually takes parameters- two, in fact:

  - an integer, we are calling **argc**
  - a double pointer, we are calling **argv**

This function takes two parameters, two pieces of input, available to us in the form of variables, by those names, of those types. We make use of them as we need to in accomplishing the program at hand.

So, when we wish to create functions of our own, we need:

  * the return type
  * the function name
  * 0 or more parameters, identifying their order and type

For example, let us make a sum() function. Here would be a likely prototype (we'd place it above main()):

<code>
int sum(int *, int);
</code>

A function prototype (vs. its definition) will have a terminating semi-colon, as you see above.

In our case, our sum() function has the following:

  * a return type of **int** (particular variable name doesn't matter, type does)
  * the function's name (sum)
  * a comma-separated list of types corresponding to the parameters (again, variable names do not matter, but the type is important).

Our sum() function will take an integer array (denoted by the int pointer above), and a size (the second, regular int).

Now, parameter order very much matters. In our case, an "int *" came first, followed by an "int"... we need to be mindful of this order to successfully call and use the function.

====Function definition====
While a function prototype is technically optional (you can put the definition in place of the prototype-- we just often use prototypes to further allow organization), we MUST have a function definition. This is nothing short of the code that dictates what operations the function in question will perform.

Our sum() function will be defined (below the main() function) as follows:

<code c>
int sum(int *array, int size)
{
    int result = 0;
    int i = 0;
    
    for (i = 0; i < size; i++)
        result = result + array[i];
        
    return(result);
}
</code>

====function calling====
Once we've declared (prototyped) and defined our function, now all we have to do is use it! When you make use of a function, we refer to it as //calling//. We call the function, by name, providing and required parameters, and capturing any return value as we see fit.

Here would be an example of calling the above-mentioned **sum()** function:

<code c>
int scores[4];
int tally = 0;

scores[0] = 88;
scores[1] = 47;
scores[2] = 96;
scores[3] = 73;

tally = sum(scores, 4);
</code>

Note, that it is rather important to match the type and order of parameters. Due to the nature of the array (especially the form of array declaration) used, certain pointer-related details are being hidden from us, giving somewhat of a false impression. Further discussion about pointers will begin to shed light on that.


=====Program=====
It is your task to write a program that obtains a long integer value from the user, and processes that single value into separate array elements (one digit per array element). Determining the number of digits, you are to perform this "all from nine, last from ten" subtraction method on the number using array transactions, displaying a visual representation of the problem being solved to STDOUT.

Your program should:
  * obtain its input from STDIN.
    * input should be in the form of a single (long) long integer value (you want a 64-bit data type)
  * determine the number of digits of the inputted value (store this in a variable)
  * process that input long integer into separate array elements- one digit per element.
    * you may assume a maximum array size of the maximum number of digits you're theoretically able to input that can be stored in a 64-bit value.
  * perform the "all from nine, the last from ten" operation on the array, storing the result in another array.
  * display the problem being solved, along with the answer
  * use functions to modularize your code:
    * have an **longint2array()** function that takes the long int, and returns an array (the function itself handles the processing of splitting up the long int into individual digits).
    * have a **printarray()** function, whose responsibility it is to display the indicated array to STDOUT.
    * have a **allfromnine()** function that takes the source array, does the processing, and returns ther result array.

I might suggest the following function prototypes:

<code c>
unsigned char *longint2array(unsigned long int);
void printarray(unsigned char *, unsigned char);
unsigned char *allfromnine(unsigned char *);
</code>

Some questions to contemplate:

  * Why an array of unsigned chars when we're starting with a long (long) int?
    * Why is that the "best fit" size-wise?
    * Why will that not result in lost data?
  * Why unsigned?
    * What impact will that have on our input value's upper bound?
  * Why represent the size of the usable array as an unsigned char?
    * Why is this the "best fit" size-wise?
=====Execution=====
An example of your program in action:

<cli>
lab46:~/src/cprog/afn0$ ./afn0
Enter value: 31415926535897
Digits detected: 14

 100000000000000
- 31415926535897
 ---------------
  68584073464103

lab46:~/src/cprog/afn0$ 
</cli>

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

  * Code must compile cleanly (no warnings or errors)
    * Use the **-Wall** and **<nowiki>--</nowiki>std=gnu99** flags when compiling.
  * Output must be correct, and resemble 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 presented above
  * Code must be commented
    * have a properly filled-out comment banner at the top
    * have at least 20% of your program consist of **<nowiki>//</nowiki>**-style descriptive comments
  * 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 afn0 afn0.c
Submitting cprog project "afn0":
    -> afn0.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.

=====Evaluation Criteria=====

What I will be looking for:

<code>
78:afn0:final tally of results (78/78)
*:afn0:afn0.c compiles cleanly, no compiler messages [13/13]
*:afn0:afn0.c implements only specified algorithm [13/13]
*:afn0:afn0.c code conforms to project specifications [13/13]
*:afn0:afn0.c code committed and pushed to repository [13/13]
*:afn0:afn0 runtime output conforms to specifications [26/26]
</code>

Additionally:
  * Solutions not abiding by spirit of project will be subject to a 25% overall deduction
  * Solutions not utilizing descriptive why and how comments will be subject to a 25% overall deduction
  * Solutions not utilizing indentation to promote scope and clarity will be subject to a 25% overall deduction
  * Solutions not organized and easy to read (assume a terminal at least 90 characters wide, 40 characters tall) are subject to a 25% overall deduction