[#BloombergLP-bslmt-ThroughputBenchmarkResult]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslmt.adoc[bslmt]::ThroughputBenchmarkResult
:relfileprefix: ../../
:mrdocs:

Repository for multi&hyphen;threaded throughput benchmark results&period;

== Synopsis

Declared in `&lt;bslmt&lowbar;throughputbenchmarkresult&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class ThroughputBenchmarkResult;
----

== Description

This class provides support for output of multi&hyphen;threaded performance benchmark results&period; The results are counts of work done during the benchmark time period divided by the time period&period;

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslmt/ThroughputBenchmarkResult/DoubleVector.adoc[`DoubleVector`] 
| Vector of `double` values used to store throughput measurements&period;
| xref:BloombergLP/bslmt/ThroughputBenchmarkResult/Int64.adoc[`Int64`] 
| Signed 64&hyphen;bit integer type used for result counts&period;
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslmt/ThroughputBenchmarkResult/2constructor-08.adoc[`ThroughputBenchmarkResult`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bslmt/ThroughputBenchmarkResult/operator_assign-0e95.adoc[`operator&equals;`] 
| Assignment operators
| xref:BloombergLP/bslmt/ThroughputBenchmarkResult/allocator.adoc[`allocator`] 
| Return the allocator used by this object&period;
| xref:BloombergLP/bslmt/ThroughputBenchmarkResult/getMedian.adoc[`getMedian`] 
| Load the median throughput for the specified thread group&period;
| xref:BloombergLP/bslmt/ThroughputBenchmarkResult/getPercentile.adoc[`getPercentile`] 
| Load the given percentage throughput for the specified thread group&period;
| xref:BloombergLP/bslmt/ThroughputBenchmarkResult/getPercentiles.adoc[`getPercentiles`] 
| Load a uniform percentile breakdown for the specified thread group&period;
| xref:BloombergLP/bslmt/ThroughputBenchmarkResult/getThreadPercentiles.adoc[`getThreadPercentiles`] 
| Load per&hyphen;thread percentile throughputs for the specified group&period;
| xref:BloombergLP/bslmt/ThroughputBenchmarkResult/getValue.adoc[`getValue`] 
| Return the throughput for the given thread, group, and sample&period;
| xref:BloombergLP/bslmt/ThroughputBenchmarkResult/initialize.adoc[`initialize`] 
| Initialize this object with the given samples and thread groups&period;
| xref:BloombergLP/bslmt/ThroughputBenchmarkResult/numSamples.adoc[`numSamples`] 
| Return the number of test samples&period;
| xref:BloombergLP/bslmt/ThroughputBenchmarkResult/numThreadGroups.adoc[`numThreadGroups`] 
| Return the number of thread groups&period;
| xref:BloombergLP/bslmt/ThroughputBenchmarkResult/numThreads.adoc[`numThreads`] 
| Return the number of threads in the specified `threadGroupIndex`&period;
| xref:BloombergLP/bslmt/ThroughputBenchmarkResult/setThroughput.adoc[`setThroughput`] 
| Set the throughput for the given thread, group, and sample&period;
| xref:BloombergLP/bslmt/ThroughputBenchmarkResult/totalNumThreads.adoc[`totalNumThreads`] 
| Return the total number of threads&period;
| xref:BloombergLP/bslmt/ThroughputBenchmarkResult/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration&lt;ThroughputBenchmarkResult, UsesBslmaAllocator&gt;`] 
| Declare that this type uses a `bslma` allocator&period;
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bslmt/ThroughputBenchmarkResult_TestUtil.adoc[BloombergLP::bslmt::ThroughputBenchmarkResult&lowbar;TestUtil]`
| Test utility for accessing private throughput result attributes&period;
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
