diffeq_driver.hpp

Go to the documentation of this file.

/*
 * Copyright 2023 Blue Brain Project, EPFL.
 * See the top-level LICENSE file for details.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#pragma once
 
#include <string>
 
#include "parser/diffeq_context.hpp"
 
 
namespace nmodl {
namespace parser {
 
/// flex generated scanner class (extends base lexer class of flex)
class DiffeqlLexer;
 
/// parser class generated by bison
class DiffeqParser;
 
/**
 * @addtogroup parser
 * @{
 */
 
/**
 * \class DiffeqDriver
 * \brief Class that binds all pieces together for parsing differential equations
 *
 * Driver class bind components required for lexing, parsing and ast
 * generation for differential equations.
 */
class DiffeqDriver {
  private:
    static std::string solve_equation(std::string& state,
                                      int order,
                                      std::string& rhs,
                                      std::string& method,
                                      bool& cnexp_possible,
                                      bool debug = false);
 
    /// parse given equation into lhs, rhs and find it's order and state variable
    static void parse_equation(const std::string& equation,
                               std::string& state,
                               std::string& rhs,
                               int& order);
 
  public:
    DiffeqDriver() = default;
 
    /// solve equation using provided method
    static std::string solve(const std::string& equation, std::string method, bool debug = false);
 
    /// check if given equation can be solved using cnexp method
    static bool cnexp_possible(const std::string& equation, std::string& solution);
};
 
/** @} */  // end of parser
 
}  // namespace parser
}  // namespace nmodl