addEntryPointFunction

Class: matlabtest.coder.MATLABCoderTester
Namespace: matlabtest.coder

Add entry-point function or signature to formal generated C/C++ equivalence tester

Since R2023a

Syntax

addEntryPointFunction(tester,entryPoint)

addEntryPointFunction(tester,entryPoint,buildInputs)

Description

addEntryPointFunction(tester,entryPoint) adds the entry-point function entryPoint to the equivalence tester tester. Use this syntax if your entry-point function has no inputs.

addEntryPointFunction(tester,entryPoint,buildInputs) adds the entry-point function with the function signature defined by buildInputs.

Input Arguments

tester — Equivalence tester

matlabtest.coder.MATLABCoderTester object

Equivalence tester, specified as a matlabtest.coder.MATLABCoderTester object.

entryPoint — Entry-point function name

string scalar | character vector

Entry-point function name, specified as a string scalar or character vector.

Example: "myAdd"

buildInputs — Build-time inputs

cell array

Build-time inputs, specified as a cell array. Each element in the cell array corresponds to an input to the function.

Example: {1,2}

Examples

Generate C Code from Multiple Functions with Different Signatures and Test for Equivalence

This example shows how to generate C code from multiple MATLAB^® functions with different signatures and test them for equivalence by using the equivalence tester matlabtest.coder.MATLABCoderTester.

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

The function helloWorld displays a string of text.

function y = helloWorld 
y = "Hello World!";
end

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

1. Imports the equivalence tester matlabtest.coder.MATLABCoderTester, the constraint matlabtest.constraints.ExecutionMatchesMATLAB, and the constraint matlab.unittest.constraints.AbsoluteTolerance

2. Instantiates the tester for a MEX build target for the entry-point function myAdd with the build-time inputs set to (0,0)

3. Adds the entry-point function helloWorld with no inputs.

4. Builds C code from the myAdd and helloWorld functions

5. Executes the C code for the entry-point function myAdd with the inputs set to (5,5)

6. Instantiates the constraint matlabtest.constraints.ExecutionMatchesMATLAB with the absolute tolerance set to 0.05

7. Verifies the execution of the C code against the execution of the MATLAB function myAdd with the constraint

classdef tEquivalence < matlab.unittest.TestCase
    methods(Test)
        function tMyFunctions(testCase)
            import matlabtest.coder.MATLABCoderTester
            import matlabtest.constraints.ExecutionMatchesMATLAB
            import matlab.unittest.constraints.AbsoluteTolerance         
 
            tester = MATLABCoderTester.forMEXCoderConfiguration( ...
                "myAdd",Inputs={0,0});
            addEntryPointFunction(tester,"helloWorld");
             
            build(tester,testCase);           
            execute(tester,testCase,Inputs={5,5},EntryPoint="myAdd");
            c = ExecutionMatchesMATLAB(Within=AbsoluteTolerance(0.05));
            verifyThat(testCase,tester,c);
        end
    end
end

Run the tMyFunctions test.

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

Running tMyFunctions
..
Done tMyFunctions
__________


ans = 
  TestResult with properties:

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

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

Generate C Code from Multiple Functions and Test for Equivalence

This example shows how to generate C code from multiple MATLAB functions and test the functions for equivalence by using matlabtest.coder.MATLABCoderTester.

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

The function mySubtract takes two numbers as inputs, subtracts them, and outputs the result.

function y = mySubtract(a,b) %#codegen
y = b-a;
end

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

1. Imports the equivalence tester matlabtest.coder.MATLABCoderTester and the constraint matlabtest.constraints.ExecutionMatchesMATLAB

2. Instantiates the tester for a MEX build target for the entry-point function myAdd with the build-time inputs set to (0,0)

3. Adds the entry-point function mySubtract with the build-time inputs set to (0,0)

4. Builds C code from the myAdd and mySubtract functions

5. Executes the C code for the entry-point function myAdd with the inputs set to (5,5)

6. Verifies the execution of the C code against the execution of the MATLAB function myAdd

classdef tEquivalence < matlab.unittest.TestCase
    methods(Test)
        function tMyMath(testCase)
            import matlabtest.coder.MATLABCoderTester
            import matlabtest.constraints.ExecutionMatchesMATLAB
             
            tester = MATLABCoderTester.forMEXCoderConfiguration( ...
                "myAdd",Inputs={0,0});           
            addEntryPointFunction(tester,"mySubtract",{0,0});
             
            build(tester,testCase);
 
            execute(tester,testCase,Inputs={5,5}, ...
                EntryPoint="myAdd");           
            verifyThat(testCase,tester,ExecutionMatchesMATLAB)
        end
    end
end

Run the tMyMath test.

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

Running tMyMath
..
Done tMyMath
__________


ans = 
  TestResult with properties:

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

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

Generate C Code for Multiple Function Signatures and Test for Equivalence

This example shows how to generate C code from a single MATLAB function for multiple function signatures and test for equivalence by using the equivalence tester matlabtest.coder.MATLABCoderTester.

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 matlab.unittest.TestCase. The test case in the methods block defines a test case that:

1. Imports the equivalence tester matlabtest.coder.MATLABCoderTester, the constraint matlabtest.constraints.ExecutionMatchesMATLAB, and the constraint matlab.unittest.constraints.AbsoluteTolerance

2. Instantiates the tester for a MEX build target for the entry-point function myAdd with the build-time inputs set to (0,0) so that it can accept inputs of type double

3. Specifies a second function signature for myAdd so that it can accept inputs of type int8

4. Builds C code from myAdd with the specified function signatures

5. Executes the C code for the entry-point function myAdd with the inputs set to (5,5)

6. Instantiates the constraint matlabtest.constraints.ExecutionMatchesMATLAB with the absolute tolerance set to 0.05

7. Verifies the execution of the C code against the execution of the MATLAB function myAdd with the constraint

classdef tEquivalence < matlab.unittest.TestCase
    methods(Test)
        function tMyAdd(testCase)
            import matlabtest.coder.MATLABCoderTester;
            import matlabtest.constraints.ExecutionMatchesMATLAB;
            
            tester = MATLABCoderTester.forMEXCoderConfiguration( ...
                "myAdd.m",Inputs={0,0});
            addEntryPointFunction(tester,"myAdd.m",{int8(0),int8(0)});
            
            build(tester,testCase);

            execute(tester,testCase,Inputs={5,5});
            verifyThat(testCase,tester,ExecutionMatchesMATLAB);
            
            execute(tester,testCase,Inputs={int8(2),int8(3)});
            verifyThat(testCase,tester,ExecutionMatchesMATLAB);
        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.7680
       Details: [1×1 struct]

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

Version History

Introduced in R2023a