Potential Differences Messages
When you enable potential differences reporting, the code generator reports potential differences between the behavior of the generated code and the behavior of the MATLAB® code. Reviewing and addressing potential differences before you generate standalone code helps you to avoid errors and incorrect answers in generated code.
Here are some of the potential differences messages:
Automatic Dimension Incompatibility
In the generated code, the dimension to operate along is selected automatically, and might be different from MATLAB. Consider specifying the working dimension explicitly as a constant value.
This restriction applies to functions that take the working dimension (the dimension along which to operate) as input. In MATLAB and in code generation, if you do not supply the working dimension, the function selects it. In MATLAB, the function selects the first dimension whose size does not equal 1. For code generation, the function selects the first dimension that has a variable size or that has a fixed size that does not equal 1. If the working dimension has a variable size and it becomes 1 at run time, then the working dimension is different from the working dimension in MATLAB. Therefore, when run-time error checks are enabled, an error can occur.
For example, suppose that
X is a variable-size
matrix with dimensions
1x:3x:5. In the generated
sum(X) behaves like
sum(X) behaves like
1. In MATLAB, when
size(X,2) is 1,
To avoid this issue, specify the intended working dimension
explicitly as a constant value. For example,
mtimes No Dynamic Scalar Expansion
The generated code performs a general matrix multiplication. If a variable-size matrix operand becomes a scalar at run time, dimensions must still agree. There will not be an automatic switch to scalar multiplication.
Consider the multiplication
A*B. If the code
generator is aware that
A is scalar and
a matrix, the code generator produces code for scalar-matrix multiplication.
However, if the code generator is aware that
variable-size matrices, it produces code for a general matrix multiplication.
At run time, if
A turns out to be scalar, the generated
code does not change its behavior. Therefore, when run-time error
checks are enabled, a size mismatch error can occur.
For indexing a matrix with a matrix, matrix1(matrix2), the code generator assumed that the result would have the same size as matrix2. If matrix1 and matrix2 are vectors at run time, their orientations must match.
In matrix-matrix indexing, you use one matrix to index into another matrix. In MATLAB, the general rule for matrix-matrix indexing is that the size and orientation
of the result match the size and orientation of the index matrix. For example, if
B are matrices,
B are vectors, MATLAB applies a special rule. The special vector-vector indexing rule is that the
orientation of the result is the orientation of the data matrix. For example, if
A is 1-by-5 and
B is 3-by-1, then
A(B) is 1-by-3.
The code generator applies the same matrix-matrix indexing rules as MATLAB. If
B are variable-size matrices,
to apply the matrix-matrix indexing rules, the code generator assumes that
size(B). If, at run time,
B become vectors and have different
orientations, then the assumption is incorrect. Therefore, when run-time error checks are
enabled, an error can occur.
To avoid this issue, force your data to be a vector by using the colon operator for indexing. For example, suppose that your code intentionally toggles between vectors and regular matrices at run time. You can do an explicit check for vector-vector indexing.
... if isvector(A) && isvector(B) C = A(:); D = C(B(:)); else D = A(B); end ...
The indexing in the first branch specifies that
compile-time vectors. Therefore, the code generator applies the indexing
rule for indexing one vector with another vector. The orientation
of the result is the orientation of the data vector,
For indexing a vector with a vector, vector1(vector2), the code generator assumed that the result would have the same orientation as vector1. If vector1 is a scalar at run time, the orientation of vector2 must match vector1.
In MATLAB, the special rule for vector-vector indexing
is that the orientation of the result is the orientation of the data
vector. For example, if
A is 1-by-5 and
A(B) is 1-by-3. If, however, the data
A is a scalar, then the orientation of
the orientation of the index vector
The code generator applies the same vector-vector indexing
rules as MATLAB. If
variable-size vectors, to apply the indexing rules, the code generator
assumes that the orientation of
B matches the
A. At run time, if
scalar and the orientation of
not match, then the assumption is incorrect. Therefore, when run-time
error checks are enabled, a run-time error can occur.
To avoid this issue, make the orientations of the vectors match.
Alternatively, index single elements by specifying the row and column.
Loop Index Overflow
The generated code assumes the loop index does not overflow on the last iteration of the loop. If the loop index overflows, an infinite loop can occur.
Suppose that a
for-loop end value is equal to or close to
the maximum or minimum value for the loop index data type. In the generated code, the last
increment or decrement of the loop index might cause the index variable to overflow. The
index overflow might result in an infinite loop.
When memory integrity checks are enabled, if the code generator detects that the loop index might overflow, it reports an error. The software error checking is conservative. It might incorrectly report a loop index overflow. By default, memory-integrity checks are enabled for MEX code and disabled for standalone C/C++ code. See Why Test MEX Functions in MATLAB? (MATLAB Coder) and Generate Standalone C/C++ Code That Detects and Reports Run-Time Errors (MATLAB Coder).
To avoid a loop index overflow, use the workarounds in this table.
|Loop Conditions Causing the Potential Overflow||Workaround|
If the loop does not have to cover the full range of the integer type, rewrite the loop so that the end value is not equal to the maximum value of the integer type. For example, replace:
N=intmax('int16') for k=N-10:N
If the loop does not have to cover the full range of the integer type, rewrite the loop so that the end value is not equal to the minimum value of the integer type. For example, replace:
N=intmin('int32') for k=N+10:-1:N
If the loop must cover the full range of the integer type, cast the type of the loop start, step, and end values to a bigger integer or to double. For example, rewrite:
M= intmin('int16'); N= intmax('int16'); for k=M:N % Loop body end
M= intmin('int16'); N= intmax('int16'); for k=int32(M):int32(N) % Loop body end
Rewrite the loop so that the loop index in the last loop iteration is equal to the end value.