matlab.perftest.TimeResult Class
Namespace: matlab.perftest
Superclasses: matlab.unittest.measurement.MeasurementResult
Result from running time experiment
Description
Objects of the TimeResult
class hold information describing the result
from running a time experiment on a test suite using the matlab.perftest.TimeExperiment
class. Objects contain information about the
time measurements and the corresponding functional test results.
The test results are available as a table.
Creation
The MATLAB® testing framework creates an instance of the TimeResult
class when you run a time experiment.
Properties
Name
— Name of the test suite element that corresponds to the time results
character vector
Name of the test suite element that corresponds to the time results, returned as a character vector.
Example: 'MyTestSuite'
Attributes:
GetAccess | public |
SetAccess | protected |
Data Types: char
Valid
— Indicator if measurement is valid
logical
0 or 1
Indicator if the measurement is valid, returned as
logical
0 or 1. A measurement is valid
(logical
1) if it is collected from a passing test.
Otherwise it is invalid (logical
0).
Attributes:
GetAccess | public |
SetAccess | private |
Dependent | true |
NonCopyable | true |
Data Types: logical
Samples
— Information about sample measurements
table
Information about sample measurements, returned as a table with the following information.
Column Name | Description |
---|---|
Name | Name of the test suite element. If a measurement label is
specified, Name is appended with the
measurement label delimited by angle brackets. |
MeasuredValue | Value of the measurement. Experiments can give this
column a more specific name, such as
MeasuredTime . |
Timestamp | Time when measurement is collected. |
Host | Machine name where measurement is collected. |
Platform | Platform architecture on which measurement is collected. |
Version | MATLAB Version used in test. |
RunIdentifier | Unique identifier of measurement run. |
Attributes:
GetAccess | public |
SetAccess | private |
Dependent | true |
NonCopyable | true |
Data Types: table
TestActivity
— Information about all test activity
table
Information about all test activity, including the warm-up measurements,
returned as a table. This table is useful when you want all the data, such
as during debugging or when performing a more involved data analysis. The
TestActivity
table contains these columns in
addition to the columns described for Samples
:
Column Name | Description |
---|---|
Passed | Logical value indicating if the test passed |
Failed | Logical value indicating if the test failed |
Incomplete | Logical value indicating if test run is incomplete |
Objective | Categorical value indicating the type of measurement:
sample or
warmup |
TestResult | TestResult object from the functional
test |
Attributes:
GetAccess | public |
SetAccess | private |
Dependent | true |
NonCopyable | true |
Data Types: table
Methods
Public Methods
comparisonPlot | Use the comparisonPlot method to visually
compare the time measurement results of two equal-sized sets of
performance tests. |
sampleSummary | The |
samplefun | The |
Version History
Introduced in R2019aR2019b: Visually compare two TimeResult
arrays
The matlab.perftest.TimeResult
class has a new method
comparisonPlot
that lets you visually compare the time
measurement results of two equal-sized sets of performance tests.
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)