gtsam/wrap
Andrew Melim 84a806bf39 Final fixes made for wrap comments 2012-08-29 20:27:10 +00:00
..
tests Final fixes made for wrap comments 2012-08-29 20:27:10 +00:00
Argument.cpp Wrap generates Matlab namespaces, so now 'import gtsam.*' allows class names like Values, NonlinearFactor, to be used. Without import, syntax is gtsam.Values, etc. 2012-07-18 15:47:06 +00:00
Argument.h Code cleanup and comments 2012-07-12 22:28:28 +00:00
CMakeLists.txt Small cleanups / fixes in handling of compile options 2012-07-13 21:55:00 +00:00
Class.cpp Final fixes made for wrap comments 2012-08-29 20:27:10 +00:00
Class.h Wrap comments are now EVEN better 2012-08-28 21:44:45 +00:00
Constructor.cpp Removed from wrap the use of "using namespace xxx" statements - wasn't fully supported before, and now we have real namespace support 2012-07-23 18:24:43 +00:00
Constructor.h Removed from wrap the use of "using namespace xxx" statements - wasn't fully supported before, and now we have real namespace support 2012-07-23 18:24:43 +00:00
Deconstructor.cpp Removed from wrap the use of "using namespace xxx" statements - wasn't fully supported before, and now we have real namespace support 2012-07-23 18:24:43 +00:00
Deconstructor.h Removed from wrap the use of "using namespace xxx" statements - wasn't fully supported before, and now we have real namespace support 2012-07-23 18:24:43 +00:00
FileWriter.cpp Added overload constructor comments to matlab files 2012-08-26 15:46:19 +00:00
FileWriter.h Fixed emit of comment string 2012-06-06 04:28:50 +00:00
ForwardDeclaration.h Added missing files from last commit - code cleanup and comments 2012-07-13 21:54:48 +00:00
GlobalFunction.cpp Some additional cleanup in wrap 2012-07-23 18:24:39 +00:00
GlobalFunction.h Some additional cleanup in wrap 2012-07-23 18:24:39 +00:00
Method.cpp Final fixes made for wrap comments 2012-08-29 20:27:10 +00:00
Method.h Even more comment improvements for wrap 2012-08-27 15:19:55 +00:00
Module.cpp Even more comment improvements for wrap 2012-08-27 15:19:55 +00:00
Module.h Some additional cleanup in wrap 2012-07-23 18:24:39 +00:00
README Fixed handling of char in wrap, updated README 2012-06-04 19:45:32 +00:00
ReturnValue.cpp Fixed typo and prevented double-evaluation of function when returning a pair in a wrapped function 2012-07-26 14:06:37 +00:00
ReturnValue.h Some additional cleanup in wrap 2012-07-23 18:24:39 +00:00
StaticMethod.cpp Final fixes made for wrap comments 2012-08-29 20:27:10 +00:00
StaticMethod.h Wrap comments are now EVEN better 2012-08-28 21:44:45 +00:00
TemplateInstantiationTypedef.cpp Added 'This' keyword in wrap templates to substitute instantiated class 2012-07-23 21:27:36 +00:00
TemplateInstantiationTypedef.h Added missing files from last commit - code cleanup and comments 2012-07-13 21:54:48 +00:00
TypeAttributesTable.cpp Added missing files from last commit - code cleanup and comments 2012-07-13 21:54:48 +00:00
TypeAttributesTable.h Added missing files from last commit - code cleanup and comments 2012-07-13 21:54:48 +00:00
matlab.h Improved error message 2012-07-13 21:59:30 +00:00
spirit_actors.h Parser now handles both namespace and class headers 2011-12-15 19:39:11 +00:00
utilities.cpp In wrap tests, read file in text mode to translate line endings 2012-07-23 19:29:57 +00:00
utilities.h Removed from wrap the use of "using namespace xxx" statements - wasn't fully supported before, and now we have real namespace support 2012-07-23 18:24:43 +00:00
wrap.cpp Removed obsolete code for generating matlab wrapper makefiles and build script 2012-07-05 14:04:51 +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