Updated readme. Updated extention file

Author: OGaliy

MatrixCalculator/MatrixCalculator/MatrixExtention.cs

@@ -27,49 +27,49 @@ public static class MatrixExtention
         }
 
         /// <summary>
-        /// Calculates cofactor matrix.
+        /// Calculates determinant for double matrix.
         /// </summary>
-        /// <param name="rowIndex">Index of row element(starts from 0)</param>
-        /// <param name="columnIndex">Index of column element(starts from 0)</param>
         /// <param name="matrix">Input matrix</param>
-        /// <returns>Cofactor matrix</returns>
-        public static double[,] CofactorMatrix(this double[,] matrix, int rowIndex, int columnIndex)
+        /// <param name="row">Input row</param>
+        /// <returns>Determinant value</returns>
+        public static double Determinant(this double[,] matrix, int row)
         {
-            return MatrixCalculator.CalculateElementCofactor(rowIndex, columnIndex, matrix);
+            return MatrixDeterminantCalculator.CalculateDeterminant(row, matrix);
         }
 
         /// <summary>
-        /// Calculates cofactor matrix.
+        /// Calculates determinant for int matrix.
         /// </summary>
-        /// <param name="rowIndex">Index of row element(starts from 0)</param>
-        /// <param name="columnIndex">Index of column element(starts from 0)</param>
         /// <param name="matrix">Input matrix</param>
-        /// <returns>Cofactor matrix</returns>
-        public static int[,] CofactorMatrix(this int[,] matrix, int rowIndex, int columnIndex)
+        /// <param name="row">Input row</param>
+        /// <returns>Determinant value</returns>
+        public static int Determinant(this int[,] matrix, int row)
         {
-            return MatrixCalculator.CalculateElementCofactor(rowIndex, columnIndex, matrix);
+            return MatrixDeterminantCalculator.CalculateDeterminant(row, matrix);
         }
 
         /// <summary>
-        /// Calculates determinant for double matrix.
+        /// Calculates cofactor matrix.
         /// </summary>
+        /// <param name="rowIndex">Index of row element(starts from 0)</param>
+        /// <param name="columnIndex">Index of column element(starts from 0)</param>
         /// <param name="matrix">Input matrix</param>
-        /// <param name="row">Input row</param>
-        /// <returns>Determinant value</returns>
-        public static double Determinant(this double[,] matrix, int row)
+        /// <returns>Cofactor matrix</returns>
+        public static double[,] ElementCofactor(this double[,] matrix, int rowIndex, int columnIndex)
         {
-            return MatrixDeterminantCalculator.CalculateDeterminant(row, matrix);
+            return MatrixCalculator.CalculateElementCofactor(rowIndex, columnIndex, matrix);
         }
 
         /// <summary>
-        /// Calculates determinant for int matrix.
+        /// Calculates cofactor matrix.
         /// </summary>
+        /// <param name="rowIndex">Index of row element(starts from 0)</param>
+        /// <param name="columnIndex">Index of column element(starts from 0)</param>
         /// <param name="matrix">Input matrix</param>
-        /// <param name="row">Input row</param>
-        /// <returns>Determinant value</returns>
-        public static int Determinant(this int[,] matrix, int row)
+        /// <returns>Cofactor matrix</returns>
+        public static int[,] ElementCofactor(this int[,] matrix, int rowIndex, int columnIndex)
         {
-            return MatrixDeterminantCalculator.CalculateDeterminant(row, matrix);
+            return MatrixCalculator.CalculateElementCofactor(rowIndex, columnIndex, matrix);
         }
 
         /// <summary>
@@ -92,15 +92,37 @@ public static int Determinant(this int[,] matrix, int row)
             return InvertMatrixCalculator.CalculateInvertMatrix(matrix);
         }
 
+        /// <summary>
+        /// Multiplies double matrix to matrix.
+        /// </summary>
+        /// <param name="a">First matrix</param>
+        /// <param name="b">Secont matrix</param>
+        /// <returns>Result of multiply</returns>
+        public static double[,] Multiply(this double[,] a, double[,] b)
+        {
+            return MultiplyMatrixCalculator.Multiply(a, b);
+        }
+
+        /// <summary>
+        /// Multiplies int matrix to matrix.
+        /// </summary>
+        /// <param name="a">First matrix</param>
+        /// <param name="b">Secont matrix</param>
+        /// <returns>Result of multiply</returns>
+        public static int[,] Multiply(this int[,] a, int[,] b)
+        {
+            return MultiplyMatrixCalculator.Multiply(a, b);
+        }
+
         /// <summary>
         /// Multiplies double matrix to number.
         /// </summary>
         /// <param name="number">Number for multiply</param>
         /// <param name="matrix">Input matrix</param>
         /// <returns>Result of multiply</returns>
-        public static double[,] Multiply(this double[,] a, double[,] b)
+        public static double[,] MultiplyToNumber(this double[,] matrix, double number)
         {
-            return MultiplyMatrixCalculator.Multiply(a, b);
+            return MultiplyMatrixCalculator.MultiplyToNumber(number, matrix);
         }
 
         /// <summary>
@@ -109,9 +131,9 @@ public static int Determinant(this int[,] matrix, int row)
         /// <param name="number">Number for multiply</param>
         /// <param name="matrix">Input matrix</param>
         /// <returns>Result of multiply</returns>
-        public static int[,] Multiply(this int[,] a, int[,] b)
+        public static int[,] MultiplyToNumber(this int[,] matrix, int number)
         {
-            return MultiplyMatrixCalculator.Multiply(a, b);
+            return MultiplyMatrixCalculator.MultiplyToNumber(number, matrix);
         }
 
         public static double[,] Round(this double[,] matrix, int number)

README.md

@@ -1 +1,107 @@
-# Matrix Calculator
+<p align="center">
+  <h2>A&A</h2>
+</p>
+<p align="center">
+## Matrix Calculator
+</p>
+
+## What鈥檚 In This Document
+
+- [How to connect in your app](#-how-to-connect-in-your-app)
+- [How to use in code](#-how-to-use-in-code)
+- [Code examples](#-code-examples)
+
+## How to connect in your app
+
+1. Download as zip.
+2. Open and build solution.
+3. In your project add reference to **MatrixCalculateLibrary.dll**
+
+## How to use in code
+
+**Add using to list**
+
+	```using MatrixCalculateLibrary;```
+	
+## Code examples
+
+**Create matrix(array)**
+
+	```double[,] A = new double[3, 3]
+		{
+			{ 3, 0, 2 },
+			{ 2, 0, -2 },
+			{ 0, 1, 1 }
+		};
+		double[,] B = new double[3, 3]
+		{
+			{ 3, -1, 2 },
+            { 1, 0, 3 },
+            { 2, -1, 0 }
+		};```
+		
+In examples we will use the A and the B matrixies.
+
+**Matrix sum**
+
+	```var result = BasicMatrixArithmetic.Add(a, b);```
+	
+	or
+	
+	```var result = A.Add(B);```
+
+**Matrix subtract**
+
+	```var result = BasicMatrixArithmetic.Subtract(a, b);```
+	
+	or
+	
+	```var result = A.Subtract(B);```
+		
+**Matrix inverting**
+
+	```var result = InvertMatrixCalculator.CalculateInvertMatrix(A);```
+	
+	or
+	
+	```var result = A.Invert();```
+	
+**Matrix element cofactor**
+
+	```var result = MatrixCalculator.CalculateElementCofactor(0, 0, A);```
+	
+	or
+	
+	```var result = A.ElementCofactor(0, 0);```
+	
+**Matrix transpose**
+
+	```var result = MatrixCalculator.CalculateTransposeMatrix(A);```
+	
+	or
+	
+	```var result = A.TransposeMatrix();```
+	
+**Matrix determinant**
+
+	```var result = MatrixDeterminantCalculator.CalculateDeterminant(0, A);```
+	
+	or
+	
+	```var result = A.Determinant(0);```
+	
+**Matrix multiply**
+
+	```var result = MultiplyMatrixCalculator.Multiply(A, B);```
+	
+	or
+	
+	```var result = A.Multiply(B);```
+
+**Matrix multiply on number**
+
+	```var result = MultiplyMatrixCalculator.MultiplyToNumber(A, B);```
+	
+	or
+	
+	```var result = A.MultiplyToNumber(5);```