qtb_report.md

qtb_report

Reports benchmarks of the QT method based on qtb_analyze raw output.

← Back to contents

Usage

• report = qtb_report(result, tcode) returns the report based on qtb_analyze raw output result for a specific test codename tcode
• report = qtb_report( ___ ,Name,Value) specifies additional arguments using one or more Name-Value pairs

Input arguments

result

Data types: char | structure array

Path to analysis result file or the result structure array.

tcode

Data type: char

The codename of the test to report.

Name-Value pair arguments

percentile

Data type: double

The percentile value for QT method benchmarks estimation.

Default: 95

error_rates

Data type: double

An array of error rates to estimate QT methods benchmarks.

Default: [1e-1, 1e-2, 1e-3, 1e-4]

plot

Data type: logical

Make the plots of QT methods resources vs sample size.

Default: false

export

Data type: char

Path to file to export the report as a table. Available formats: *xls, *xlsx, *csv.

Default: 'none'

Function output

Data type: structure array

Function output report is a structure array containing report data:

• report.name - QT method name
• report.dim - dimension array of the analysis results
• report.tcode - test codename
• report.tname - test name
• report.percentile - percentile specified for benchmarks estimation
• report.error_rates - error rates specified for benchmarks estimation
• report.fields - cell array of benchmarks names (see benchmarks page)
• report.data - array of benchmarks values: each row contains benchmark values for a given error rate
• report.table - table array of benchmarks values
• report.figure - figure object (if plot is set to true)