model_expression.h

Go to the documentation of this file.

// SPDX-License-Identifier: AGPL-3.0-only
// Copyright (C) 2026 Artificial Intelligence Techniques, S.L. and Roberto López González
 
#pragma once
 
#include "opennn/core/configuration.h"
#include "opennn/core/opennn_types.h"
 
namespace opennn
{
 
class Network;
class Layer;
 
class ModelExpression
{
public:
 
    enum class ProgrammingLanguage{C, CEmbedded, Python, JavaScript, PHP, CSharp};
 
    ModelExpression(const Network*);
 
    string build_expression() const;
 
    void save(const filesystem::path&, ProgrammingLanguage) const;
 
private:
 
    const Network* network = nullptr;
 
    string get_expression_c() const;
    string get_expression_c_embedded() const;
    string get_expression_python() const;
    string get_expression_php() const;
    string get_expression_javascript() const;
    string get_expression_csharp() const;
 
    static string c_string_literal(string_view);
    static string c_float_literal(float);
 
    vector<string> get_flat_input_names() const;
 
    struct ExportNames
    {
        vector<string> inputs;
        vector<string> outputs;
        vector<string> fixed_inputs;
        vector<string> fixed_outputs;
 
        Index inputs_number() const noexcept { return Index(inputs.size()); }
        Index outputs_number() const noexcept { return Index(outputs.size()); }
    };
 
    ExportNames collect_names() const;
    string build_expression(const vector<string>&, const vector<string>&) const;
 
    void check_parameters_are_finite() const;
 
    void emit_c_prelude(ostringstream&, const ExportNames&) const;
    void emit_c_calculate_outputs(ostringstream&, const string&, const vector<string>&, bool has_softmax, const ExportNames&) const;
    void emit_c_main(ostringstream&, const ExportNames&) const;
 
    void emit_php_prelude(ostringstream&, const ExportNames&) const;
    void emit_php_inputs_setup(ostringstream&, const ExportNames&) const;
    void emit_php_body(ostringstream&, const vector<string>&, bool has_softmax, const ExportNames&) const;
    void emit_php_response(ostringstream&, const ExportNames&) const;
 
    void emit_python_prelude(ostringstream&, const ExportNames&) const;
    void emit_python_class_header(ostringstream&, const ExportNames&) const;
    void emit_python_calculate_outputs(ostringstream&, const string&, const vector<string>&, bool has_softmax, const ExportNames&) const;
    void emit_python_batch_and_main(ostringstream&, const ExportNames&) const;
 
    void emit_js_prelude(ostringstream&, const ExportNames&) const;
    void emit_js_inputs_html(ostringstream&, const ExportNames&) const;
    void emit_js_outputs_html(ostringstream&, bool use_category_select, const ExportNames&) const;
    void emit_js_runtime(ostringstream&, const string&, const vector<string>&, bool has_softmax, bool use_category_select, const ExportNames&) const;
 
    void emit_csharp_prelude(ostringstream&, const ExportNames&) const;
    void emit_csharp_calculate_outputs(ostringstream&, const string&, const vector<string>&, bool has_softmax, const ExportNames&) const;
    void emit_csharp_main(ostringstream&, const ExportNames&) const;
 
    static vector<string> split_expression_lines(const string&);
    static void rename_spaced_var_definitions(vector<string>&);
    static vector<string> prepare_body_lines(const string&);
    static vector<string> fix_names(const vector<string>&, const string&);
    static vector<string> fix_output_names(const string&, const vector<string>&, const ProgrammingLanguage&);
    static void apply_name_mapping(string&, const vector<string>&, const vector<string>&);
    static string process_body_line(const string&, const vector<string>&, const vector<string>&);
    static string replace_reserved_keywords(const string&);
 
    struct LanguageSyntax
    {
        const char* body_indent = "";
        const char* body_declaration = "";
        bool declare_first_assignment_only = false;
        const char* softmax_declaration = "";
        const char* softmax_counter = "";
        const char* softmax_zero = "";
        const char* softmax_exp = "";
        string softmax_limit;
    };
 
    static LanguageSyntax language_syntax(ProgrammingLanguage, Index outputs_number = 0);
    static void emit_body_lines(ostringstream&, const vector<string>&, const LanguageSyntax&, const function<string(const string&)>&);
    static void emit_softmax_block(ostringstream&, const LanguageSyntax&);
 
    struct ActivationBodies
    {
        string c;
        string javascript;
        string python;
        string php;
        string csharp;
    };
 
    static void emit_activations(ostringstream&,
                                 const string& expression,
                                 string ActivationBodies::* body,
                                 initializer_list<string_view> always);
 
    static const vector<pair<ActivationFunction, ActivationBodies>>& activation_table();
};
 
}