[#llvm-SampleProfileSummaryBuilder]
= xref:llvm.adoc[llvm]::SampleProfileSummaryBuilder
:relfileprefix: ../
:mrdocs:

Builder that constructs a ProfileSummary from sample profile data.

== Synopsis

Declared in `<llvm/ProfileData/ProfileCommon.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class SampleProfileSummaryBuilder final
    : public xref:llvm/ProfileSummaryBuilder.adoc[ProfileSummaryBuilder]
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:llvm/ProfileSummaryBuilder.adoc[ProfileSummaryBuilder]`
| Base builder that accumulates profile counts and computes a ProfileSummary.
|===

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/SampleProfileSummaryBuilder/2constructor.adoc[`SampleProfileSummaryBuilder`]         [.small]#[constructor]#
| Construct a builder that will compute summary entries for `Cutoffs.`
| xref:llvm/SampleProfileSummaryBuilder/addRecord.adoc[`addRecord`] 
| Incorporate sample counts from a function's sample profile.
| xref:llvm/SampleProfileSummaryBuilder/computeSummaryForProfiles.adoc[`computeSummaryForProfiles`] 
| Compute a profile summary from a map of function sample profiles.
| xref:llvm/SampleProfileSummaryBuilder/getSummary.adoc[`getSummary`] 
| Compute and return the sample profile summary from recorded samples.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/ProfileSummaryBuilder/getColdCountThreshold.adoc[`getColdCountThreshold`] 
| Return the maximum count treated as cold for the given detailed summary.
| xref:llvm/ProfileSummaryBuilder/getEntryForPercentile.adoc[`getEntryForPercentile`] 
| Find the summary entry for a desired percentile of counts.
| xref:llvm/ProfileSummaryBuilder/getHotCountThreshold.adoc[`getHotCountThreshold`] 
| Return the minimum count treated as hot for the given detailed summary.
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:llvm/ProfileSummaryBuilder/DefaultCutoffs.adoc[`DefaultCutoffs`] 
| A vector of useful cutoff values for detailed summary.
|===


== Protected Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/ProfileSummaryBuilder/addCount.adoc[`addCount`] 
| This is called when a count is seen in the profile.
| xref:llvm/ProfileSummaryBuilder/computeDetailedSummary.adoc[`computeDetailedSummary`] 
| Compute the detailed percentile summary from the accumulated counts.
|===


== Protected Data Members

[cols="1,4"]
|===
| Name| Description
| xref:llvm/ProfileSummaryBuilder/DetailedSummary.adoc[`DetailedSummary`] 
| Detailed percentile summary entries computed from the accumulated counts.
| xref:llvm/ProfileSummaryBuilder/MaxCount.adoc[`MaxCount`] 
| Maximum profile count seen so far.
| xref:llvm/ProfileSummaryBuilder/MaxFunctionCount.adoc[`MaxFunctionCount`] 
| Maximum function entry count seen so far.
| xref:llvm/ProfileSummaryBuilder/NumCounts.adoc[`NumCounts`] 
| Number of individual profile counts recorded so far.
| xref:llvm/ProfileSummaryBuilder/NumFunctions.adoc[`NumFunctions`] 
| Number of functions recorded so far.
| xref:llvm/ProfileSummaryBuilder/TotalCount.adoc[`TotalCount`] 
| Sum of all profile counts recorded so far.
|===



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