12345qiupeng
/
gtsam
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add documentation to the templates

release/4.3a0
Fan Jiang 2020-08-18 11:26:34 -04:00
parent 7378fe73b7
commit 09c1e3b3f4
2 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
python/gtsam/gtsam.tpl
View File

@ -1,3 +1,13 @@
/**
* @file gtsam.cpp
* @brief The auto-generated wrapper C++ source code.
* @author Duy-Nguyen Ta, Fan Jiang, Matthew Sklar
* @date Aug. 18, 2020
*
* ** THIS FILE IS AUTO-GENERATED, DO NOT MODIFY! **
*/
// Include relevant boost libraries required by GTSAM
{include_boost} {include_boost}
#include <pybind11/eigen.h> #include <pybind11/eigen.h>
@ -6,13 +16,18 @@
#include "gtsam/base/serialization.h" #include "gtsam/base/serialization.h"
#include "gtsam/nonlinear/utilities.h" // for RedirectCout. #include "gtsam/nonlinear/utilities.h" // for RedirectCout.
// These are the included headers listed in `gtsam.i`
{includes} {includes}
#include <boost/serialization/export.hpp> #include <boost/serialization/export.hpp>
// Export classes for serialization
{boost_class_export} {boost_class_export}
// Holder type for pybind11
{hoder_type} {hoder_type}
// Preamble for STL classes
// TODO(fan): make this automatic
#include "python/gtsam/preamble.h" #include "python/gtsam/preamble.h"
using namespace std; using namespace std;
@ -24,6 +39,8 @@ PYBIND11_MODULE({module_name}, m_) {{
{wrapped_namespace} {wrapped_namespace}
// Specializations for STL classes
// TODO(fan): make this automatic
#include "python/gtsam/specializations.h" #include "python/gtsam/specializations.h"
}} }}

12
python/gtsam_unstable/gtsam_unstable.tpl
View File

@ -1,3 +1,13 @@
/**
* @file gtsam.cpp
* @brief The auto-generated wrapper C++ source code.
* @author Duy-Nguyen Ta, Fan Jiang, Matthew Sklar
* @date Aug. 18, 2020
*
* ** THIS FILE IS AUTO-GENERATED, DO NOT MODIFY! **
*/
// Include relevant boost libraries required by GTSAM
{include_boost} {include_boost}
#include <pybind11/eigen.h> #include <pybind11/eigen.h>
@ -6,6 +16,7 @@
#include "gtsam/base/serialization.h" #include "gtsam/base/serialization.h"
#include "gtsam/nonlinear/utilities.h" // for RedirectCout. #include "gtsam/nonlinear/utilities.h" // for RedirectCout.
// These are the included headers listed in `gtsam_unstable.i`
{includes} {includes}
#include <boost/serialization/export.hpp> #include <boost/serialization/export.hpp>
@ -22,6 +33,7 @@ namespace py = pybind11;
PYBIND11_MODULE({module_name}, m_) {{ PYBIND11_MODULE({module_name}, m_) {{
m_.doc() = "pybind11 wrapper of {module_name}"; m_.doc() = "pybind11 wrapper of {module_name}";
// Note here we need to import the dependent library
py::module::import("gtsam"); py::module::import("gtsam");
{wrapped_namespace} {wrapped_namespace}