Wrap Values::insert and Values::at for Point3, Rot3, and Pose3

release/4.3a0
Ellon Mendes 2015-11-18 11:48:25 +01:00
parent 7cfd57339a
commit e0b8d87695
1 changed files with 53 additions and 1 deletions

View File

@ -30,7 +30,51 @@ using namespace gtsam;
// Prototypes used to perform overloading // Prototypes used to perform overloading
// See: http://www.boost.org/doc/libs/1_59_0/libs/python/doc/tutorial/doc/html/python/functions.html // See: http://www.boost.org/doc/libs/1_59_0/libs/python/doc/tutorial/doc/html/python/functions.html
void (Values::*insert_0)(const gtsam::Values&) = &Values::insert; void (Values::*insert_0)(const gtsam::Values&) = &Values::insert;
void (Values::*insert_1)(Key, const gtsam::Pose3&) = &Values::insert; void (Values::*insert_1)(Key, const gtsam::Point3&) = &Values::insert;
void (Values::*insert_2)(Key, const gtsam::Rot3&) = &Values::insert;
void (Values::*insert_3)(Key, const gtsam::Pose3&) = &Values::insert;
/** The function ValuesAt is a workaround to be able to call the correct templated version
* of Values::at. Without it, python would only try to match the last 'at' metho defined
* below. With this wrapper function we can call 'at' in python passing an extra type,
* which will define the type to be returned. Example:
*
* >>> import gtsam
* >>> v = gtsam.nonlinear.Values()
* >>> v.insert(1,gtsam.geometry.Point3())
* >>> v.insert(2,gtsam.geometry.Rot3())
* >>> v.insert(3,gtsam.geometry.Pose3())
* >>> v.at(1,gtsam.geometry.Point3())
* >>> v.at(2,gtsam.geometry.Rot3())
* >>> v.at(3,gtsam.geometry.Pose3())
*
* A more 'pythonic' way I think would be to not use this function and define different
* 'at' methods below using the name of the type in the function name, like:
*
* .def("point3_at", &Values::at<Point3>, return_internal_reference<>())
* .def("rot3_at", &Values::at<Rot3>, return_internal_reference<>())
* .def("pose3_at", &Values::at<Pose3>, return_internal_reference<>())
*
* and then they could be accessed from python as
*
* >>> import gtsam
* >>> v = gtsam.nonlinear.Values()
* >>> v.insert(1,gtsam.geometry.Point3())
* >>> v.insert(2,gtsam.geometry.Rot3())
* >>> v.insert(3,gtsam.geometry.Pose3())
* >>> v.point3_at(1)
* >>> v.rot3_at(2)
* >>> v.pose3_at(3)
*
* In fact, I just saw the pythonic way sounds more clear, so I'm sticking with this and
* leaving the comments here for future reference. I'm using the PEP0008 for method naming.
* See: https://www.python.org/dev/peps/pep-0008/#function-and-method-arguments
*/
// template<typename T>
// const T & ValuesAt( const Values & v, Key j, T /*type*/)
// {
// return v.at<T>(j);
// }
BOOST_PYTHON_MODULE(libnonlinear_python) BOOST_PYTHON_MODULE(libnonlinear_python)
{ {
@ -49,6 +93,14 @@ class_<Values>("Values")
.def("swap", &Values::swap) .def("swap", &Values::swap)
.def("insert", insert_0) .def("insert", insert_0)
.def("insert", insert_1) .def("insert", insert_1)
.def("insert", insert_2)
.def("insert", insert_3)
// .def("at", &ValuesAt<Point3>, return_internal_reference<>())
// .def("at", &ValuesAt<Rot3>, return_internal_reference<>())
// .def("at", &ValuesAt<Pose3>, return_internal_reference<>())
.def("point3_at", &Values::at<Point3>, return_internal_reference<>())
.def("rot3_at", &Values::at<Rot3>, return_internal_reference<>())
.def("pose3_at", &Values::at<Pose3>, return_internal_reference<>())
; ;
} }