matlab.perftest.TestCase class

Package: matlab.perftest
Superclasses: matlab.unittest.TestCase

Superclass of matlab.perftest performance test classes

Description

Use the matlab.perftest.TestCase class to write class-based performance tests that can define measurement boundaries. By default, the framework measures performance around the test method boundary. However, test classes that inherit from matlab.perftest.TestCase can use the startMeasuring and stopMeasuring methods to define boundaries to measure specific code segments.

The matlab.perftest.TestCase derives from the matlab.unittest.TestCase class.

Construction

The testing framework constructs the matlab.perftest.TestCase instances.

Methods

keepMeasuring	Measure code with automatic looping
startMeasuring	Designate start of measurement boundary
stopMeasuring	Designate end of measurement boundary

Inherited Methods

addTeardown	Dynamically add teardown routine to `TestCase` instance
applyFixture	Use fixture with `TestCase`
forInteractiveUse	Create TestCase for interactive use
getSharedTestFixtures	Provide access to shared test fixtures
log	Record diagnostic information during test execution
onFailure	Dynamically add diagnostics for test failures
run	Run `TestCase` test

Also, the TestCase class inherits methods from these classes:

matlab.unittest.qualifications.Assertable	Qualification to validate preconditions of a test
matlab.unittest.qualifications.Assumable	Qualification to filter test content
matlab.unittest.qualifications.FatalAssertable	Qualification to abort test execution
matlab.unittest.qualifications.Verifiable	Qualification to produce soft failure conditions

Copy Semantics

Handle. To learn how handle classes affect copy operations, see Copying Objects.

Examples

collapse all

Create Performance Test Class

Create a performance test class, preallocationTest. The performance testing framework measures the time for each of the four test methods.

classdef preallocationTest < matlab.perftest.TestCase
    methods(Test)
        function testOnes(testCase)
            x = ones(1,1e7);
        end
        
        function testIndexingWithVariable(testCase)
            id = 1:1e7;
            x(id) = 1;
        end
        
        function testIndexingOnLHS(testCase)
            x(1:1e7) = 1;
        end
        
        function testForLoop(testCase)
            for i=1:1e7
                x(i) = 1;
            end
        end
        
    end
end

Specify Boundaries for Performance Test Class

Create a performance test class, fprintfTest. The performance testing framework measures the code between the calls to the startMeasuring and stopMeasuring methods. This boundary restricts the performance testing framework to measuring only the call to the fprintf function. It excludes setup and teardown actions, and qualifications testing.

classdef fprintfTest < matlab.perftest.TestCase
    methods(Test)
        function testPrintingToFile(testCase)
            file = tempname;
            fid = fopen(file, 'w');
            testCase.assertNotEqual(fid, -1, 'IO Problem');
            
            stringToWrite = repmat('abcdef', 1, 1000000);
            
            testCase.startMeasuring();
            fprintf(fid, '%s', stringToWrite);
            testCase.stopMeasuring();
            
            testCase.verifyEqual(fileread(file), stringToWrite);
            fclose(fid);
        end
    end
end

Documentation