12345qiupeng
/
gtsam
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
gtsam/wrap
History
Chris Beall 129e29d4b2 fix related to mex command 2012-06-04 22:09:33 +00:00
..
tests fix related to mex command 2012-06-04 22:09:33 +00:00
Argument.cpp Fixed handling of char in wrap, updated README 2012-06-04 19:45:32 +00:00
Argument.h Fixed argument parse error. Somehow it could parse either refs or ptrs, but noth both, and it depended on the order in which the rules were given in the argList_p. I just combined ptr and ref in one and now it works. Go figure. 2012-01-28 19:44:33 +00:00
CMakeLists.txt Fixed documentation for wrap 2012-06-04 21:14:47 +00:00
Class.cpp Added better support for "using namespace x" to wrap - only applies to classes *after* it is called 2012-05-04 19:14:58 +00:00
Class.h Added better support for "using namespace x" to wrap - only applies to classes *after* it is called 2012-05-04 19:14:58 +00:00
Constructor.cpp Wrap now only writes new files when there is a change, and install only updates files if necessary 2012-01-15 21:42:44 +00:00
Constructor.h Unified file writing to use a custom class to allow for smart checking 2012-01-15 21:42:41 +00:00
Deconstructor.cpp Memory leak fixed within wrap. Must call 'clear' before 'clear all' and 'clear classes'. Wrap now creates delete_classname files for all wrapped classes. MATLAB classes now derive from the handle superclass. 2012-03-30 05:34:23 +00:00
Deconstructor.h Memory leak fixed within wrap. Must call 'clear' before 'clear all' and 'clear classes'. Wrap now creates delete_classname files for all wrapped classes. MATLAB classes now derive from the handle superclass. 2012-03-30 05:34:23 +00:00
FileWriter.cpp No more date to avoid triggering svn changes 2012-02-06 17:18:25 +00:00
FileWriter.h Wrap now only writes new files when there is a change, and install only updates files if necessary 2012-01-15 21:42:44 +00:00
Method.cpp Forced wrap to always add a "generated by" header, updated expected test code 2012-02-06 19:45:40 +00:00
Method.h Cleanup in wrap 2011-12-11 21:09:07 +00:00
Module.cpp Added option to include path to mex executable in CMake 2012-06-04 21:01:25 +00:00
Module.h Added option to include path to mex executable in CMake 2012-06-04 21:01:25 +00:00
README Fixed handling of char in wrap, updated README 2012-06-04 19:45:32 +00:00
ReturnValue.cpp apply bug fixes in MATLAB wrapper shared_ptr return from trunk. All tests work now. 2012-02-06 03:29:14 +00:00
ReturnValue.h Unified file writing to use a custom class to allow for smart checking 2012-01-15 21:42:41 +00:00
StaticMethod.cpp Forced wrap to always add a "generated by" header, updated expected test code 2012-02-06 19:45:40 +00:00
StaticMethod.h Cleanup in wrap 2011-12-11 21:09:07 +00:00
matlab.h Fixed wrap support for unsigned char 2012-05-31 15:06:21 +00:00
spirit_actors.h Parser now handles both namespace and class headers 2011-12-15 19:39:11 +00:00
utilities.cpp Added missing header 2012-04-21 01:45:04 +00:00
utilities.h Forced wrap to always add a "generated by" header, updated expected test code 2012-02-06 19:45:40 +00:00
wrap.cpp Fixed documentation for wrap 2012-06-04 21:14:47 +00: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