gtsam/wrap
Chris Beall 9f9d7b4a09 Merged in crownequipment/gtsam/fix/removeBoostRegex (pull request #278)
Removed the boost::regex include (not used) from the matlab wrapper & removed any linking to boost::regex
2016-09-20 07:59:37 -07:00
..
tests boost::spirit assign_a fixes to use non-literials 2016-08-11 14:23:26 +12:00
Argument.cpp Removed the boost::regex include (not used) from the matlab wrapper & removed any linking to boost::regex 2016-08-29 13:03:46 +12:00
Argument.h Much better way of handling local variables in grammar 2014-12-02 11:24:53 +01:00
CMakeLists.txt Removed the boost::regex include (not used) from the matlab wrapper & removed any linking to boost::regex 2016-08-29 13:03:46 +12:00
Class.cpp Replaced BOOSE_FOREACH with for in wrap folder. Tested the changed code locally: successful. 2016-05-20 21:41:18 -04:00
Class.h Replaced BOOSE_FOREACH with for in wrap folder. Tested the changed code locally: successful. 2016-05-20 21:41:18 -04:00
Constructor.cpp Removed headers 2016-05-22 14:22:36 -07:00
Constructor.h Removing empty in favor of boost::optional 2014-11-30 10:38:24 +01:00
Deconstructor.cpp Removed headers 2016-05-22 14:22:36 -07:00
Deconstructor.h changed tabs to spaces for consistent indentation in all of GTSAM 2012-10-02 14:40:07 +00:00
FileWriter.cpp Added templated class 2014-11-11 18:14:17 +01:00
FileWriter.h changed tabs to spaces for consistent indentation in all of GTSAM 2012-10-02 14:40:07 +00:00
ForwardDeclaration.h Added Vector and Matrix to forward declarations 2014-11-29 20:01:48 +01:00
FullyOverloadedFunction.h Replaced BOOSE_FOREACH with for in wrap folder. Tested the changed code locally: successful. 2016-05-20 21:41:18 -04:00
Function.cpp Removed headers 2016-05-22 14:22:36 -07:00
Function.h Moving to optionals fixed template dreturn argument! 2014-12-01 09:48:56 +01:00
GlobalFunction.cpp Replaced BOOSE_FOREACH with for in wrap folder. Tested the changed code locally: successful. 2016-05-20 21:41:18 -04:00
GlobalFunction.h GlobalFunctionGrammar done and used 2014-12-02 13:49:25 +01:00
Method.cpp Removed headers 2016-05-22 14:22:36 -07:00
Method.h Moving to optionals fixed template dreturn argument! 2014-12-01 09:48:56 +01:00
MethodBase.cpp Removed headers 2016-05-22 14:22:36 -07:00
MethodBase.h Removing empty in favor of boost::optional 2014-11-30 10:38:24 +01:00
Module.cpp boost::spirit assign_a fixes to use non-literials 2016-08-11 14:23:26 +12:00
Module.h Moved typedef 2014-12-02 13:30:36 +01:00
OverloadedFunction.h Replaced BOOSE_FOREACH with for in wrap folder. Tested the changed code locally: successful. 2016-05-20 21:41:18 -04:00
Qualified.h Removed mutable 2014-12-02 11:40:50 +01:00
README Fixed handling of char in wrap, updated README 2012-06-04 19:45:32 +00:00
ReturnType.cpp Removed headers 2016-05-22 14:22:36 -07:00
ReturnType.h Moved to headers 2014-11-30 23:26:07 +01:00
ReturnValue.cpp Removed headers 2016-05-22 14:22:36 -07:00
ReturnValue.h Tightened up individual Grammars 2014-12-01 20:03:26 +01:00
StaticMethod.cpp Removed headers 2016-05-22 14:22:36 -07:00
StaticMethod.h Removing empty in favor of boost::optional 2014-11-30 10:38:24 +01:00
Template.h Changes to wrap from FixedValues branch/PR. Since unrelated to that PR and useful for OptionalJacobian wrapping in py_wrap, made this a separate PR. 2016-02-07 20:33:48 -08:00
TemplateInstantiationTypedef.cpp Replaced BOOSE_FOREACH with for in wrap folder. Tested the changed code locally: successful. 2016-05-20 21:41:18 -04:00
TemplateInstantiationTypedef.h Massive edit: new Qualified type groups namespaces with name, eliminates a lot of clutter. 2014-11-12 02:49:23 +01:00
TemplateSubstitution.h Semi-private name/namespaces 2014-11-30 20:20:13 +01:00
TypeAttributesTable.cpp Replaced BOOSE_FOREACH with for in wrap folder. Tested the changed code locally: successful. 2016-05-20 21:41:18 -04:00
TypeAttributesTable.h Private table_ 2014-11-29 19:38:51 +01:00
matlab.h fix ambiguous type uint64_t and int64_t in matlab toolbox, happens on gcc 4.8 and boost 1.50 2016-06-14 15:15:14 -04:00
spirit.h No using namespace in headers 2014-12-01 20:29:11 +01:00
utilities.cpp Replaced BOOSE_FOREACH with for in wrap folder. Tested the changed code locally: successful. 2016-05-20 21:41:18 -04:00
utilities.h Removed headers 2016-05-22 14:22:36 -07:00
wrap.cpp Fixed compile issue 2014-11-21 16:56:22 +01:00

README

Frank Dellaert
October 2011

The wrap library wraps the GTSAM library into a MATLAB toolbox. 

It was designed to be more general than just wrapping GTSAM, but a small amount of 
GTSAM specific code exists in matlab.h, the include file that is included by the
mex files. The GTSAM-specific functionality consists primarily of handling of
Eigen Matrix and Vector classes.  

For notes on creating a wrap interface, see gtsam.h for what features can be 
wrapped into a toolbox, as well as the current state of the toolbox for gtsam.
For more technical details on the interface, please read comments in matlab.h

Some good things to know:

OBJECT CREATION
- Classes are created by special constructors, e.g., new_GaussianFactorGraph_.cpp.
	These constructors are called from the MATLAB class @GaussianFactorGraph.
	new_GaussianFactorGraph_ calls wrap_constructed in matlab.h, see documentation there
	
METHOD (AND CONSTRUCTOR) ARGUMENTS
- Simple argument types of methods, such as "double", will be converted in the
  mex wrappers by calling unwrap<double>, defined in matlab.h
- Vector and Matrix arguments are normally passed by reference in GTSAM, but
  in gtsam.h you need to pretend they are passed by value, to trigger the 
  generation of the correct conversion routines unwrap<Vector> and unwrap<Matrix>
- passing classes as arguments works, provided they are passed by reference.
	This triggers a call to unwrap_shared_ptr