Compatibility: Difference between revisions
Carandraug (talk | contribs) (→Are we running octave?: why are we using persistent) |
Carandraug (talk | contribs) m (→Are we running octave?: use code template) |
||
| Line 7: | Line 7: | ||
The most commonly used trick is to create a subfunction that will check whether we are running octave, and use it as condition to run selected block of code that are incompatible. Due to the persistent variable it can be called repeatedly without a heavy performance hit. | The most commonly used trick is to create a subfunction that will check whether we are running octave, and use it as condition to run selected block of code that are incompatible. Due to the persistent variable it can be called repeatedly without a heavy performance hit. | ||
{{Code|use and creation of is_octave()|<syntaxhighlight lang="matlab"> | |||
function foo | function foo | ||
%% fancy code that works in both | |||
if (is_octave) | if (is_octave) | ||
%% use octave super_powers | |||
else | else | ||
%% do it matlab way | |||
end | end | ||
%% fancy code that works in both | |||
end | end | ||
%% subfunction that checks if we are in octave | |||
function r = is_octave () | function r = is_octave () | ||
persistent x; | persistent x; | ||
| Line 25: | Line 26: | ||
r = x; | r = x; | ||
end | end | ||
end | end</syntaxhighlight>}} | ||
Revision as of 10:58, 19 April 2012
Despite best efforts by Mathworks to make matlab useful, some functionalities still only exist in octave. This page is for tricks that will help in writing code that will run in both octave and matlab.
Why?
Consider the following case. You have found some useful code that is currently matlab specific and want to port it into octave. You may need, or want, to make changes, either due to missing functions in octave or to use simpler/faster/etc octave specific functions. If you make these changes while keeping it matlab compatibility you can send the modified code, now both matlab and octave compatible, upstream. This will make contributions between the octave and matlab community easier. It will be easier to apply changes/bug fixes that both you and the upstream developer makes.
Are we running octave?
The most commonly used trick is to create a subfunction that will check whether we are running octave, and use it as condition to run selected block of code that are incompatible. Due to the persistent variable it can be called repeatedly without a heavy performance hit.
| Code: use and creation of is_octave() |
function foo
%% fancy code that works in both
if (is_octave)
%% use octave super_powers
else
%% do it matlab way
end
%% fancy code that works in both
end
%% subfunction that checks if we are in octave
function r = is_octave ()
persistent x;
if (isempty (x))
x = exist ('OCTAVE_VERSION', 'builtin');
end
r = x;
end
end
|