From 24470f0c6ecb07866752361d24f3d752a7af22ed Mon Sep 17 00:00:00 2001 From: njones430 <87586432+njones430@users.noreply.github.com> Date: Thu, 15 Feb 2024 21:37:14 -0500 Subject: [PATCH] Update to README.md Edited README file to increase level of detail within table of contents and create sections for further information that are standard for other README files in open source projects --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/README.md b/README.md index 13b533a..dcda988 100644 --- a/README.md +++ b/README.md @@ -4,21 +4,75 @@ This is my (Eli Bradley's) computer science project, a Kotlin DSL focusing on va through school and just on my own. This includes: - [X] Vector Algebra + - [X] Included functions: Vector addition, subtraction, multiplication, division - [X] Multivariable Calculus - [X] Gradient Descent + - [X] Included functions: Descent line, isocline and next point calculation - [X] Basic Linear Algebra + - [X] Included functions: Addition, subtraction, multiplication, division for standard and matrixcalculations - [X] Electrostatic Simulations + - [X] Included functions: Graphical conversion, charge cluster calculation, in bounds calculation - [X] Analytic Transformations - [X] Taylor Series + - [X] Included functions: Factorial calculator, nth Derivative calculator, Maclaurin series calculator - [ ] Fourier Series and Transformations + - [X] Included functions: Quantum Fournier transformation - [X] Complex Algebra - [X] Complex Numbers + - [X] Included functions: Complex four function calculator, trigonometric functions, natural log, exponents - [X] Complex Vectors + - [X] Included functions: Extended complex vector calculation, conversion to char/double/float/int/long/short, double vector calculation - [X] Complex Matrices + - [X] Included functions: Square matrix, unitary matrix, vector matrices - [X] Quantum Computing - [X] Entangled Qubit States + - [X] Included functions: Combining and measuring qubit states - [X] Quantum Gates + - [X] Included functions: Qubit Communication Gates, Qubit Shift Gates - [X] Quantum Circuits - [X] Parallel Gates + - [X] Included functions: Combining and controlling parallel gates - [X] Sequential Gates + - [X] Included functions: Combining and controlling sequential gates - [X] Measuring + - [X] Included functions: Torque, acceleration, force calculations + +# Technical Specification + +Specific technical specifications for each of the functions avliable in the library are located in this section +- [X] Vector Algebra: +- [X] Multivariable Calculus + - [X] Gradient Descent: +- [X] Basic Linear Algebra: +- [X] Electrostatic Simulations: +- [X] Analytic Transformations: + - [X] Taylor Series: + - [ ] Fourier Series and Transformations: +- [X] Complex Algebra + - [X] Complex Numbers: + - [X] Complex Vectors: + - [X] Complex Matrices: +- [X] Quantum Computing + - [X] Entangled Qubit States: + - [X] Quantum Gates: + - [X] Quantum Circuits + - [X] Parallel Gates: + - [X] Sequential Gates: + - [X] Measuring: + +Reference images: + +# Installation + +Instructions for installing MathLibrary are located in this section. +Download link for Math library: + +# Contribution Policies + +Any rules or instructions for contributing to MathLibrary are located in this section. + +# Credits + +Credits for any future contributions to MathLibrary would go in this section. +Repository Support Information: +