Classes | Macros | Functions | Variables
matlab.h File Reference

Contains generic global functions designed particularly for the matlab interface. More...

#include <gtsam/base/Vector.h>
#include <gtsam/base/Matrix.h>
#include <gtsam/geometry/Point2.h>
#include <gtsam/geometry/Point3.h>
#include <mex.h>
#include <boost/shared_ptr.hpp>
#include <boost/make_shared.hpp>
#include <list>
#include <string>
#include <sstream>
#include <typeinfo>
#include <set>
#include <streambuf>
Include dependency graph for matlab.h:

Go to the source code of this file.

Classes

class  mstream
 

Macros

#define GTSAM_MAGIC_GAUSSIAN
 
#define mxUINT32OR64_CLASS   mxUINT32_CLASS
 

Functions

void checkArguments (const string &name, int nargout, int nargin, int expected)
 
void checkScalar (const mxArray *array, const char *str)
 
mxArray * create_object (const std::string &classname, void *pointer, bool isVirtual, const char *rttiName)
 
void error (const char *str)
 
template<typename T >
T myGetScalar (const mxArray *array)
 
mxArray * scalar (mxClassID classid)
 
template<typename T >
T unwrap (const mxArray *array)
 
template<>
bool unwrap< bool > (const mxArray *array)
 
template<>
char unwrap< char > (const mxArray *array)
 
template<>
double unwrap< double > (const mxArray *array)
 
template<>
gtsam::Matrix unwrap< gtsam::Matrix > (const mxArray *array)
 
template<>
gtsam::Point2 unwrap< gtsam::Point2 > (const mxArray *array)
 
template<>
gtsam::Point3 unwrap< gtsam::Point3 > (const mxArray *array)
 
template<>
gtsam::Vector unwrap< gtsam::Vector > (const mxArray *array)
 
template<>
int unwrap< int > (const mxArray *array)
 
template<>
size_t unwrap< size_t > (const mxArray *array)
 
template<>
string unwrap< string > (const mxArray *array)
 
template<>
unsigned char unwrap< unsigned char > (const mxArray *array)
 
template<typename Class >
boost::shared_ptr< Classunwrap_shared_ptr (const mxArray *obj, const string &propertyName)
 
template<typename Class >
mxArray * wrap (const Class &value)
 
template<>
mxArray * wrap< bool > (const bool &value)
 
template<>
mxArray * wrap< char > (const char &value)
 
template<>
mxArray * wrap< double > (const double &value)
 
template<>
mxArray * wrap< gtsam::Matrix > (const gtsam::Matrix &A)
 
template<>
mxArray * wrap< gtsam::Point2 > (const gtsam::Point2 &v)
 
template<>
mxArray * wrap< gtsam::Point3 > (const gtsam::Point3 &v)
 
template<>
mxArray * wrap< gtsam::Vector > (const gtsam::Vector &v)
 
template<>
mxArray * wrap< int > (const int &value)
 
template<>
mxArray * wrap< size_t > (const size_t &value)
 
template<>
mxArray * wrap< string > (const string &value)
 
template<>
mxArray * wrap< unsigned char > (const unsigned char &value)
 
mxArray * wrap_Matrix (const gtsam::Matrix &A)
 
template<typename Class >
mxArray * wrap_shared_ptr (boost::shared_ptr< Class > shared_ptr, const std::string &matlabName, bool isVirtual)
 
mxArray * wrap_Vector (const gtsam::Vector &v)
 

Variables

static const boost::uint64_t ptr_constructor_key
 

Detailed Description

Contains generic global functions designed particularly for the matlab interface.

header file to be included in MATLAB wrappers

Author
Stephen Williams
Date
2008
Author
Frank Dellaert
Alex Cunningham
Andrew Melim
Richard Roberts

wrapping and unwrapping is done using specialized templates, see http://www.cplusplus.com/doc/tutorial/templates.html

Definition in file matlab.h.

Macro Definition Documentation

#define GTSAM_MAGIC_GAUSSIAN

Definition at line 54 of file matlab.h.

#define mxUINT32OR64_CLASS   mxUINT32_CLASS

Definition at line 61 of file matlab.h.

Function Documentation

void checkArguments ( const string &  name,
int  nargout,
int  nargin,
int  expected 
)

Definition at line 116 of file matlab.h.

void checkScalar ( const mxArray *  array,
const char *  str 
)

Definition at line 90 of file matlab.h.

mxArray* create_object ( const std::string &  classname,
void *  pointer,
bool  isVirtual,
const char *  rttiName 
)

Definition at line 397 of file matlab.h.

void error ( const char *  str)

Definition at line 81 of file matlab.h.

template<typename T >
T myGetScalar ( const mxArray *  array)

Definition at line 260 of file matlab.h.

mxArray* scalar ( mxClassID  classid)

Definition at line 85 of file matlab.h.

template<typename T >
T unwrap ( const mxArray *  array)

Definition at line 241 of file matlab.h.

template<>
bool unwrap< bool > ( const mxArray *  array)

Definition at line 274 of file matlab.h.

template<>
char unwrap< char > ( const mxArray *  array)

Definition at line 281 of file matlab.h.

template<>
double unwrap< double > ( const mxArray *  array)

Definition at line 309 of file matlab.h.

template<>
gtsam::Matrix unwrap< gtsam::Matrix > ( const mxArray *  array)

Definition at line 368 of file matlab.h.

template<>
gtsam::Point2 unwrap< gtsam::Point2 > ( const mxArray *  array)

Definition at line 333 of file matlab.h.

template<>
gtsam::Point3 unwrap< gtsam::Point3 > ( const mxArray *  array)

Definition at line 350 of file matlab.h.

template<>
gtsam::Vector unwrap< gtsam::Vector > ( const mxArray *  array)

Definition at line 316 of file matlab.h.

template<>
int unwrap< int > ( const mxArray *  array)

Definition at line 295 of file matlab.h.

template<>
size_t unwrap< size_t > ( const mxArray *  array)

Definition at line 302 of file matlab.h.

template<>
string unwrap< string > ( const mxArray *  array)

Definition at line 250 of file matlab.h.

template<>
unsigned char unwrap< unsigned char > ( const mxArray *  array)

Definition at line 288 of file matlab.h.

template<typename Class >
boost::shared_ptr<Class> unwrap_shared_ptr ( const mxArray *  obj,
const string &  propertyName 
)

Definition at line 468 of file matlab.h.

template<typename Class >
mxArray* wrap ( const Class value)

Definition at line 129 of file matlab.h.

template<>
mxArray* wrap< bool > ( const bool &  value)

Definition at line 159 of file matlab.h.

template<>
mxArray* wrap< char > ( const char &  value)

Definition at line 143 of file matlab.h.

template<>
mxArray* wrap< double > ( const double &  value)

Definition at line 183 of file matlab.h.

template<>
mxArray* wrap< gtsam::Matrix > ( const gtsam::Matrix A)

Definition at line 230 of file matlab.h.

template<>
mxArray* wrap< gtsam::Point2 > ( const gtsam::Point2 v)

Definition at line 204 of file matlab.h.

template<>
mxArray* wrap< gtsam::Point3 > ( const gtsam::Point3 v)

Definition at line 210 of file matlab.h.

template<>
mxArray* wrap< gtsam::Vector > ( const gtsam::Vector v)

Definition at line 198 of file matlab.h.

template<>
mxArray* wrap< int > ( const int value)

Definition at line 175 of file matlab.h.

template<>
mxArray* wrap< size_t > ( const size_t value)

Definition at line 167 of file matlab.h.

template<>
mxArray* wrap< string > ( const string &  value)

Definition at line 137 of file matlab.h.

template<>
mxArray* wrap< unsigned char > ( const unsigned char &  value)

Definition at line 151 of file matlab.h.

mxArray* wrap_Matrix ( const gtsam::Matrix A)

Definition at line 215 of file matlab.h.

template<typename Class >
mxArray* wrap_shared_ptr ( boost::shared_ptr< Class shared_ptr,
const std::string &  matlabName,
bool  isVirtual 
)

Definition at line 454 of file matlab.h.

mxArray* wrap_Vector ( const gtsam::Vector v)

Definition at line 188 of file matlab.h.

Variable Documentation

const boost::uint64_t ptr_constructor_key
static
Initial value:
=
(boost::uint64_t('G') << 56) |
(boost::uint64_t('T') << 48) |
(boost::uint64_t('S') << 40) |
(boost::uint64_t('A') << 32) |
(boost::uint64_t('M') << 24) |
(boost::uint64_t('p') << 16) |
(boost::uint64_t('t') << 8) |
unsigned __int64 uint64_t
Definition: ms_stdint.h:95

Definition at line 67 of file matlab.h.



gtsam
Author(s):
autogenerated on Sat May 8 2021 02:51:32