addEntryPointFunction
Class: matlabtest.coder.MATLABCoderTester
Namespace: matlabtest.coder
Add entry-point function or signature to formal generated C/C++ equivalence tester
Since R2023a
Description
addEntryPointFunction(
adds the entry-point function tester
,entryPoint
)entryPoint
to the equivalence tester
tester
. Use this syntax if your entry-point function has
no inputs.
addEntryPointFunction(
adds the entry-point function with the function signature defined by
tester
,entryPoint
,buildInputs
)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:
Imports the equivalence tester
matlabtest.coder.MATLABCoderTester
, the constraintmatlabtest.constraints.ExecutionMatchesMATLAB
, and the constraintmatlab.unittest.constraints.AbsoluteTolerance
Instantiates the tester for a MEX build target for the entry-point function
myAdd
with the build-time inputs set to(0,0)
Adds the entry-point function
helloWorld
with no inputs.Builds C code from the
myAdd
andhelloWorld
functionsExecutes the C code for the entry-point function
myAdd
with the inputs set to(5,5)
Instantiates the constraint
matlabtest.constraints.ExecutionMatchesMATLAB
with the absolute tolerance set to0.05
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:
Imports the equivalence tester
matlabtest.coder.MATLABCoderTester
and the constraintmatlabtest.constraints.ExecutionMatchesMATLAB
Instantiates the tester for a MEX build target for the entry-point function
myAdd
with the build-time inputs set to(0,0)
Adds the entry-point function
mySubtract
with the build-time inputs set to(0,0)
Builds C code from the
myAdd
andmySubtract
functionsExecutes the C code for the entry-point function
myAdd
with the inputs set to(5,5)
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:
Imports the equivalence tester
matlabtest.coder.MATLABCoderTester
, the constraintmatlabtest.constraints.ExecutionMatchesMATLAB
, and the constraintmatlab.unittest.constraints.AbsoluteTolerance
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 typedouble
Specifies a second function signature for
myAdd
so that it can accept inputs of typeint8
Builds C code from
myAdd
with the specified function signaturesExecutes the C code for the entry-point function
myAdd
with the inputs set to(5,5)
Instantiates the constraint
matlabtest.constraints.ExecutionMatchesMATLAB
with the absolute tolerance set to0.05
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
See Also
Classes
Functions
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
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: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
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)