Neaten C++ and MATLAB tutorials

Author: methylDragon

C++/02 C++ - Functions and File IO.md

@@ -1,4 +1,4 @@
-# Functional C++ Crash Course
+# Function C++ Crash Course
 
 Author: methylDragon  
 Contains a syntax reference for C++  
@@ -15,28 +15,22 @@ I'll be adapting it from the ever amazing Derek Banas: https://www.youtube.com/w
 - Linux (**Terminal/Console proficiency**) (We're going to need to compile our stuff)
 - Gone through the all preceding parts of the tutorial
 
-
-
 ## Table Of Contents <a name="top"></a>
 
 1. [Introduction](#1)  
-2. [Functional C++ Syntax Reference](#2)    
+2. [Function C++ Syntax Reference](#2)    
    2.1   [Functions](#2.1)    
    2.2   [Function Overloading](#2.2)    
    2.3   [Recursive Functions](#2.3)    
    2.4   [File I/O](#2.4)    
    2.5   [Lambda Functions](#2.5)    
    2.6   [Inline Functions](#2.6)    
 
-
-
 ## 1. Introduction <a name="1"></a>
 
 We've gone through the basics of C++. Now let's throw in some functions and file interactions!
 
-
-
-## 2. Functional C++ Syntax Reference <a name="2"></a>
+## 2. Function C++ Syntax Reference <a name="2"></a>
 
 ### 2.1 Functions <a name="2.1"></a>
 
@@ -51,10 +45,10 @@ firstNum and secondNum are attributes. We set secondNum's default value if no va
 
 ```c++
 int addNumbers(int firstNum, int secondNum = 0) {
-	int combinedValue = firstNum + secondNum;
-	
-	return combinedValue;
-	
+    int combinedValue = firstNum + secondNum;
+
+    return combinedValue;
+
 }
 ```
 
@@ -72,14 +66,12 @@ addNumbers(1, 2); // It'll return 3
 ```
 
 > **Note:**
->
+> 
 > - When you write the data-type infront of the function name, you're defining a new function **prototype**
 > - If you don't, you're calling it.
->
+> 
 > Remember the distinction! 
 
-
-
 #### **Returning arrays**
 
 Read more + code source: https://www.geeksforgeeks.org/return-local-array-c-function/
@@ -99,10 +91,10 @@ int *fun()
 
    arr[0] = 10;
    arr[1] = 20;
-    
+
    return arr; // Return the pointer to the array!
 }
- 
+
 int main()
 {
     int *ptr = fun();
@@ -122,10 +114,10 @@ int *fun()
 
    arr[0] = 10;
    arr[1] = 20;
-    
+
    return arr; // Return the pointer to the array!
 }
- 
+
 int main()
 {
     int *ptr = fun();
@@ -141,17 +133,17 @@ struct arrWrap
 {
    int arr[100];
 };
- 
+
 struct arrWrap fun() // Function returns the struct
 {
    struct arrWrap x;
- 
+
    x.arr[0] = 10;
    x.arr[1] = 20;
-    
+
    return x;
 }
- 
+
 int main()
 {
    struct arrWrap x = fun();
@@ -160,8 +152,6 @@ int main()
 }
 ```
 
-
-
 ### 2.2 Function Overloading <a name="2.2"></a>
 
 [go to top](#top)
@@ -186,8 +176,6 @@ void sameFunction(int a, float b){
 
 Functions can have the same name, but do DIFFERENT THINGS depending on what gets passed to them!
 
-
-
 ### 2.3 Recursive Functions <a name="2.3"></a>
 
 [go to top](#top)
@@ -196,21 +184,19 @@ These are functions that call THEMSELVES. Trippy.
 
 ```c++
 int getFactorial(int number){
-	int sum;
-	if(number == 1)
-		sum = 1; //Yeah you can do this
-	else
-		sum = getFactorial(number - 1) * number;
-	return sum;
+    int sum;
+    if(number == 1)
+        sum = 1; //Yeah you can do this
+    else
+        sum = getFactorial(number - 1) * number;
+    return sum;
 )
 ```
 
 This function returns the factorial of itself, and it keeps calling itself which results in it calling itself until it stops, then it resolves one by one till all are resolved.
 
 The last function calls to go on the stack are resolved first! USE THE STACK! Play some Magic!
 
-
-
 ### 2.4 File I/O <a name="2.4"></a>
 
 [go to top](#top)
@@ -226,13 +212,13 @@ ofstream writer("dragonQuote.txt");  //Open a .txt file called dragonQuote, this
 
 if(! writer) { //Check to see if the filestream is open
 
-	cout << "Error opening file" << endl;
-	return -1; // Return -1 if failed
+    cout << "Error opening file" << endl;
+    return -1; // Return -1 if failed
 
 } else {
 
-	writer << dragonQuote << endl; // Write dragonQuote to writer, which causes dragonQuote.txt to contain only dragonQuote 
-	writer.close(); // Close the file
+    writer << dragonQuote << endl; // Write dragonQuote to writer, which causes dragonQuote.txt to contain only dragonQuote 
+    writer.close(); // Close the file
 
 }
 
@@ -246,41 +232,39 @@ ofstream writer2("dragonQuote.txt", ios::app); //Create a writer object that app
 
 if(! writer2) { //Check to see if the filestream is open
 
-	cout << "Error opening file" << endl;
-	return -1; // Return -1 if failed
+    cout << "Error opening file" << endl;
+    return -1; // Return -1 if failed
 
 } else {
 
-	writer2 << "\n -methylDragon" << endl; // Append  "\n -methylDragon" 
-	writer2.close(); // Close the file
+    writer2 << "\n -methylDragon" << endl; // Append  "\n -methylDragon" 
+    writer2.close(); // Close the file
 
 }
 
 {
-	char letter;
-	
-	ifstream reader("dragonQuote.txt"); // Open an input filestream that reads dragonQuote.txt
-	
-	if(! reader){
-		
-		cout << "Error opening file" << endl;
-		return -1;
-		
-	} else {
-		
-		for(int i = 0; ! reader.eof(); i++) { // Read until end of file
-			reader.get(letter); // Get the next letter
-			cout << letter; // And print it
-		}
-	
-	}
-	
-	cout << endl;
-	reader.close();
-}
-```
+    char letter;
+
+    ifstream reader("dragonQuote.txt"); // Open an input filestream that reads dragonQuote.txt
+
+    if(! reader){
+
+        cout << "Error opening file" << endl;
+        return -1;
+
+    } else {
 
+        for(int i = 0; ! reader.eof(); i++) { // Read until end of file
+            reader.get(letter); // Get the next letter
+            cout << letter; // And print it
+        }
 
+    }
+
+    cout << endl;
+    reader.close();
+}
+```
 
 ### 2.5 Lambda Functions <a name="2.5"></a>
 
@@ -419,8 +403,6 @@ auto y = [&r = x, x = x+1]()->int {
          }();  // Updates x to 6, and initializes y to 7.
 ```
 
-
-
 ### 2.6 Inline Functions <a name="2.6"></a>
 
 Inline functions help to avoid the overhead of function calls. When you compile the code, the entire call to an inline function is instead replaced with the code inside the function call itself.
@@ -458,15 +440,13 @@ class S
 public: 
     int square(int s); // declare the function 
 }; 
-  
+
 inline int S::square(int s) // use inline prefix 
 { 
-  
+
 }
 ```
 
-
-
 ```
                             .     .
                          .  |\-^-/|  .    

MATLAB/MATLAB Crash Course.md

@@ -12,8 +12,6 @@ I'll be adapting it from the ever amazing Derek Banas: https://www.youtube.com/w
 
 - Systems
 
-
-
 ## 1. Introduction
 
 MATLAB stands for Matrix Laboratory. It's a very famous program used for working with matrices.
@@ -33,8 +31,6 @@ If you ever need to ask for help, either Google for it, or use the `help` functi
 help <function>
 ```
 
-
-
 ## 2. Command Line Interface
 
 ### 2.1  Path
@@ -43,8 +39,6 @@ Be sure to ensure that all scripts you want to write are in MATLAB **Path**, in
 
 In the file explorer on the left, you may add folders and subfolders to your path by right clicking and selecting `Add To Path`. Alternatively, you may double click on a folder to focus it and add it to Path, since your Path also includes your current focused folder!
 
-
-
 ### 2.2 Clearing Data
 
 ```matlab
@@ -57,33 +51,25 @@ clear all % Clear everything
 clear <variable> % Clear single variable
 ```
 
-
-
 ### 2.3 Configure Output
 
 ```matlab
 format compact % Keeps output compact!
 ```
 
-
-
 ### 2.4 Stop Execution
 
 Use `CTRL-c` to stop executing a particular command!
 
-
-
 ### 2.5 Precision
 
 Precision is set to 15 digits by default. But you can configure that!
 
-
-
-## 3. Basic MATLAB Syntax Reference <a name="2"></a>
+## 3. Basic MATLAB Syntax Reference
 
 Click on New Script to start creating a new script!
 
-### 3.1 Comments <a name="2.1"></a>
+### 3.1 Comments
 
 [go to top](#top)
 
@@ -99,8 +85,6 @@ Click on New Script to start creating a new script!
 
 You can also use `CTRL-r` to comment and `CTRL-t` to uncomment!
 
-
-
 ### 3.2 Variables
 
 Everything is a `double` by default in MATLAB.
@@ -148,8 +132,6 @@ realmax
 realmax('single')
 ```
 
-
-
 ### 3.3 Basic Operations
 
 I really shouldn't need to explain this... You can use MATLAB like a calculator, and the results can go into variables!
@@ -167,8 +149,6 @@ mod(5, 4) % Mod (get remainder)
 % NOTE! MATLAB doesn't have increment and decrement operators. So you can't do stuff like a++, b--, etc.
 ```
 
-
-
 ### 3.4 Casting
 
 ```matlab
@@ -178,8 +158,6 @@ v3 = int8(v2) % Like so!
 
 Just write the appropriate class identifier and use it like a function!
 
-
-
 ### 3.5 Printing and Displaying
 
 ```matlab
@@ -194,8 +172,6 @@ sprintf('5 + 4 = %d\n', 5 + 4)
 % With the %d here, it transplants the next variable argument into the string!
 ```
 
-
-
 ### 3.6 User Input
 
 Using the `;` suppresses the input printout after the user has entered the input!
@@ -222,8 +198,6 @@ vInput = input('Enter a vector : ');
 disp(vInput)
 ```
 
-
-
 ### 3.7 Useful Math Functions
 
 `help elfun` for a whole list of math functions
@@ -243,8 +217,6 @@ deg2rad(90)
 rad2deg(3.14)
 ```
 
-
-
 ### 3.8 Conditionals
 
 ```matlab
@@ -287,8 +259,6 @@ switch score
 end % REMEMBER TO END
 ```
 
-
-
 ### 3.9 Vectors
 
 They're one dimensional rows or columns!
@@ -331,8 +301,6 @@ a * b
 % 4 8 2
 ```
 
-
-
 ### 3.10 Vector Methods
 
 ```matlab
@@ -363,8 +331,6 @@ linspace(1, 20, 4) % Generates 4 numbers equally spaced between 1 and 20
 logspace(1, 3, 3) % Like linspace, but the spacing is logarithmic
 ```
 
-
-
 ### 3.11 Matrices
 
 It's MATLAB, not Vector lab.
@@ -402,8 +368,6 @@ a - b
 a + b
 ```
 
-
-
 ### 3.12 Matrix Methods
 
 The list is not exhaustive!
@@ -459,8 +423,6 @@ repmat(a, 2, 1) % Duplicate matrix into new matrix. Eg. If original matrix was 3
 repelem(m3, 2, 1) % Duplicates ELEMENTS, so in this case, each element is duplicated twice in terms of the row
 ```
 
-
-
 ### 3.13 For Loops
 
 For loops! It's pretty Pythonic. It iterates through a range.
@@ -488,8 +450,6 @@ for i = 1:length(b)
 end
 ```
 
-
-
 ### 3.14 While Loops
 
 ```matlab
@@ -501,16 +461,14 @@ while i < 20
         i = i + 1; % Semicolon suppresses the print
         continue
     end % This end is for i
-    
+
     i = i + 1;
     if i >= 10
         break
     end
 end
 ```
 
-
-
 ### 3.15 Cell Arrays
 
 You can store data of multiple types
@@ -533,8 +491,6 @@ a = ['A', 'BB', 'CCC']
 char_array = cellstr(a)
 ```
 
-
-
 ### 3.16 Strings
 
 Strings are vectors of characters!
@@ -587,8 +543,6 @@ lower(str)
 upper(str)
 ```
 
-
-
 ### 3.17 Structures
 
 Custom data types! Think C++ structs! Or Python dictionaries/maps.
@@ -615,8 +569,6 @@ fieldnames(methyl_struct)
 a(1) = methyl_struct
 ```
 
-
-
 ### 3.18 Tables
 
 Tables are labelled rows of data in a table format
@@ -644,8 +596,6 @@ test_table({'A', 'B'}, :) % This defaults to using the RowName as indexer
 a(ismember(test_table.b, {29, 42},:)
 ```
 
-
-
 ### 3.19 File IO
 
 ```matlab
@@ -666,8 +616,6 @@ a = 123
 save -append params a % This appends to the normal variable
 ```
 
-
-
 ### 3.20 Eval
 
 If you know Python you should know what this does already.
@@ -680,8 +628,6 @@ eval(toExecute) % Executes it as:
 % total = 5 + 4
 ```
 
-
-
 ### 3.21 Pausing
 
 You can pause in MATLAB too! Think of it like Arduino `delay()` or Python `time.sleep()`
@@ -693,8 +639,6 @@ pause off % Disable pause
 pause on % Enable pause
 ```
 
-
-
 ## 4. Functional and OOP MATLAB
 
 ### 4.1 Functions
@@ -742,8 +686,6 @@ function [varargout] = getNumbers(howMany)
 end
 ```
 
-
-
 ### 4.2 Anonymous Functions
 
 No named functions! Think lambda in python
@@ -782,8 +724,6 @@ function func = doMath2(num)
 end
 ```
 
-
-
 ### 4.3 Recursive Functions
 
 They call themselves!
@@ -798,8 +738,6 @@ end
 end
 ```
 
-
-
 ### 4.4 Classes
 
 Static members are shared amongst all members of a class
@@ -810,7 +748,7 @@ classdef Shape
         height
         width
     end
-    
+
     methods(Static)
         function out = setGetNumShapes(data)
             % Persistent values are shared by all objects also
@@ -824,7 +762,7 @@ classdef Shape
             out = Var;
         end
     end
-        
+
     methods
         % Define a constructor
         function obj = Shape(height, width)
@@ -863,8 +801,6 @@ Shape.setGetNumShapes
 a1 > a2
 ```
 
-
-
 ### 4.5 Class Inheritance
 
 ```matlab
@@ -873,7 +809,7 @@ classdef Trapezoid < Shape % Trapezoid inherits from Shape
     properties
         width2
     end
-    
+
     methods
         function obj = Trapezoid(height, width, width2)
             obj@Shape(height,width) % The @ sign means you're taking it from the parent
@@ -898,8 +834,6 @@ disp(a3)
 a3.getArea
 ```
 
-
-
 ## 5. Plotting
 
 ### 5.1 Plotting in MATLAB
@@ -946,8 +880,6 @@ clf % Delete all figures
 y = A.*cos(2*pi .* t/T - 2*pi .* x/lambda + phi0);
 ```
 
-
-
 ### 5.2 3D Plotting in MATLAB
 
 #### **3D Plots and Meshgrids**
@@ -986,8 +918,6 @@ quiver3() % 3D
 colorbar % Add a colorbar!
 ```
 
-
-
 ## 6. Intermediate and Advanced Math
 
 ### 6.1 Vector Calculus
@@ -999,18 +929,14 @@ curl()
 del2() % Discrete laplacian
 ```
 
-
-
 ```
                             .     .
                          .  |\-^-/|  .    
                         /| } O.=.O { |\
-
 ```
 
 ​    
 
 ------
 
  [![Yeah! Buy the DRAGON a COFFEE!](./assets/COFFEE%20BUTTON%20%E3%83%BE(%C2%B0%E2%88%87%C2%B0%5E).png)](https://www.buymeacoffee.com/methylDragon)
-