CppADCodeGen  HEAD
A C++ Algorithmic Differentiation Package with Source Code Generation
model_library.hpp
1 #ifndef CPPAD_CG_MODEL_LIBRARY_INCLUDED
2 #define CPPAD_CG_MODEL_LIBRARY_INCLUDED
3 /* --------------------------------------------------------------------------
4  * CppADCodeGen: C++ Algorithmic Differentiation with Source Code Generation:
5  * Copyright (C) 2013 Ciengis
6  * Copyright (C) 2020 Joao Leal
7  *
8  * CppADCodeGen is distributed under multiple licenses:
9  *
10  * - Eclipse Public License Version 1.0 (EPL1), and
11  * - GNU General Public License Version 3 (GPL3).
12  *
13  * EPL1 terms and conditions can be found in the file "epl-v10.txt", while
14  * terms and conditions for the GPL3 can be found in the file "gpl3.txt".
15  * ----------------------------------------------------------------------------
16  * Author: Joao Leal
17  */
18 
19 namespace CppAD {
20 namespace cg {
21 
27 template<class Base>
28 class ModelLibrary {
29 public:
35  virtual std::set<std::string> getModelNames() = 0;
36 
45  virtual std::unique_ptr<GenericModel<Base>> model(const std::string& modelName) = 0;
46 
54  virtual void setThreadPoolDisabled(bool disabled) = 0;
55 
61  virtual bool isThreadPoolDisabled() const = 0;
62 
71  virtual unsigned int getThreadNumber() const = 0;
72 
82  virtual void setThreadNumber(unsigned int n) = 0;
83 
92  virtual ThreadPoolScheduleStrategy getThreadPoolSchedulerStrategy() const = 0;
93 
103  virtual void setThreadPoolSchedulerStrategy(ThreadPoolScheduleStrategy s) = 0;
104 
105  virtual void setThreadPoolVerbose(bool v) = 0;
106 
107  virtual bool isThreadPoolVerbose() const = 0;
108 
109  virtual void setThreadPoolGuidedMaxWork(float v) = 0;
110 
111  virtual float getThreadPoolGuidedMaxWork() const = 0;
112 
123  virtual void setThreadPoolNumberOfTimeMeas(unsigned int n) = 0;
124 
135  virtual unsigned int getThreadPoolNumberOfTimeMeas() const = 0;
136 
137  inline virtual ~ModelLibrary() = default;
138 
139 };
140 
141 } // END cg namespace
142 } // END CppAD namespace
143 
144 #endif
virtual bool isThreadPoolDisabled() const =0
virtual std::set< std::string > getModelNames()=0
virtual ThreadPoolScheduleStrategy getThreadPoolSchedulerStrategy() const =0
virtual void setThreadPoolSchedulerStrategy(ThreadPoolScheduleStrategy s)=0
virtual std::unique_ptr< GenericModel< Base > > model(const std::string &modelName)=0
virtual void setThreadNumber(unsigned int n)=0
virtual unsigned int getThreadPoolNumberOfTimeMeas() const =0
virtual void setThreadPoolDisabled(bool disabled)=0
virtual void setThreadPoolNumberOfTimeMeas(unsigned int n)=0
virtual unsigned int getThreadNumber() const =0