node_index.cpp

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
 */
 
#include <catch2/catch_test_macros.hpp>
 
#include "ast/program.hpp"
#include "parser/nmodl_driver.hpp"
#include "utils/test_utils.hpp"
#include "visitors/indexedname_visitor.hpp"
#include "visitors/visitor_utils.hpp"
 
using namespace nmodl;
using namespace visitor;
 
//=============================================================================
// Get the indexed node name and the dependencies of differential equations
//=============================================================================
std::pair<std::string, std::pair<std::string, std::unordered_set<std::string>>>
get_indexedname_dependencies(ast::Program& node) {
    IndexedNameVisitor testvisitor;
    testvisitor.visit_program(node);
    return std::make_pair(testvisitor.get_indexed_name(), testvisitor.get_dependencies());
}
 
SCENARIO("Get node name with index TestVisitor", "[visitor][node_index]") {
    auto to_ast = [](const std::string& text) {
        parser::NmodlDriver driver;
        return driver.parse_string(text);
    };
 
    GIVEN("A simple NMODL block") {
        std::string nmodl_text_a = R"(
            STATE {
                m[1]
            }
            BREAKPOINT  {
                SOLVE states METHOD euler
            }
            DERIVATIVE states {
                m'[0] = mInf/mTau
            }
        )";
        std::string nmodl_text_b = R"(
            BREAKPOINT  {
                SOLVE states STEADYSTATE sparse
            }
            DERIVATIVE states {
                m' = m + h
            }
        )";
 
        WHEN("Get node name with index") {
            THEN("Get node name with index") {
                auto ast = to_ast(nmodl_text_a);
                std::unordered_set<std::string> vars{"mInf", "mTau"};
                std::string var("m[0]");
                auto expect = std::make_pair(var, vars);
                auto result_name = get_indexedname_dependencies(*ast).first;
                auto result_dependencies = get_indexedname_dependencies(*ast).second;
                REQUIRE(result_name == var);
                REQUIRE(result_dependencies.first == expect.first);
                REQUIRE(result_dependencies.second == expect.second);
            }
            THEN("Get dependencies") {
                auto ast = to_ast(nmodl_text_b);
                std::unordered_set<std::string> vars{"m", "h"};
                std::string var("m");
                auto expect = std::make_pair(var, vars);
                auto result_name = get_indexedname_dependencies(*ast).first;
                auto result_dependencies = get_indexedname_dependencies(*ast).second;
                REQUIRE(result_dependencies.first == expect.first);
                REQUIRE(result_dependencies.second == expect.second);
            }
        }
    }
}