matlabtest.coder.results.BuildResults Class

R2026b

Namespace: matlabtest.coder.results

Generated C/C++ code build results in equivalence tests

Since R2023a

Description

Objects of the matlabtest.coder.results.BuildResults class contain the build results for C/C++ code in a MATLAB^® Test™ generated C/C++ code equivalence test.

The matlabtest.coder.results.BuildResults class is a handle class.

Creation

Create an instance of matlabtest.coder.results.BuildResults by using the build function for matlabtest.coder.TestCase or the build function for matlabtest.coder.MATLABCoderTester in a generated C/C++ code equivalence test.

Properties

Function — File path of built function

cell array

File path of the built function, returned as a cell array.

Example: {'C:\Users\jdoe\EquivalenceTests\myAdd.m'}

Attributes:

GetAccess	public
SetAccess	immutable

BuildType — Code generation target build type

'MEX' | 'LIB' | 'DLL'

Code generation target build type, returned as 'MEX', 'LIB', or 'DLL'.

Attributes:

GetAccess	public
SetAccess	immutable

Data Types: char

WorkingDirectory — Directory created for code generation

character vector

Directory created for code generation, returned as a character vector.

Example: 'C:\Users\jdoe\AppData\Local\Temp\tp68ab0c12_ae1f'

Attributes:

GetAccess	public
SetAccess	immutable

BuildDirectory — Location of generated files

character vector

Location of generated files, returned as a character vector.

Example: 'C:\Users\jdoe\AppData\Local\Temp\tp68ab0c12_ae1f\codegen\mex\myAdd'

Attributes:

GetAccess	public
SetAccess	immutable

BuildLog — Code generation log

character vector

Code generation log, returned as a character vector.

Attributes:

GetAccess	public
SetAccess	immutable

TargetDerivative — File path for MEX function or C/C++ library

character vector

File path for the MEX function or C/C++ library, returned as a character vector.

Example: 'C:\Users\jdoe\AppData\Local\Temp\tp68ab0c12_ae1f\codegen\mex\myAdd\myAdd_mex.mexw64'

Attributes:

GetAccess	public
SetAccess	immutable

VerificationMEX — MEX function to use for verification

character vector

MEX function to use for verification, returned as a character vector.

Example: 'C:\Users\jdoe\AppData\Local\Temp\tp68ab0c12_ae1f\codegen\mex\myAdd\myAdd_mex.mexw64'

Example: 'C:\Users\jdoe\AppData\Local\Temp\tp68ab0c12_ae1f\codegen\mex\myAdd\myAdd_sil.mexw64'

Attributes:

GetAccess	public
SetAccess	immutable

Examples

Generate and Test C Code for Equivalence

This example shows how to generate C code from a MATLAB function and test for equivalence by using MATLAB Coder™.

The function myAdd takes two numbers as inputs, adds them together, and outputs the result.

function y = myAdd(a,b) %#codegen
y = a+b;
end

This class definition file defines an equivalence test case that inherits from matlabtest.coder.TestCase. The test case in the methods block defines a test case that:

1. Builds C code from the myAdd function with inputs set to (0,0)

2. Executes the C code with inputs set to (1,2)

3. Verifies the execution of the C code against the execution of the MATLAB function myAdd with the same inputs and an absolute tolerance of 0.01

classdef tEquivalence< matlabtest.coder.TestCase
    methods (Test)
        function tMyAdd(testCase)
            buildResults = build(testCase,"myAdd", ...
                Inputs={0,0});         
            executionResults = execute(testCase,buildResults, ...
                Inputs={1,2});
            verifyExecutionMatchesMATLAB(testCase,executionResults, ...
                AbsTol=0.01)
        end
    end
end

Run the tMyAdd test.

runtests("tEquivalence", ...
    procedureName="tMyAdd")

Running tMyAdd
..
Done tMyAdd
__________


ans = 
  TestResult with properties:

          Name: 'tEquivalence/tMyAdd'
        Passed: 1
        Failed: 0
    Incomplete: 0
      Duration: 2.6670
       Details: [1×1 struct]

Totals:
   1 Passed, 0 Failed, 0 Incomplete.
   2.667 seconds testing time.

Tips

• You can also run an equivalence test on C/C++ code by generating the code outside of a test and pass the folder path or MEX file as an input to the execute method.

Version History

Introduced in R2023a