Guidelines for writing clean and fast code in MATLAB
Editor's Note: This file was selected as MATLAB Central Pick of the Week
This document is aimed at all MATLAB users who are already familiar with the syntax but may not yet know the each and every pitfall of MATLAB programming. Its goal is to give a number of hints which enable the reader to write quality MATLAB programs and to avoid commonly made mistakes.
There are three major independent chapters which may very well be read separately. Also, the individual chapters each split up into one or two handful of chunks of information. In that sense, this document is really a slightly extended list of dos and don’ts.
This guide is written as part of a basic course in numerical analysis, most examples and codes will hence tend to refer to numerical integration or differential equations. However, almost all aspects are of general nature and will also be of interest to anyone using MATLAB.
Feel free to contribute at https://github.com/nschloe/matlab-guidelines.
Cite As
Nico Schlömer (2021). Guidelines for writing clean and fast code in MATLAB (https://www.mathworks.com/matlabcentral/fileexchange/22943-guidelines-for-writing-clean-and-fast-code-in-matlab), MATLAB Central File Exchange. Retrieved .
Comments and Ratings (18)
MATLAB Release Compatibility
Platform Compatibility
Windows macOS LinuxCategories
Tags
Acknowledgements
Inspired by: Writing Fast MATLAB Code
Inspired: MATLAB Coding Checklist, Function To Generate Truth Table Condition Vectors
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!
Start Hunting!Discover Live Editor
Create scripts with code, output, and formatted text in a single executable document.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
Select web siteYou can also select a web site from the following list:
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)
Generally very sound advice, with concrete illustrations in code.
Personally I prefer not to include helper functions within other functions, unless the helper function is a short "anonymous function":
http://au.mathworks.com/help/matlab/matlab_prog/anonymous-functions.html?s_tid=doc_12b
One other tip: besides building "fences", now in MATLAB you can identify "code sections" by use of two consecutive percent symbols (%%), which acts something like a 'super comment'. When opened in MATLAB, the code sections are visually distinct, and can easily be run separately in a 'procedural' script (less easily in a function).
http://au.mathworks.com/help/matlab/matlab_prog/run-sections-of-programs.html?searchHighlight=section%20comment
@Mark Mikofski Definitely a good idea to add this.
Julia (http://www.julialang.com) is a new language that has the potential to be an alternative to MATLAB. It is targeted at MATLAB users, but it's speed approaches native C, is open-source (as in free beer) and has parallelism built in. Python has obviously been around longer, but Julia out performs Python by a order of magnitude.
nice, clear, overview, worthy to read
Good clearly presented examples make this easy to read but still informative. Will be useful for people new to Matlab (and I learnt a few things from it too!).