Added documentation for Oasis

.gitignore

@@ -48,6 +48,8 @@ latex
 # *.iml
 # *.ipr
 
+
+build
 # CMake
 cmake-build-*/
 
@@ -100,7 +102,8 @@ fabric.properties
 .LSOverride
 
 # Icon must end with two \r
-Icon
+Icon
+
 
 # Thumbnails
 ._*

HowToUseOASIS.txt

@@ -0,0 +1,38 @@
+Calculate Derivative:
+
+To calculate the derivative of an expression using OASIS, use the following input
+
+dd(EXPRESSION_YOU_WANT_TO_DIFFERENTIATE, VARIABLE_WITH_RESPECT_TO_DIFFERENTIATE)
+
+examples:
+
+dd(2x, x) -> 2
+dd(4a^2, a) -> 8a
+dd(2x^y, x) -> 0
+
+Calculate Integral:
+
+To calculate the Integral of an expression using OASIS, use the following input
+
+in(EXPRESSION_YOU_WANT_TO_INTEGRATE, VARIABLE_WITH_RESPECT_TO_INTEGRATE)
+
+examples:
+in(2x, x) -> x^2 + C
+in(4a^2, a) -> (4/3)a^3 + C
+in(2x^y, x) -> SHOULD BE (2x^(y+1))/(y+1), as of right now returns incorrect result
+
+Build Logarithm:
+
+To build a logarithmic expression, use the following input
+
+log(EXPRESSION_TO_USE_AS_BASE, EXPRESSION_TO_USE_AS_ARGUMENT)
+
+examples:
+
+log(2, 3) -> 1.585
+log(10, x) -> log10(x)
+log(x, y) -> logx(y)
+
+
+
+

bindings/js/src/bindings.cpp

@@ -1,6 +1,6 @@
-//
-// Created by Matthew McCall on 3/10/25.
-//
+/**
+ * Created by Matthew McCall on 3/10/25.
+ */
 #include <emscripten/bind.h>
 
 #include "Oasis/Expression.hpp"

cli/main.cpp

@@ -1,6 +1,6 @@
-//
-// Created by Matthew McCall on 2/19/25.
-//
+/**
+ * Created by Matthew McCall on 2/19/25.
+ */
 
 #include <cctype>
 #include <cstdio>
@@ -20,7 +20,9 @@ auto operator|(const std::string& str, FnT fn) -> boost::callable_traits::return
     return fn(str);
 }
 
-// https://en.cppreference.com/w/cpp/string/byte/isspace#Notes
+/**
+ * https://en.cppreference.com/w/cpp/string/byte/isspace#Notes
+ */
 bool safe_isspace(const unsigned char ch) { return std::isspace(ch); }
 
 auto trim_whitespace(const std::string& str) -> std::string
@@ -33,7 +35,9 @@ auto trim_whitespace(const std::string& str) -> std::string
         | std::ranges::to<std::string>();
 }
 
-// Calling Oasis::FromInFix passed as template fails because defaulted parameters aren't represented in the type, so a wrapper is needed
+/**
+ * Calling Oasis::FromInFix passed as template fails because defaulted parameters aren't represented in the type, so a wrapper is needed
+ */
 auto Parse(const std::string& in) -> Oasis::FromInFixResult { return Oasis::FromInFix(in); };
 
 int main(int argc, char** argv)
@@ -54,7 +58,9 @@ int main(int argc, char** argv)
         if (input == "exit")
             break;
 
-        // Calling Oasis::FromInFix passed as template fails because defaulted parameters aren't represented in the type, so a wrapper is needed
+        /**
+         * Calling Oasis::FromInFix passed as template fails because defaulted parameters aren't represented in the type, so a wrapper is needed
+         */
         auto result = (input | Oasis::PreProcessInFix | Parse)
                           .transform([](const std::unique_ptr<Oasis::Expression>& expr) -> std::unique_ptr<Oasis::Expression> {
                               return expr->Simplify();

include/Oasis/Add.hpp

@@ -1,6 +1,6 @@
-//
-// Created by Matthew McCall on 7/2/23.
-//
+/**
+ * Created by Matthew McCall on 7/2/23.
+ */
 
 #ifndef OASIS_ADD_HPP
 #define OASIS_ADD_HPP

include/Oasis/BinaryExpression.hpp

@@ -1,6 +1,6 @@
-//
-// Created by Matthew McCall on 7/2/23.
-//
+/**
+ * Created by Matthew McCall on 7/2/23.
+ */
 
 #ifndef OASIS_BINARYEXPRESSION_HPP
 #define OASIS_BINARYEXPRESSION_HPP

include/Oasis/BoundedBinaryExpression.hpp

@@ -1,6 +1,6 @@
-//
-// Created by Matthew McCall on 5/2/24.
-//
+/**
+ * Created by Matthew McCall on 5/2/24.
+ */
 
 #ifndef OASIS_BOUNDEDBINARYEXPRESSION_HPP
 #define OASIS_BOUNDEDBINARYEXPRESSION_HPP

include/Oasis/BoundedExpression.hpp

@@ -1,6 +1,6 @@
-//
-// Created by Matthew McCall on 4/30/24.
-//
+/**
+ * Created by Matthew McCall on 4/30/24.
+ */
 
 #ifndef OAISIS_BOUNDEDEXPRESSION_HPP
 #define OAISIS_BOUNDEDEXPRESSION_HPP

include/Oasis/BoundedUnaryExpression.hpp

@@ -1,6 +1,6 @@
-//
-// Created by Matthew McCall on 4/30/24.
-//
+/**
+ * Created by Matthew McCall on 4/30/24.
+ */
 
 #ifndef OASIS_BOUNDEDUNARYEXPRESSION_HPP
 #define OASIS_BOUNDEDUNARYEXPRESSION_HPP
@@ -46,7 +46,9 @@ class BoundedUnaryExpression : public BoundedExpression<LowerBoundT, UpperBoundT
 
     auto Copy(tf::Subflow&) const -> std::unique_ptr<Expression> final
     {
-        // TODO: Actually implement
+        /**
+         * TODO: Actually implement
+         */
         return std::make_unique<DerivedSpecialized>(*static_cast<const DerivedSpecialized*>(this));
     }
 
@@ -58,13 +60,14 @@ class BoundedUnaryExpression : public BoundedExpression<LowerBoundT, UpperBoundT
     [[nodiscard]] auto Equals(const Expression& other) const -> bool final
     {
 
-        // TODO: Reimplement now that Specialize is gone
-        //        if (const auto otherExpression = DerivedSpecialized::Specialize(other); otherExpression != nullptr) {
-        //            return HasOperand() == otherExpression->HasOperand()
-        //                && this->HasLowerBound() == otherExpression->HasLowerBound()
-        //                && this->HasUpperBound() == otherExpression->HasUpperBound();
-        //        }
-
+        /**
+         * TODO: Reimplement now that Specialize is gone
+         *       if (const auto otherExpression = DerivedSpecialized::Specialize(other); otherExpression != nullptr) {
+         *            return HasOperand() == otherExpression->HasOperand()
+         *                && this->HasLowerBound() == otherExpression->HasLowerBound()
+         *                && this->HasUpperBound() == otherExpression->HasUpperBound();
+         *        }
+         */
         return false;
     }
 

include/Oasis/Concepts.hpp

@@ -1,6 +1,6 @@
-//
-// Created by Matthew McCall on 10/20/24.
-//
+/**
+ * Created by Matthew McCall on 10/20/24.
+ */
 
 #ifndef OASIS_CONCEPTS_HPP
 #define OASIS_CONCEPTS_HPP

include/Oasis/DefiniteIntegral.hpp

@@ -1,6 +1,6 @@
-//
-// Created by Matthew McCall on 4/30/24.
-//
+/** 
+ * Created by Matthew McCall on 4/30/24.
+ */
 
 #ifndef DEFINITEINTEGRAL_HPP
 #define DEFINITEINTEGRAL_HPP

include/Oasis/Derivative.hpp

@@ -1,6 +1,6 @@
-//
-// Created by bachia on 4/12/2024.
-//
+/**
+ * Created by bachia on 4/12/2024.
+ */
 
 #ifndef OASIS_DERIVATIVE_HPP
 #define OASIS_DERIVATIVE_HPP

include/Oasis/Divide.hpp

@@ -1,6 +1,6 @@
-//
-// Created by Matthew McCall on 8/10/23.
-//
+/**
+ * Created by Matthew McCall on 8/10/23.
+ */
 
 #ifndef OASIS_DIVIDE_HPP
 #define OASIS_DIVIDE_HPP

include/Oasis/EulerNumber.hpp

@@ -1,6 +1,6 @@
-//
-// Created by Andrew Nazareth on 6/25/24.
-//
+/**
+ * Created by Andrew Nazareth on 6/25/24.
+ */
 
 #ifndef OASIS_EULERNUMBER_HPP
 #define OASIS_EULERNUMBER_HPP

include/Oasis/Exponent.hpp

@@ -1,6 +1,6 @@
-//
-// Created by Andrew Nazareth on 9/19/23.
-//
+/**
+ * Created by Andrew Nazareth on 9/19/23.
+ */
 
 #ifndef OASIS_EXPONENT_HPP
 #define OASIS_EXPONENT_HPP

include/Oasis/Imaginary.hpp

@@ -1,6 +1,6 @@
-//
-// Created by Andrew Nazareth on 10/10/23.
-//
+/**
+ * Created by Andrew Nazareth on 10/10/23.
+ */
 
 #ifndef OASIS_IMAGINARY_HPP
 #define OASIS_IMAGINARY_HPP

include/Oasis/Integral.hpp

@@ -1,6 +1,6 @@
-//
-// Created by Levy Lin on 2/09/2024.
-//
+/**
+ * Created by Levy Lin on 2/09/2024.
+ */
 
 #ifndef OASIS_INTEGRATE_HPP
 #define OASIS_INTEGRATE_HPP

include/Oasis/LeafExpression.hpp

@@ -1,6 +1,6 @@
-//
-// Created by Matthew McCall on 7/2/23.
-//
+/**
+ * Created by Matthew McCall on 7/2/23.
+ */
 
 #ifndef OASIS_LEAFEXPRESSION_HPP
 #define OASIS_LEAFEXPRESSION_HPP

include/Oasis/Linear.hpp

@@ -1,6 +1,6 @@
-//
-// Created by Andrew Nazareth on 2/16/24.
-//
+/**
+ * Created by Andrew Nazareth on 2/16/24.
+ */
 
 #ifndef OASIS_LINEAR_HPP
 #define OASIS_LINEAR_HPP

include/Oasis/Log.hpp

@@ -1,6 +1,6 @@
-//
-// Created by Matthew McCall on 10/6/23.
-//
+/**
+ * Created by Matthew McCall on 10/6/23.
+ */
 
 #ifndef OASIS_LOG_HPP
 #define OASIS_LOG_HPP

include/Oasis/Magnitude.hpp

@@ -1,6 +1,6 @@
-//
-// Created by Andrew Nazareth on 6/28/24.
-//
+/**
+ * Created by Andrew Nazareth on 6/28/24.
+ */
 
 #ifndef OASIS_MAGNITUDE_HPP
 #define OASIS_MAGNITUDE_HPP
@@ -78,8 +78,9 @@ class Magnitude final : public UnaryExpression<Magnitude, OperandT> {
 
     [[nodiscard]] auto Differentiate(const Expression& var) const -> std::unique_ptr<Expression> override
     {
-        // TODO: Implement
-
+        /**
+         * TODO: Implement
+         */
         const std::unique_ptr<Expression> operandDerivative = this->GetOperand().Differentiate(var);
         return Magnitude<Expression> {
             *operandDerivative
@@ -89,7 +90,9 @@ class Magnitude final : public UnaryExpression<Magnitude, OperandT> {
 
     [[nodiscard]] auto Integrate(const Expression& integrationVar) const -> std::unique_ptr<Expression> override
     {
-        // TODO: Implement
+        /**
+         * TODO: Implement
+         */
         const std::unique_ptr<Expression> operandDerivative = this->GetOperand().Integrate(integrationVar);
         return Magnitude<Expression> {
             *operandDerivative

include/Oasis/MatchCast.hpp

@@ -1,18 +1,19 @@
-//
-// Created by Matthew McCall on 10/22/24.
-//
+/**
+ * Created by Matthew McCall on 10/22/24.
+ */
 
-// Hear ye, valiant coder! Within this hallowed script of Oasis' MatchCast,
-// lies an unfathomable confluence of templated magic, scarcely understood only by even the
-// most exalted compilers and the divine overseers. This arcane construct,
-// when tampered with, may envelop thee in utter confusion, leaving thee solitary in thy pursuits.
-// Of course, this sagely advice surely does not emanate from a mere language model. Rather,
-// it is the timeless counsel of battle-hardened developers who have faced such arcane complexity.
-// Should regret cloud thy mind and thou desires to undo thine alterations, perform the following
-// sacred rite to restore the code to its pristine state:
-//
-// git checkout -- <path_to_this_file>
-//
+/**
+ * Hear ye, valiant coder! Within this hallowed script of Oasis' MatchCast,
+ * lies an unfathomable confluence of templated magic, scarcely understood only by even the
+ * most exalted compilers and the divine overseers. This arcane construct,
+ * when tampered with, may envelop thee in utter confusion, leaving thee solitary in thy pursuits.
+ * Of course, this sagely advice surely does not emanate from a mere language model. Rather,
+ * it is the timeless counsel of battle-hardened developers who have faced such arcane complexity.
+ * Should regret cloud thy mind and thou desires to undo thine alterations, perform the following
+ * sacred rite to restore the code to its pristine state:
+ * 
+ * git checkout -- <path_to_this_file>
+ */
 
 #ifndef OASIS_MATCHCAST_HPP
 #define OASIS_MATCHCAST_HPP

include/Oasis/Matrix.hpp

@@ -1,6 +1,6 @@
-//
-// Created by Andrew Nazareth on 5/24/24.
-//
+/**
+ * Created by Andrew Nazareth on 5/24/24.
+ */
 
 #ifndef OASIS_MATRIX_HPP
 #define OASIS_MATRIX_HPP

include/Oasis/Multiply.hpp

@@ -1,6 +1,6 @@
-//
-// Created by Matthew McCall on 8/10/23.
-//
+/**
+ * Created by Matthew McCall on 8/10/23.
+ */
 
 #ifndef OASIS_MULTIPLY_HPP
 #define OASIS_MULTIPLY_HPP