Merge pull request #2932 from stan-dev/feature/compile_info

Add virtual function model_compile_info to the model_base.hpp

Author: rok-cesnovar

src/stan/lang/generator.hpp

@@ -70,6 +70,7 @@
 #include <stan/lang/generator/generate_member_var_decls.hpp>
 #include <stan/lang/generator/generate_member_var_decls_all.hpp>
 #include <stan/lang/generator/generate_model_name_method.hpp>
+#include <stan/lang/generator/generate_model_compile_info_method.hpp>
 #include <stan/lang/generator/generate_model_typedef.hpp>
 #include <stan/lang/generator/generate_namespace_end.hpp>
 #include <stan/lang/generator/generate_namespace_start.hpp>

src/stan/lang/generator/generate_cpp.hpp

@@ -16,6 +16,7 @@
 #include <stan/lang/generator/generate_log_prob.hpp>
 #include <stan/lang/generator/generate_member_var_decls_all.hpp>
 #include <stan/lang/generator/generate_model_name_method.hpp>
+#include <stan/lang/generator/generate_model_compile_info_method.hpp>
 #include <stan/lang/generator/generate_model_typedef.hpp>
 #include <stan/lang/generator/generate_namespace_end.hpp>
 #include <stan/lang/generator/generate_namespace_start.hpp>
@@ -70,6 +71,7 @@ void generate_cpp(const program& prog, const std::string& model_name,
   generate_dims_method(prog, o);
   generate_write_array_method(prog, model_name, o);
   generate_model_name_method(model_name, o);
+  generate_model_compile_info_method(o);
   generate_constrained_param_names_method(prog, o);
   generate_unconstrained_param_names_method(prog, o);
   generate_class_decl_end(o);

src/stan/lang/generator/generate_model_compile_info_method.hpp

@@ -0,0 +1,26 @@
+#ifndef STAN_LANG_GENERATOR_GENERATE_MODEL_COMPILE_INFO_METHOD_HPP
+#define STAN_LANG_GENERATOR_GENERATE_MODEL_COMPILE_INFO_METHOD_HPP
+
+#include <stan/lang/ast.hpp>
+#include <stan/lang/generator/constants.hpp>
+#include <ostream>
+#include <string>
+
+namespace stan {
+namespace lang {
+
+/**
+ * Generate the <code>model_compile_info</code> method on the specified stream.
+ *
+ * @param[in,out] o stream for generating
+ */
+void generate_model_compile_info_method(std::ostream& o) {
+  o << INDENT << "std::vector<std::string> model_compile_info() const {" << EOL
+    << INDENT2 << "std::vector<std::string> stanc_info;" << EOL << INDENT2
+    << "stanc_info.push_back(\"stanc_version = stanc2\");" << EOL << INDENT2
+    << "return stanc_info;" << EOL << INDENT << "}" << EOL2;
+}
+
+}  // namespace lang
+}  // namespace stan
+#endif

src/stan/model/model_base.hpp

@@ -53,6 +53,14 @@ class model_base : public prob_grad {
    */
   virtual std::string model_name() const = 0;
 
+  /**
+   * Returns the compile information of the model:
+   * stanc version and stanc flags used to compile the model.
+   *
+   * @return model name
+   */
+  virtual std::vector<std::string> model_compile_info() const = 0;
+
   /**
    * Set the specified argument to sequence of parameters, transformed
    * parameters, and generated quantities in the order in which they

src/test/unit/model/model_base_crtp_test.cpp

@@ -15,6 +15,12 @@ struct mock_model : public stan::model::model_base_crtp<mock_model> {
 
   std::string model_name() const override { return "mock_model"; }
 
+  std::vector<std::string> model_compile_info() const {
+    std::vector<std::string> stanc_info;
+    stanc_info.push_back("stanc_version = stanc2");
+    return stanc_info;
+  }
+
   void get_param_names(std::vector<std::string>& names) const override {}
   void get_dims(std::vector<std::vector<size_t> >& dimss) const override {}
 

src/test/unit/model/model_base_test.cpp

@@ -13,6 +13,12 @@ struct mock_model : public stan::model::model_base {
 
   std::string model_name() const override { return "mock_model"; }
 
+  std::vector<std::string> model_compile_info() const {
+    std::vector<std::string> stanc_info;
+    stanc_info.push_back("stanc_version = stanc2");
+    return stanc_info;
+  }
+
   void get_param_names(std::vector<std::string>& names) const override {}
   void get_dims(std::vector<std::vector<size_t> >& dimss) const override {}