model_library_c_source_gen.hpp

#ifndef CPPAD_CG_MODEL_LIBRARY_C_SOURCE_GEN_INCLUDED
#define CPPAD_CG_MODEL_LIBRARY_C_SOURCE_GEN_INCLUDED
/* --------------------------------------------------------------------------
 *  CppADCodeGen: C++ Algorithmic Differentiation with Source Code Generation:
 *    Copyright (C) 2012 Ciengis
 *    Copyright (C) 2020 Joao Leal
 *
 *  CppADCodeGen is distributed under multiple licenses:
 *
 *   - Eclipse Public License Version 1.0 (EPL1), and
 *   - GNU General Public License Version 3 (GPL3).
 *
 *  EPL1 terms and conditions can be found in the file "epl-v10.txt", while
 *  terms and conditions for the GPL3 can be found in the file "gpl3.txt".
 * ----------------------------------------------------------------------------
 * Author: Joao Leal
 */

namespace CppAD {
namespace cg {

template<class Base>
class ModelLibraryCSourceGen : public JobTimer {
public:
    static const std::string FUNCTION_VERSION;
    static const std::string FUNCTION_MODELS;
    static const std::string FUNCTION_ONCLOSE;
    static const std::string FUNCTION_SETTHREADPOOLDISABLED;
    static const std::string FUNCTION_ISTHREADPOOLDISABLED;
    static const std::string FUNCTION_SETTHREADS;
    static const std::string FUNCTION_GETTHREADS;
    static const std::string FUNCTION_SETTHREADSCHEDULERSTRAT;
    static const std::string FUNCTION_GETTHREADSCHEDULERSTRAT;
    static const std::string FUNCTION_SETTHREADPOOLVERBOSE;
    static const std::string FUNCTION_ISTHREADPOOLVERBOSE;
    static const std::string FUNCTION_SETTHREADPOOLGUIDEDMAXGROUPWORK;
    static const std::string FUNCTION_GETTHREADPOOLGUIDEDMAXGROUPWORK;
    static const std::string FUNCTION_SETTHREADPOOLNUMBEROFTIMEMEAS;
    static const std::string FUNCTION_GETTHREADPOOLNUMBEROFTIMEMEAS;
    static const unsigned long API_VERSION;
protected:
    static const std::string CONST;
protected:
    std::map<std::string, ModelCSourceGen<Base>*> _models;
    std::map<std::string, std::string> _customSource;
    std::map<std::string, std::string> _libSources;
    MultiThreadingType _multiThreading;
    std::ostringstream _cache;
public:

    inline ModelLibraryCSourceGen(ModelCSourceGen<Base>& model):
        _multiThreading(MultiThreadingType::NONE) {
        CPPADCG_ASSERT_KNOWN(_models.find(model.getName()) == _models.end(),
                             "Another model with the same name was already registered")

        _models[model.getName()] = &model; // must not use initializer_list constructor of map!
    }

    template<class... Ms>
    inline ModelLibraryCSourceGen(ModelCSourceGen<Base>& headModel, Ms&... rest) :
        ModelLibraryCSourceGen(rest...) {
        CPPADCG_ASSERT_KNOWN(_models.find(headModel.getName()) == _models.end(),
                             "Another model with the same name was already registered")

        _models[headModel.getName()] = &headModel;
    }

    ModelLibraryCSourceGen(const ModelLibraryCSourceGen&) = delete;
    ModelLibraryCSourceGen& operator=(const ModelLibraryCSourceGen&) = delete;

    virtual ~ModelLibraryCSourceGen() = default;

    inline void addModel(ModelCSourceGen<Base>& model) {
        CPPADCG_ASSERT_KNOWN(_models.find(model.getName()) == _models.end(),
                             "Another model with the same name was already registered")

        _models[model.getName()] = &model;

        _libSources.clear(); // must regenerate library sources again
    }

    inline const std::map<std::string, ModelCSourceGen<Base>*>& getModels() const {
        return _models;
    }

    void addCustomFunctionSource(const std::string& filename, const std::string& source) {
        CPPADCG_ASSERT_KNOWN(!filename.empty(), "The filename name cannot be empty")

        _customSource[filename] = source;
    }

    inline const std::map<std::string, std::string>& getCustomSources() const {
        return _customSource;
    }

    inline MultiThreadingType getMultiThreading() const {
        return _multiThreading;
    }

    inline void setMultiThreading(MultiThreadingType multiThreading) {
        _multiThreading = multiThreading;
    }

    void saveSources(const std::string& sourcesFolder);

    virtual const std::map<std::string, std::string>& getLibrarySources();
protected:

    virtual void generateVersionSource(std::map<std::string, std::string>& sources);

    virtual void generateModelsSource(std::map<std::string, std::string>& sources);

    virtual void generateOnCloseSource(std::map<std::string, std::string>& sources);

    virtual void generateThreadPoolSources(std::map<std::string, std::string>& sources);

    static void saveSources(const std::string& sourcesFolder,
                            const std::map<std::string, std::string>& sources);

    friend class ModelLibraryProcessor<Base>;
};

} // END cg namespace
} // END CppAD namespace

#endif