Merged in fix/445_matlab_wrapper_example (pull request #432)

Close issue #445

cmake/example_project/CMakeLists.txt

@@ -30,9 +30,12 @@ find_package(GTSAM REQUIRED) # Uses installed package
 ###################################################################################
 # Build static library from common sources
 set(CONVENIENCE_LIB_NAME ${PROJECT_NAME})
-add_library(${CONVENIENCE_LIB_NAME} STATIC example/PrintExamples.h example/PrintExamples.cpp)
+add_library(${CONVENIENCE_LIB_NAME} SHARED example/PrintExamples.h example/PrintExamples.cpp)
 target_link_libraries(${CONVENIENCE_LIB_NAME} gtsam)
 
+# Install library
+install(TARGETS ${CONVENIENCE_LIB_NAME} LIBRARY DESTINATION lib ARCHIVE DESTINATION lib RUNTIME DESTINATION bin)
+
 ###################################################################################
 # Build tests (CMake tracks the dependecy to link with GTSAM through our project's static library)
 gtsamAddTestsGlob("example" "tests/test*.cpp" "" "${CONVENIENCE_LIB_NAME}")

cmake/example_project/README.md

@@ -0,0 +1,32 @@
+# MATLAB Wrapper Example Project
+
+This project serves as a lightweight example for demonstrating how to wrap C++ code in MATLAB using GTSAM.
+
+## Compiling
+
+We follow the regular build procedure inside the `example_project` directory:
+
+```sh
+mkdir build && cd build
+cmake ..
+make -j8
+sudo make install
+
+sudo ldconfig  # ensures the shared object file generated is correctly loaded
+```
+
+## Usage
+
+Now you can open MATLAB and add the `gtsam_toolbox` to the MATLAB path
+
+```matlab
+addpath('/usr/local/gtsam_toolbox')
+```
+
+At this point you are ready to run the example project. Starting from the `example_project` directory inside MATLAB, simply run code like regular MATLAB, e.g.
+
+```matlab
+pe = example.PrintExamples();
+pe.sayHello();
+pe.sayGoodbye();
+```

cmake/example_project/example.h

@@ -18,11 +18,14 @@
 // This is an interface file for automatic MATLAB wrapper generation.  See
 // gtsam.h for full documentation and more examples.
 
+#include <example/PrintExamples.h>
+
 namespace example {
 
 class PrintExamples {
-  void sayHello() const;
-  void sayGoodbye() const;
+    PrintExamples();
+    void sayHello() const;
+    void sayGoodbye() const;
 };
 
 }

cmake/example_project/example/PrintExamples.h

@@ -17,6 +17,7 @@
 
 #pragma once
 
+#include <iostream>
 #include <string>
 
 namespace example {