gtsam/wrap
Duy-Nguyen Ta 948e6262db first version ever compiled.
... Not without some changes:
- add traits<size_t> in Key.h
- add these to JacobianFactor:
    explicit JacobianFactor(const Eigen::Map<Vector>& b_in);
    Vector py_getb() { return getb(); }
    Matrix py_getA() { return getA(); }
---------
... Remaining corner cases:
 ☐ Eigency: Map[] to Block
 ☐ Eigency: ambiguous call: A(const T&) A(const Vector& v) and Eigency A(Map[Vector]& v)
 ☐ Fix return properly
   ☐ handle pair
 ☐ Fix method template of Vector/Matrix: template argument is [Vector] while arugment is Map[Vector]
 ☐ Constructor: generate default constructor? (hack: if it's serializable?)
 ☐ Constructor: ambiguous construct from Vector/Matrix
 ☐ Key and size_t: traits<size_t> doesn't exist
 ☐ [Nice to have] Auto delete duplicate methods in derived class
2016-09-10 19:50:12 -04:00
..
tests first version ever compiled. 2016-09-10 19:50:12 -04:00
Argument.cpp first version ever compiled. 2016-09-10 19:50:12 -04:00
Argument.h pyx class methods with arguments/return type casting 2016-09-09 18:37:48 -04:00
CMakeLists.txt
Class.cpp first version ever compiled. 2016-09-10 19:50:12 -04:00
Class.h ctypedefs for all instantiated classes 2016-09-09 21:50:55 -04:00
Constructor.cpp first version ever compiled. 2016-09-10 19:50:12 -04:00
Constructor.h check if default constructor exists. Autogenerate copy constructor by default 2016-09-10 19:44:53 -04:00
Deconstructor.cpp Removed headers 2016-05-22 14:22:36 -07:00
Deconstructor.h
FileWriter.cpp
FileWriter.h
ForwardDeclaration.h
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
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
Method.cpp first version ever compiled. 2016-09-10 19:50:12 -04:00
Method.h pyx class methods with arguments/return type casting 2016-09-09 18:37:48 -04:00
MethodBase.cpp Removed headers 2016-05-22 14:22:36 -07:00
MethodBase.h
Module.cpp first version ever compiled. 2016-09-10 19:50:12 -04:00
Module.h add headers, small refactor, test FastContainers 2016-09-09 22:28:15 -04: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 first version ever compiled. 2016-09-10 19:50:12 -04:00
README
ReturnType.cpp first version ever compiled. 2016-09-10 19:50:12 -04:00
ReturnType.h pyx class methods with arguments/return type casting 2016-09-09 18:37:48 -04:00
ReturnValue.cpp first version ever compiled. 2016-09-10 19:50:12 -04:00
ReturnValue.h pyx class methods with arguments/return type casting 2016-09-09 18:37:48 -04:00
StaticMethod.cpp first version ever compiled. 2016-09-10 19:50:12 -04:00
StaticMethod.h pyx wrapper for static methods 2016-09-09 16:39:47 -04: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 ctypedefs for all instantiated classes 2016-09-09 21:50:55 -04:00
TemplateInstantiationTypedef.h
TemplateMethod.cpp emit methods to pxd, change the way template methods are handled 2016-09-09 07:26:11 -04:00
TemplateMethod.h emit methods to pxd, change the way template methods are handled 2016-09-09 07:26:11 -04:00
TemplateSubstitution.h
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
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 [inprogress] cython wrapper 2016-09-08 13:33:32 -04: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 call new function name 2016-09-10 19:45:50 -04: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