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

Base interface for iterating and looking up records in an indexed profile.

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct InstrProfReaderIndexBase;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/InstrProfReaderIndexBase/2destructor.adoc[`~InstrProfReaderIndexBase`] [.small]#[destructor]# [.small]#[virtual]#
| Destroy the index.
| xref:llvm/InstrProfReaderIndexBase/advanceToNextKey.adoc[`advanceToNextKey`]  [.small]#[virtual]#
| Advance the iterator to the next key in the index.
| xref:llvm/InstrProfReaderIndexBase/atEnd.adoc[`atEnd`]  [.small]#[virtual]#
| Return true if the iterator is past the last key.
| xref:llvm/InstrProfReaderIndexBase/functionEntryOnly.adoc[`functionEntryOnly`]  [.small]#[virtual]#
| Return true if the profile only instruments function entries.
| xref:llvm/InstrProfReaderIndexBase/getProfileKind.adoc[`getProfileKind`]  [.small]#[virtual]#
| Returns a BitsetEnum describing the attributes of the profile.
| xref:llvm/InstrProfReaderIndexBase/getRecords-08.adoc[`getRecords`] 
| `getRecords` overloads
| xref:llvm/InstrProfReaderIndexBase/getVersion.adoc[`getVersion`]  [.small]#[virtual]#
| Return the profile format version.
| xref:llvm/InstrProfReaderIndexBase/hasCSIRLevelProfile.adoc[`hasCSIRLevelProfile`]  [.small]#[virtual]#
| Return true if this is a context‐sensitive IR‐level profile.
| xref:llvm/InstrProfReaderIndexBase/hasMemoryProfile.adoc[`hasMemoryProfile`]  [.small]#[virtual]#
| Return true if profile includes a memory profile.
| xref:llvm/InstrProfReaderIndexBase/hasSingleByteCoverage.adoc[`hasSingleByteCoverage`]  [.small]#[virtual]#
| Return true if the profile has single byte counters representing coverage.
| xref:llvm/InstrProfReaderIndexBase/hasTemporalProfile.adoc[`hasTemporalProfile`]  [.small]#[virtual]#
| Return true if this has a temporal profile.
| xref:llvm/InstrProfReaderIndexBase/instrEntryBBEnabled.adoc[`instrEntryBBEnabled`]  [.small]#[virtual]#
| Return true if the profile instruments function entries.
| xref:llvm/InstrProfReaderIndexBase/instrLoopEntriesEnabled.adoc[`instrLoopEntriesEnabled`]  [.small]#[virtual]#
| Return true if the profile instruments all loop entries.
| xref:llvm/InstrProfReaderIndexBase/isIRLevelProfile.adoc[`isIRLevelProfile`]  [.small]#[virtual]#
| Return true if this is an IR‐level instrumentation profile.
| xref:llvm/InstrProfReaderIndexBase/populateSymtab.adoc[`populateSymtab`]  [.small]#[virtual]#
| Populate `Symtab` from the keys in this index.
| xref:llvm/InstrProfReaderIndexBase/setValueProfDataEndianness.adoc[`setValueProfDataEndianness`]  [.small]#[virtual]#
| Set the endianness used when reading value profile data.
|===


== Derived Classes

[cols="1,4"]
|===
| Name| Description
| xref:llvm/InstrProfReaderIndex.adoc[`InstrProfReaderIndex`] 
| Index over an on‐disk hash table of named instrumentation profile records.
|===


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