{"id":13676,"date":"2022-12-23T12:09:23","date_gmt":"2022-12-23T17:09:23","guid":{"rendered":"https:\/\/blogs.mathworks.com\/simulink\/?p=13676"},"modified":"2024-04-18T15:34:50","modified_gmt":"2024-04-18T19:34:50","slug":"leveraging-generated-code-from-matlab-in-a-c-application","status":"publish","type":"post","link":"https:\/\/blogs.mathworks.com\/simulink\/2022\/12\/23\/leveraging-generated-code-from-matlab-in-a-c-application\/","title":{"rendered":"Leveraging Generated Code from MATLAB in a C++ Application"},"content":{"rendered":"
\r\n
Today I am happy to welcome guest blogger <\/span>Erin McGarrity<\/span><\/a>. The main reason why I am excited to welcome Erin as guest blogger is that he will be talking about generating C\/C++ code from MATLAB code and Simulink models using <\/span>MATLAB Coder<\/span><\/a>, <\/span>Simulink Coder<\/span><\/a> and <\/span>Embedded Coder<\/span><\/a>. While I have historically focused more on simulation-related topics on this blog, I realize that code generation is an important topic for many readers of this blog. We would like to hear in the comments below what you think of today's topic, and what other code generation related topics you would like to see covered on this blog.<\/span><\/div>\r\n

Introduction<\/h2>\r\n
Let's say we have a fancy numerical routine that we've been working on in MATLAB that we want to utilize in an external C++ application. In this post, we're going to show how we can generate a dynamic library from MATLAB code which we can call from a C++ program. This will allow us to harness some of the power of MATLAB in an external program.<\/div>\r\n

The MATLAB Code<\/h2>\r\n
To demonstrate the workflow, let's create a routine that performs a line fit to some data. This function will have 2 inputs, x<\/span> and y<\/span>, which are both vectors of data to fit. These vectors should have the same length N<\/span>. The outputs for this function are m<\/span> and b<\/span>, the slope and intercept of the line that best fits the data. We'll perform our fit by minimizing the squares of the vertical distances of the points to the line in the point-slope form which is given by this equation [1]<\/a>:<\/div>\r\n
\r\n\r\n \r\n\r\n\u03d5(m,b)=\u2009\u2211i=1N(y(i)-(m\u22c5x(i)+b))2 \r\n\r\n<\/div>\r\n
\r\n\r\nThe minimum of\r\n\r\n\u03d5(m,b)can be found using the usual technique of taking the derivative of it with respect to m<\/span> and b<\/span> and setting these to zero. Doing so gives us the following system of 2 equations:\r\n\r\n<\/div>\r\n
\r\n\r\n \r\n\r\n\u2202\u2202m\u03d5(m,b)=0=\u2211i=1N-2(y(i)-(m\u22c5x(i)+b))\u22c5x(i) \r\n\r\n<\/div>\r\n
and<\/div>\r\n
\r\n\r\n \r\n\r\n\u2202\u2202b\u03d5\u2009(m,b)=0=\u2211i=1N-2(y(i)-(m\u22c5x(i)+b))\u22c51 \r\n\r\n<\/div>\r\n
Here we have used the fact that the derivative operator and sum commute. After dividing both sides of both equations by -2, we can rearrange this system into a matrix equation<\/div>\r\n
\r\n\r\n \r\n\r\n[\u2211i=1Nx(i)2\u2211i=1Nx(i)\u2211i=1Nx(i)N]\u22c5[mb]=[\u2211i=1Nx(i)\u22c5y(i)\u2211i=1Ny(i)]. \r\n\r\n<\/div>\r\n
This system can be written in compact notation as<\/div>\r\n
\r\n\r\n \r\n\r\nH\u22c5p=f. \r\n\r\n<\/div>\r\n
To solve for $ p=[m,b]^T $<\/span> , we can multiply both sides by the inverse of H<\/span><\/div>\r\n
\r\n\r\n \r\n\r\nH-1\u22c5H\u22c5p=H-1\u22c5f, \r\n\r\n<\/div>\r\n
or simply<\/div>\r\n
\r\n\r\n \r\n\r\np=H-1\u22c5f. \r\n\r\n<\/div>\r\n
The MATLAB code to solve for m<\/span> and b<\/span> looks like this:<\/div>\r\n
\r\n
function <\/span>[m, b] = lineFitter(x,y)<\/span><\/div>\r\n
<\/div>\r\n
% Make sure x and y have the same number of elements<\/span><\/span><\/div>\r\n
assert(numel(x)==numel(y)); <\/span><\/div>\r\n
<\/div>\r\n
% Form the left hand matrix<\/span><\/span><\/div>\r\n
H = [x(:)'*x(:) sum(x(:),1);<\/span><\/div>\r\n
sum(x(:),1) numel(x)];<\/span><\/div>\r\n
<\/div>\r\n
% Form the residual<\/span><\/span><\/div>\r\n
f = [x(:)'*y(:)<\/span><\/div>\r\n
sum(y(:),1)];<\/span><\/div>\r\n
<\/div>\r\n
% Solve the system<\/span><\/span><\/div>\r\n
p = H\\f;<\/span><\/div>\r\n
<\/div>\r\n
% Assign the slopes<\/span><\/span><\/div>\r\n
m = p(1);<\/span><\/div>\r\n
b = p(2);<\/span><\/div>\r\n
end<\/span><\/span><\/div>\r\n<\/div>\r\n

Testing the Fitting Routine In MATLAB<\/h2>\r\n
To check our code, let's load some data, fit the line and plot everything.<\/div>\r\n
\r\n
\r\n
d = readmatrix(\"myData.csv\"<\/span>);<\/span><\/div>\r\n<\/div>\r\n
\r\n
x = d(:,1);<\/span><\/div>\r\n<\/div>\r\n
\r\n
y = d(:,2);<\/span><\/div>\r\n<\/div>\r\n
\r\n
% Fit the data<\/span><\/span><\/div>\r\n<\/div>\r\n
\r\n
[m,b] = lineFitter(x,y);<\/span><\/div>\r\n<\/div>\r\n
\r\n
% Create the line from the fitted parameters<\/span><\/span><\/div>\r\n<\/div>\r\n
\r\n
xgrid = 0:0.1:1;<\/span><\/div>\r\n<\/div>\r\n
\r\n
ygrid = m*xgrid + b;<\/span><\/div>\r\n<\/div>\r\n
\r\n
% Plot everything<\/span><\/span><\/div>\r\n<\/div>\r\n
\r\n
figure;clf<\/span><\/div>\r\n<\/div>\r\n
\r\n
scatter(x,y);<\/span><\/div>\r\n<\/div>\r\n
\r\n
hold all<\/span><\/span><\/div>\r\n<\/div>\r\n
\r\n
plot(xgrid, ygrid, \"LineWidth\"<\/span>, 2);<\/span><\/div>\r\n
\r\n
\r\n
<\/div>\r\n
<\/div>\r\n
<\/div>\r\n
<\/div>\r\n<\/div>\r\n<\/div>\r\n<\/div>\r\n<\/div>\r\n

Generate Code for the Fitting Routine<\/h2>\r\n
Now we can generate code and everything we'll need to create a dynamic library from our lineFitter<\/span> routine. We will use coder.config<\/a> and coder.typeof<\/a><\/div>\r\n
\r\n
\r\n
% Set up coder object for a dynamic library<\/span><\/span><\/div>\r\n<\/div>\r\n
\r\n
cfg = coder.config('dll'<\/span>);<\/span><\/div>\r\n<\/div>\r\n
\r\n
cfg.Verbosity='Verbose'<\/span>;<\/span><\/div>\r\n<\/div>\r\n
\r\n
cfg.GenCodeOnly = true;<\/span><\/div>\r\n<\/div>\r\n
\r\n
<\/div>\r\n<\/div>\r\n
\r\n
% Create sample variables for the inputs. We want to make these inputs<\/span><\/span><\/div>\r\n<\/div>\r\n
\r\n
% dynamically sized because we may have arbitrarily sized data files.<\/span><\/span><\/div>\r\n<\/div>\r\n
\r\n
xarg = coder.typeof(1.0, [10000, 1], [1, 0]);<\/span><\/div>\r\n<\/div>\r\n
\r\n
yarg = coder.typeof(1.0, [10000, 1], [1, 0]);<\/span><\/div>\r\n<\/div>\r\n
\r\n
<\/div>\r\n<\/div>\r\n
\r\n
% Generate the code and a report<\/span><\/span><\/div>\r\n<\/div>\r\n
\r\n
codegen -config cfg lineFitter.m -args {xarg,yarg} -nargout 2 -report <\/span><\/span><\/div>\r\n
\r\n
\r\n
### Compiling function(s) lineFitter ...\r\n------------------------------------------------------------------------\r\nCompilation suppressed: generating code only.\r\n------------------------------------------------------------------------\r\n### Generating compilation report ...\r\nCode generation successful: View report<\/div>\r\n<\/div>\r\n<\/div>\r\n<\/div>\r\n<\/div>\r\n
The code generation report in MATLAB R2022b has a neat feature called \"Trace Code<\/a>\" that shows what MATLAB code corresponds to what C code:<\/div>\r\n
\"\"<\/div>\r\n
The relevant code that we'll need later is the interface to lineFitter<\/span>. The key code is in lineFitter.h<\/span>:<\/div>\r\n
\r\n
\/* Function Declarations *\/<\/span><\/div>\r\n
extern void lineFitter(const emxArray_real_T *x, const emxArray_real_T *y,<\/span><\/div>\r\n
double *m, double *b);<\/span><\/div>\r\n<\/div>\r\n
The inputs are constant array pointers and the outputs are pointers to doubles. This will guide our client-side implementation as we will show below.<\/div>\r\n

Packaging the Code<\/h2>\r\n
Now that we have our code, we can use codebuild<\/span><\/a> and packNgo<\/span><\/a> to generate and package build artifacts that we can take over to our client application. In this case we'll use the CMake<\/span> and SHARED_LIBRARY<\/span> options to codebuild so that we'll be able to use the CMake program<\/a> to build everything on our client side. CMake is a tool that allows us to perform platform independent compilation of our code. In short, we can provide CMake with a list of things to build and it will perform all the checks and compilation for us.<\/div>\r\n
\r\n
\r\n
codebuild('.\/codegen\/dll\/lineFitter'<\/span>, 'BuildMethod'<\/span>, 'CMake'<\/span>, 'BuildVariant'<\/span>, 'SHARED_LIBRARY'<\/span>);<\/span><\/div>\r\n<\/div>\r\n
\r\n
packNGo('.\/codegen\/dll\/lineFitter'<\/span>, 'PackType'<\/span>, 'hierarchical'<\/span>, 'fileName'<\/span>, 'lineFitter'<\/span>);<\/span><\/div>\r\n<\/div>\r\n<\/div>\r\n
This generates an archive file lineFitter.zip<\/span>, which we can copy to our client codebase.<\/div>\r\n

Create the Dynamic Library<\/h2>\r\n
Now that we have our code, we're ready to build it and create a routine to link to it on the client machine. After that we can add the code we need to call our line fitting routine in the client code. Let's say we put our newly generated lineFitter.zip<\/span> here and unzip everything. Unzipping lineFitter.zip<\/span> will produce two files, mlrFiles.zip<\/span> and sDirFiles.zip<\/span>. Unzipping these will create two directories, R2022b and codegen.<\/div>\r\n
\r\n
C:\\work\\lineFitExample> dir \/w<\/span><\/div>\r\n
[codegen] lineFitter.zip mlrFiles.zip [R2022b] sDirFiles.zip<\/span><\/div>\r\n<\/div>\r\n
These contain the required MATLAB headers and our generated code, respectively. To build these, we'll create a directory called build_lib, then call cmake with the following commands [2]<\/a> (their results are shown as well):<\/div>\r\n
\r\n
C:\\work\\lineFitExample> mkdir build_lib<\/span><\/div>\r\n
<\/div>\r\n
C:\\work\\LineFitExample> cmake -G \"NMake Makefiles\" -B .\/build_lib -DCMAKE_BUILD_TYPE=Release -DMATLAB_ROOT=.\/R2022b -S.\/codegen\/dll\/lineFitter<\/span><\/div>\r\n
-- The C compiler identification is MSVC 19.29.30137.0<\/span><\/div>\r\n
<snip><\/span><\/div>\r\n
-- Build files have been written to: C:\/work\/LineFitExample\/build_lib<\/span><\/div>\r\n
<\/div>\r\n
C:\\work\\LineFitExample> cmake --build build_lib<\/span><\/div>\r\n
[8\/8] Linking CXX shared library codegen\\dll\\lineFitter\\lineFitter_win64.dll<\/span><\/div>\r\n
\\#\\#\\# Created library: C:\/work\/LineFitExample\/build_lib\/codegen\/dll\/lineFitter\/lineFitter_win64.dll<\/span><\/div>\r\n<\/div>\r\n

Using the Dynamic Library<\/h2>\r\n
Now that we have generated our dynamic library lineFitter_win64.dll<\/span>, it's time to create the application code that will use the lineFitter<\/span> routine. Our client application reads in the csv file and places the columns into two lists:<\/div>\r\n
\"\"<\/div>\r\n
To make this code interface with our newly created dynamic library we need to allocate our arrays. These arrays are of type emx_Array_real_T<\/span> as shown above. We'll write a function to do the allocation, but first we'll include two header files that we'll need:<\/div>\r\n
\r\n
#include \"lineFitter.h\"<\/span><\/div>\r\n
#include \"lineFitter_emxAPI.h\"<\/span><\/div>\r\n<\/div>\r\n
Now we're ready to write our array allocation function, which we'll place above the main routine. This function takes a list of doubles and copies it into an emxArray_real_T<\/span> that has been allocated to the proper size. An example of this code can be found in the directory .\\codegen\\dll\\lineFitter\\examples\\main.c<\/span>.<\/div>\r\n
\"ArrayHelperFunc.png\"<\/div>\r\n
Finally, we'll add the calls to allocate our vectors and solve the system below the reading code in the main routine but before the final return statement:<\/div>\r\n
\"LineFitCode.png\"<\/div>\r\n
Our CMakeLists.txt file for our client looks like this:<\/div>\r\n
\"CMakeFile.png\"<\/div>\r\n
Now we're ready to compile our client application. You can download the resulting files here: CMakeLists.txt<\/span><\/a> and myFit.cpp<\/span><\/a>. You'll also need the data file, which is here in myData.csv<\/span><\/a>.<\/div>\r\n
The procedure is similar to compiling the library above, which is part of the appeal of CMake. The commands are:<\/div>\r\n
\r\n
C:\\work\\LineFitExample> mkdir build<\/span><\/div>\r\n
<\/div>\r\n
C:\\work\\LineFitExample> cmake -G \"NMake Makefiles\" -B build -S . -DCMAKE_BUILD_TYPE=Release<\/span><\/div>\r\n
-- The C compiler identification is MSVC 19.29.30137.0<\/span><\/div>\r\n
<snip><\/span><\/div>\r\n
-- Build files have been written to: C:\/work\/LineFitExample\/build<\/span><\/div>\r\n
<\/div>\r\n
C:\\work\\LineFitExample> cmake --build build<\/span><\/div>\r\n
[2\/2] Linking CXX executable myFit.exe<\/span><\/div>\r\n<\/div>\r\n
<\/div>\r\n
Now we have our executable, myFit.exe in the build directory. The final steps to test our code are:<\/div>\r\n
\r\n
C:\\work\\LineFitExample> set PATH=C:\\work\\LineFitExample\\build_lib\\codegen\\dll\\lineFitter\\;%PATH%<\/span><\/div>\r\n
<\/div>\r\n
C:\\work\\LineFitExample> .\\build\\myFit.exe myData.csv<\/span><\/div>\r\n
m,b = 4.04926, -0.0246821<\/span><\/div>\r\n<\/div>\r\n
As we can see, the slope and intercept are the same as what we got in MATLAB.<\/div>\r\n

Notes<\/h2>\r\n
[1] This method is used for illustration purposes only. In production, you should use polyfit<\/span><\/a> to solve this problem.<\/div>\r\n
[2] In this example, we use Visual Studio tools to compile the code. To set this up for the command line, I ran the script:<\/div>\r\n
C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\Professional\\VC\\Auxiliary\\Build\\vcvars64.bat<\/div>\r\n

Now it's your turn<\/h2>\r\n
We hope you enjoyed this example. Soon we will follow up with a more complex example building on this foundation. If there are other Coder related topics you would like to see covered on the blog, let us know in the comment below.<\/div>\r\n
<\/div>\r\n<\/div>\r\n