Table of Contents

Compatibility Guidelines for MATLAB Compiler

Table of Contents

Introduction

• MATLAB path
• Scripts
• Pragma required
• Functional differences
• Unsupported functions

Introduction

The goal of this set of coding standards that can be automatically checked is to help you write MATLAB code that is Compiler-compatible. The resulting code will be more suitable for deployment using the MATLAB Compiler. For more information on MATLAB Compiler, see the MathWorks website.

If you are looking for more generic coding standards that are not specifically aimed at Coder-compatibility, see our MonkeyProof Coding Standard for MATLAB.

Automatic compliance checking

The coding standards described here can be checked using CC4M by MonkeyProof Solutions. They are configured in the predefined CoderCompatibility configurations set available with the tool. For instructions on how to check your code against coding standards, see the video below. The steps are also described below the video.

You can check your code for compliance with the guidelines described here as follows:

1. Get CC4M and install per installation instructions.
2. Open CC4M in one of two ways:
   • Click the shortcut created at the top of the screen next to the documentation search bar: .
   • Run monkeyproof.cc4m.start() from the command window.
3. Select whether you want to check one or more files, all files in a folder, or all files in a MATLAB Project.
4. Select what files/folder/project to check.
5. Further customization is available, for example checking a folder including or excluding all subfolders.
6. Click the Run button at the bottom to start checking your code.

The guidelines that require human judgment or are simply not possible to check statically in MATLAB are not described here.

Guideline template

Every guideline is structured as follows:

Guideline name

avoid

<< a section with examples on what to avoid >>

instead use

<< a section with examples on how to code properly >>

MATLAB path

avoid

Avoid calling the following functions, as they manipulate either the MATLAB path or the Java Class path:

addpath(_)
rmpath(_)
path(_)
javaaddpath(_) 
javarmpath(_)
javaclasspath(_)

instead use

As a deployed application can not adapt the MATLAB or Java class path, the definition of these paths should be separated from the code that will be deployed. For example, have a separate script or function, or use MATLAB Projects, to manages the path during development.

Scripts

Pragma required

avoid

[file] = feval('myfun', ...));

instead use

%#function myfun
[file] = feval('myfun', ...));

An alternative to using the pragma is the -a option for the mcc command. See MathWorks documentation.

Note: currently CC4M only highlights the calls to feval and eval, manual verification if the #function pragma is used, is still required.

Functional differences

manual review required

The following table shows the reviewing aspect.

Unsupported functions