Document the source code better for beginners

Author: brianobot

Diff for: operators/add_2_integers.c renamed to 00_operators/add_2_integers.c

@@ -15,7 +15,7 @@ int main(void)
     printf("Enter the second Integer:\n"); //prompt
     scanf("%d", &integer2); // read the second integer
 
-    int sum = integer1 + integer2; // assign total to sum
+    int sum = integer1 + integer2; // assign the value of the total expression to sum
     printf("Sum is %d\n", sum);
 
 }// end of the main function

Diff for: operators/arithmetic.c renamed to 00_operators/arithmetic.c

@@ -0,0 +1,26 @@
+#include <stdio.h>
+#include <stdlib.h>
+
+/**
+ * tets_function - function used to explain exit process of the exit standard function
+ * 
+ * Return: nothing
+ */
+void test_function(void)
+{
+    printf("Starting the execution of the test function ...\n");
+    exit(1); // optionally the constant provided by the standard library can be used as the argument to the exit function
+    // EXIT_SUCCESS and EXIT_FAILURE
+    printf("This line should never be reached because of the exit function above\n");
+}
+
+
+int main(void)
+{
+    printf("Starting the program execution with the main function \n");
+    printf("About to call the test function \n");
+
+    test_function();
+
+    return (0);
+}

Diff for: operators/bitwise.c renamed to 00_operators/bitwise.c

@@ -0,0 +1,50 @@
+#include <math.h>
+#include <stdio.h>
+
+int main(void)
+{
+
+    int number;
+    double power;
+    double square_root;
+    double cube_root;
+    double exponential;
+    double natural_log;
+    double logarithm;
+    double floating_abs;
+    double float_mod;
+    double sine;
+    double cosine;
+    double tangent;
+
+    printf("Please Enter a number: ");
+    scanf("%d", &number);
+
+    power = pow(number, 2.0);
+    square_root = sqrt(number);
+    cube_root = cbrt(number);
+    exponential = exp(number);
+    natural_log = log(number);
+    logarithm = log10(number);
+    floating_abs = fabs(number);
+    float_mod = fmod(number, 2.3);
+    sine = sin(number);
+    cosine = cos(number);
+    tangent = tan(number);
+
+    printf("The number entered is %d\n", number);
+    printf("it square is %.0f\n", power);
+    printf("it square root is %.2f\n", square_root);
+    printf("it Cube square root is %.2f\n", cube_root);
+    printf("it exponential is %.2f\n", exponential);
+    printf("it Natural log is %.2f\n", natural_log);
+    printf("it Logarithm is %.2f\n", logarithm);
+    printf("it Floating absolute value is %.2f\n", floating_abs);
+    printf("it Floating Mod of %d and %f is %.2f\n", number, 2.3, float_mod);
+    printf("it sine is %.2f\n", sine);
+    printf("it cosine is %.2f\n", cosine);
+    printf("it tangent is %.2f\n", tangent);
+
+
+    return (0);
+}

Diff for: operators/comma_operator.c renamed to 00_operators/comma_operator.c

@@ -0,0 +1,22 @@
+#include <stdio.h>
+#include <stdlib.h>
+
+int main(void)
+{
+    unsigned int i;
+
+    for (i = 1; i <= 20; ++i)
+    {
+        // pick random number from 1 to 6 and output it
+        printf("%10d", 1 + (rand() % 6));
+
+        // if counter is divisible by 5, begin new line of output
+        if (i % 5 == 0) 
+        {
+            puts("");
+        }    
+       
+    }
+
+    return (0);
+}

Diff for: operators/unary_operators.c renamed to 00_operators/unary_operators.c

@@ -0,0 +1,41 @@
+#include <stdio.h>
+#define SIZE 12
+
+
+int main(void)
+{
+    int array[SIZE] = {32, 56, 43, 43, 67, 564, 34, 65, 32, 56, 45};
+    int i;
+
+    // original array
+    for (i = 0; i < SIZE; ++i)
+    {
+        printf("%4d", array[i]);
+    }
+
+    puts("");
+
+    for (i = 0; i < SIZE; ++i) // loop over every array element from 0 to (SIZE - 1)
+    {
+        for (size_t pass = 0; pass < SIZE; ++pass)
+        {
+            if (array[pass] > array[pass + 1])
+            {
+                int hold = array[pass];
+                array[pass] = array[pass + 1];
+                array[pass + 1]  = hold;
+            }
+        }
+    }
+
+    puts("Data in ascending order \n");
+
+    for (size_t index = 0; index < SIZE; ++index)
+    {
+        printf("%4d", array[index]);
+    }
+
+    puts(" ");
+
+    return (0);
+}

Diff for: if statement/if_conditions.c renamed to 01_if statement/if_conditions.c

@@ -0,0 +1,8 @@
+#include <stdio.h>
+
+
+int main(void)
+{
+    
+    return (0);
+}

Diff for: if statement/if_else_block.c renamed to 01_if statement/if_else_block.c

@@ -0,0 +1,17 @@
+#include <stdio.h>
+#include <stdlib.h>
+
+int main(void)
+{
+    static int array[] = {12, 23, 54, 65, 23, 45, 65, 23, 54, 23, 56, 23, 66, 7, 23, 56, 23, 45, 6, 23, 56, 23, 56, 46};
+    // static arrays are created once when the program starts and are not destroyed when they are out of scope
+    // nevertheless the can not be accessed outside thier local scope except declared in the global scope
+    int i = 0;
+
+    printf("%s%10s\n", "Element", "Value");
+    for (i; i < (sizeof(array) / sizeof(int)); ++i)
+    {
+        printf("%7d%10d\n", i, array[i]);
+    }
+    return (0);
+}

Diff for: input_output/infinite_read_and_write.c renamed to 02_input_output/infinite_read_and_write.c

@@ -0,0 +1,36 @@
+#include <stdio.h>
+#include <stdlib.h>
+
+/**
+ * factorial - function to calculate the factorial of a given integer
+ * @x : integer argument 
+ *
+ * Return: factorial of the integer argument
+ */
+
+
+unsigned long long int factorial(unsigned int x);
+
+int main(void)
+{
+    unsigned int number;
+    unsigned int result;
+
+    printf("please a value to compute it factorial: ");
+    scanf("%u", &number);
+
+    result = factorial(number);
+    printf("The factorial of %d is %llu", number , result);
+
+    return (0);
+}
+
+
+unsigned long long int factorial(unsigned int x)
+{
+    if (x <= 1)
+    {
+        return x;
+    }
+    return x * factorial(x-1);
+}

Diff for: input_output/print_EOF.c renamed to 02_input_output/print_EOF.c

@@ -0,0 +1,26 @@
+#include <stdio.h>
+#include <stdlib.h>
+
+unsigned long long int fib(unsigned int number);
+
+int main(void)
+{
+    unsigned int x;
+    unsigned long long int result;
+
+    printf("Please enter a value to compute the fibonacci series for: ");
+    scanf("%u", &x);
+
+    result = fib(x);
+    printf("The fibonnaci of %d is %llu", x, result);
+
+    return (0);
+}
+
+unsigned long long int fib(unsigned int number)
+{
+    if (number == 1 || number == 0)
+        return number;
+    else
+        return fib(number - 1) + fib(number - 2);
+}

Diff for: switch statement/count_grades.c renamed to 03_switch statement/count_grades.c

@@ -0,0 +1,32 @@
+// a first program written in the C programming language
+#include <stdio.h> // every line starting with a # is called a preprocessor directives and would be explained later
+
+// lines starting with double forward lash are known as comments (single line comments),
+// they are completely ignore by the computer when the program is being compiled
+// they can be used to better explain some piece of code or make notes for other when the read your source code (source code 
+// refers to the file containig your program) it is also called source file
+
+/**  
+ * this are also comments, but they can span multiple lines and are called multi-line comments
+ * they are used when the information to be embedded in a comment is too long for a single line
+ *
+ */
+
+// the function 'main' begins program execution (every C program must have a main function i.e a function called 'main' )
+// functions are explained later on, but for now it's enough to know that every function follow this structure below
+// datatype function_name(list of arguments)
+int main(void) 
+{
+    printf("Welcome to C!\n"); // this is a function that displays the text "Welcome to C! on the screen"
+} // end of the main function
+
+
+// if you have installed a compiler on your personal computer, 
+// you can try this on the command line to compile the source code into a executeable program
+
+// $ gcc welcome.c -o welcome
+// after which you can run the 'welcome' program the command line to see the output
+// for windows users
+// > welcome.exe
+// for linux users
+// $ ./welcome

Diff for: Loops/compound_interest.c renamed to 04_loops/compound_interest.c

@@ -1,11 +1,21 @@
 # Learning C
 
 # Description
-this is repo contains structure and curated code snippets an well documented C source codes written to explain basic c programming concepts.
+This repository contains structured and curated code snippets an well documented C source codes written to explain basic c programming concepts. This is a memo of my journey learning and developing with the C programming language.
+
+The choice of the Repo curated structure is highly opinated, i structured them this way because intuitively it felt proper to learn in this progression, with subsequent concepts building more on previous ones. if you do intend to use this repo and or any of it content as a reference material, it is highly likely that the structure would not matter much to you,as you could just move into folders containing the concept you wish to look at. but for people looking to use it as learning material, following the assumed progression would better aid your learning process and progress. 
 
 ## Usage
 - Any and all code improvements are whole-heartedly accepted
 - The codes provided in this repo are under no restriction in terms of usage
 - Use the codes here wisely, as there were written by a budding c programmer
 - Any Attribution to the repo is also welcomed
 
+## NOTE:
+since most of the codes here were written as a result of learning and praticing with concepts and ideas in the c programming language ecosystem, some code are not so-efficient and may not be an appropriate option for practical applications and solutions.
+
+Constructive approach are welcomed to request edition and suggest changes to the code found in this repo. 
+
+## Maintainer
+Brian Obot <[email protected]>
+

Diff for: Loops/do_while.c renamed to 04_loops/do_while.c

@@ -0,0 +1,46 @@
+#include <stdio.h>
+#include <stdlib.h>
+#include <limits.h>
+
+/**
+ * malloc_checked - function to check a malloc call
+ * @b: first argument to the function
+ *
+ * Return: a pointer
+ */
+void *malloc_checked(unsigned int b)
+{
+    int *ptr;
+
+    ptr = malloc(b);
+
+    if (ptr == NULL)
+    {
+        free(ptr);
+        exit(98);
+    }
+
+    return (ptr);
+}
+
+int main(void)
+{
+    char *c;
+    int *i;
+    float *f;
+    double *d;
+
+    c = malloc_checked(sizeof(char) * 1024);
+    printf("%p\n", (void *)c);
+    i = malloc_checked(sizeof(int) * 402);
+    printf("%p\n", (void *)i);
+    f = malloc_checked(sizeof(float) * 100000000);
+    printf("%p\n", (void *)f);
+    d = malloc_checked(INT_MAX);
+    printf("%p\n", (void *)d);
+    free(c);
+    free(i);
+    free(f);
+    free(d);
+    return (0);
+}