Arithmetic AST & Evaluator

This C++ program provides a simple mathematical expression evaluator using an Abstract Syntax Tree (AST). The AST is constructed from different types of nodes, such as constants, identifiers, unary operators (plus and minus), and binary operators (addition, subtraction, multiplication, division, and power). The program allows for the evaluation of mathematical expressions involving variables and basic operations.

Table of Contents

• Introduction
• Usage
• ASTNode Hierarchy
• Dependencies
• Running Tests
• Error Handling
• Variable Assignment
• Cleaning Variables
• Contributing
• License

Introduction

The program defines a hierarchy of classes representing different types of AST nodes. Each node has a specific type and implements the evaluate method to perform the corresponding mathematical operation. The AST is utilized to evaluate complex mathematical expressions composed of constants, variables, and various operators.

Usage

To use the expression evaluator, follow these steps:

1. Variable Assignment: Use the Identifier::setVariable method to assign values to variables.
2. Expression Creation: Construct the expression using the provided AST nodes and operators.
3. Evaluation: Call the evaluate method on the root node of the expression.
4. Cleanup: Release the allocated memory using delete and, if needed, clear assigned variables.

ASTNode Hierarchy

The ASTNode hierarchy consists of the following classes:

• Constant: Represents a constant numerical value.
• Identifier: Represents a variable identified by a string.
• Unary: Abstract base class for unary operators.
  • UnaryPlus: Represents the unary plus operator.
  • UnaryMinus: Represents the unary minus operator.
• Binary: Abstract base class for binary operators.
  • Add: Represents the addition operator.
  • Subtract: Represents the subtraction operator.
  • Multiply: Represents the multiplication operator.
  • Divide: Represents the division operator.
  • Power: Represents the power operator.

Dependencies

• GNU Make
• Clang

Running Tests

Test Expression

\frac{{2 \cdot (3 + 1)}}{{(5 - 1)^{2 + 1}}} = \frac{8}{{4^3}} = \frac{8}{64} = 0.125

Test Code

// Test with a complex expression: (2 * (a + b)) / (c - 1) ^ (d + 1)
Identifier::setVariable("a", 3.0);
Identifier::setVariable("b", 1.0);
Identifier::setVariable("c", 5.0);
Identifier::setVariable("d", 2.0);

std::unique_ptr<const ASTNode> variableA = std::make_unique<Identifier>("a");
std::unique_ptr<const ASTNode> variableB = std::make_unique<Identifier>("b");
std::unique_ptr<const ASTNode> variableC = std::make_unique<Identifier>("c");
std::unique_ptr<const ASTNode> variableD = std::make_unique<Identifier>("d");

std::unique_ptr<const ASTNode> expression = std::make_unique<Divide>(
    std::make_unique<Multiply>(std::make_unique<Constant>(2.0),
                               std::make_unique<Add>(std::move(variableA), std::move(variableB))),
    std::make_unique<Power>(std::make_unique<Subtract>(std::move(variableC), std::make_unique<Constant>(1.0)),
                            std::make_unique<Add>(std::move(variableD), std::make_unique<Constant>(1.0))));

// Evaluate the expression
double result = expression->evaluate();

// Asserting the result
assert(result == 0.125);

std::cout << "Test passed successfully. Result: " << result << std::endl;

// Clear variables for the next test
Identifier::clearVariables();

Error Handling

The program includes basic error handling. For example, attempting to divide by zero will result in an error message printed to std::cerr, and the division operation will return infinity to indicate an error.

Variable Assignment

Variables are assigned values using the Identifier::setVariable method. If an undefined variable is encountered during evaluation, an error message is printed, and the default value of 0.0 is returned.

Cleaning Variables

To clean up assigned variables and release allocated memory, use the Identifier::clearVariables method. This ensures a clean slate for subsequent expressions.

Contributing

Feel free to contribute to the project by opening issues, suggesting improvements, or submitting pull requests. Your contributions are highly appreciated.

License

This project is licensed under the MIT License. See the LICENSE file for details.