LLVM API Documentation

Classes | Public Types | Public Member Functions
llvm::ArrayRef< T > Class Template Reference

#include <ArrayRef.h>

Inheritance diagram for llvm::ArrayRef< T >:
Inheritance graph
[legend]

List of all members.

Classes

struct  TRefOrNothing
 A dummy "optional" type that is only created by implicit conversion from a reference to T.

Public Types

typedef const Titerator
typedef const Tconst_iterator
typedef size_t size_type
typedef std::reverse_iterator
< iterator
reverse_iterator

Public Member Functions

iterator begin () const
iterator end () const
reverse_iterator rbegin () const
reverse_iterator rend () const
bool empty () const
 empty - Check if the array is empty.
const Tdata () const
size_t size () const
 size - Get the array size.
const Tfront () const
 front - Get the first element.
const Tback () const
 back - Get the last element.
template<typename Allocator >
ArrayRef< Tcopy (Allocator &A)
bool equals (ArrayRef RHS) const
 equals - Check for element-wise equality.
ArrayRef< Tslice (unsigned N) const
 slice(n) - Chop off the first N elements of the array.
ArrayRef< Tslice (unsigned N, unsigned M) const
ArrayRef< Tdrop_back (unsigned N=1) const
const Toperator[] (size_t Index) const
std::vector< Tvec () const
 operator std::vector< T > () const
bool equals (TRefOrNothing Arg0=TRefOrNothing(), TRefOrNothing Arg1=TRefOrNothing(), TRefOrNothing Arg2=TRefOrNothing(), TRefOrNothing Arg3=TRefOrNothing(), TRefOrNothing Arg4=TRefOrNothing(), TRefOrNothing Arg5=TRefOrNothing(), TRefOrNothing Arg6=TRefOrNothing(), TRefOrNothing Arg7=TRefOrNothing(), TRefOrNothing Arg8=TRefOrNothing(), TRefOrNothing Arg9=TRefOrNothing(), TRefOrNothing Arg10=TRefOrNothing(), TRefOrNothing Arg11=TRefOrNothing(), TRefOrNothing Arg12=TRefOrNothing(), TRefOrNothing Arg13=TRefOrNothing(), TRefOrNothing Arg14=TRefOrNothing(), TRefOrNothing Arg15=TRefOrNothing())
 Predicate for testing that the array equals the exact sequence of arguments.
Constructors
 ArrayRef ()
 Construct an empty ArrayRef.
 ArrayRef (NoneType)
 Construct an empty ArrayRef from None.
 ArrayRef (const T &OneElt)
 Construct an ArrayRef from a single element.
 ArrayRef (const T *data, size_t length)
 Construct an ArrayRef from a pointer and length.
 ArrayRef (const T *begin, const T *end)
 Construct an ArrayRef from a range.
template<typename U >
 ArrayRef (const SmallVectorTemplateCommon< T, U > &Vec)
template<typename A >
 ArrayRef (const std::vector< T, A > &Vec)
 Construct an ArrayRef from a std::vector.
template<size_t N>
LLVM_CONSTEXPR ArrayRef (const T(&Arr)[N])
 Construct an ArrayRef from a C array.

Detailed Description

template<typename T>
class llvm::ArrayRef< T >

ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory), i.e. a start pointer and a length. It allows various APIs to take consecutive elements easily and conveniently.

This class does not own the underlying data, it is expected to be used in situations where the data resides in some other buffer, whose lifetime extends past that of the ArrayRef. For this reason, it is not in general safe to store an ArrayRef.

This is intended to be trivially copyable, so it should be passed by value.

Definition at line 32 of file ArrayRef.h.


Member Typedef Documentation

template<typename T>
typedef const T* llvm::ArrayRef< T >::const_iterator

Definition at line 35 of file ArrayRef.h.

template<typename T>
typedef const T* llvm::ArrayRef< T >::iterator

Reimplemented in llvm::MutableArrayRef< T >, and llvm::MutableArrayRef< CounterMappingRegion >.

Definition at line 34 of file ArrayRef.h.

template<typename T>
typedef std::reverse_iterator<iterator> llvm::ArrayRef< T >::reverse_iterator

Reimplemented in llvm::MutableArrayRef< T >, and llvm::MutableArrayRef< CounterMappingRegion >.

Definition at line 38 of file ArrayRef.h.

template<typename T>
typedef size_t llvm::ArrayRef< T >::size_type

Definition at line 36 of file ArrayRef.h.


Constructor & Destructor Documentation

template<typename T>
llvm::ArrayRef< T >::ArrayRef ( ) [inline]

Construct an empty ArrayRef.

Definition at line 65 of file ArrayRef.h.

template<typename T>
llvm::ArrayRef< T >::ArrayRef ( NoneType  ) [inline]

Construct an empty ArrayRef from None.

Definition at line 68 of file ArrayRef.h.

template<typename T>
llvm::ArrayRef< T >::ArrayRef ( const T OneElt) [inline]

Construct an ArrayRef from a single element.

Definition at line 71 of file ArrayRef.h.

template<typename T>
llvm::ArrayRef< T >::ArrayRef ( const T data,
size_t  length 
) [inline]

Construct an ArrayRef from a pointer and length.

Definition at line 75 of file ArrayRef.h.

template<typename T>
llvm::ArrayRef< T >::ArrayRef ( const T begin,
const T end 
) [inline]

Construct an ArrayRef from a range.

Definition at line 79 of file ArrayRef.h.

template<typename T>
template<typename U >
llvm::ArrayRef< T >::ArrayRef ( const SmallVectorTemplateCommon< T, U > &  Vec) [inline]

Construct an ArrayRef from a SmallVector. This is templated in order to avoid instantiating SmallVectorTemplateCommon<T> whenever we copy-construct an ArrayRef.

Definition at line 86 of file ArrayRef.h.

template<typename T>
template<typename A >
llvm::ArrayRef< T >::ArrayRef ( const std::vector< T, A > &  Vec) [inline]

Construct an ArrayRef from a std::vector.

Definition at line 92 of file ArrayRef.h.

template<typename T>
template<size_t N>
LLVM_CONSTEXPR llvm::ArrayRef< T >::ArrayRef ( const T(&)  Arr[N]) [inline]

Construct an ArrayRef from a C array.

Definition at line 97 of file ArrayRef.h.


Member Function Documentation

template<typename T>
const T& llvm::ArrayRef< T >::back ( ) const [inline]

back - Get the last element.

Reimplemented in llvm::MutableArrayRef< T >, and llvm::MutableArrayRef< CounterMappingRegion >.

Definition at line 130 of file ArrayRef.h.

Referenced by llvm::ConstantFoldInstOperands().

template<typename T>
iterator llvm::ArrayRef< T >::begin ( ) const [inline]

Reimplemented in llvm::MutableArrayRef< T >, and llvm::MutableArrayRef< CounterMappingRegion >.

Definition at line 109 of file ArrayRef.h.

Referenced by llvm::SpillPlacement::addConstraints(), llvm::SpillPlacement::addLinks(), llvm::SpillPlacement::addPrefSpill(), llvm::AllocationOrder::AllocationOrder(), buildExtractionBlockSet(), buildFixItLine(), BuildSubAggregate(), llvm::LiveIntervals::checkRegMaskInterference(), llvm::SchedDFSResult::compute(), llvm::ScheduleDAGMILive::computeCyclicCriticalPath(), llvm::ComputeLinearIndex(), llvm::ConstantArray::ConstantArray(), ConstantFoldGetElementPtrImpl(), llvm::ConstantStruct::ConstantStruct(), llvm::ConstantVector::ConstantVector(), llvm::sys::UnicodeCharSet::contains(), containsReg(), llvm::convertUTF16ToUTF8String(), llvm::ArrayRef< uint64_t >::copy(), llvm::discoverAndMapSubloop(), llvm::Instruction::dropUnknownMetadata(), llvm::TargetLoweringObjectFileMachO::emitModuleFlags(), llvm::TargetLoweringObjectFileCOFF::emitModuleFlags(), llvm::ArrayRef< uint64_t >::equals(), Find(), llvm::FindInsertedValue(), llvm::SchedBoundary::findMaxLatency(), llvm::gep_type_begin(), llvm::AttributeSetNode::get(), llvm::AttributeSet::get(), llvm::ConstantArray::get(), llvm::AnonStructTypeKeyInfo::getHashValue(), llvm::FunctionTypeKeyInfo::getHashValue(), llvm::SelectionDAG::getNode(), llvm::ARMBaseRegisterInfo::getRegAllocationHints(), llvm::TargetRegisterInfo::getRegAllocationHints(), llvm::SelectionDAG::getVTList(), llvm::RegPressureTracker::initLiveThru(), llvm::ScheduleDAGMI::initQueues(), isEXTMask(), isHorizontalBinOp(), isIntegerWideningViable(), isVectorPromotionViable(), lowerV8I16SingleInputVectorShuffle(), LowerVECTOR_SHUFFLEv8i8(), ProfileBitsInit(), ProfileDagInit(), ProfileListInit(), ReadWideAPInt(), llvm::MachineModuleInfo::setCallSiteLandingPad(), llvm::PMTopLevelManager::setLastUser(), llvm::MachineInstr::setPhysRegsDeadExcept(), llvm::SimplifyCall(), llvm::SelectionDAG::TransferDbgValues(), UpdateAnalysisInformation(), and UpdatePHINodes().

template<typename T>
template<typename Allocator >
ArrayRef<T> llvm::ArrayRef< T >::copy ( Allocator &  A) [inline]

Definition at line 136 of file ArrayRef.h.

Referenced by llvm::ArrayRef< uint64_t >::copy().

template<typename T>
const T* llvm::ArrayRef< T >::data ( ) const [inline]
template<typename T>
ArrayRef<T> llvm::ArrayRef< T >::drop_back ( unsigned  N = 1) const [inline]

Definition at line 163 of file ArrayRef.h.

template<typename T>
bool llvm::ArrayRef< T >::empty ( ) const [inline]
template<typename T>
iterator llvm::ArrayRef< T >::end ( ) const [inline]

Reimplemented in llvm::MutableArrayRef< T >, and llvm::MutableArrayRef< CounterMappingRegion >.

Definition at line 110 of file ArrayRef.h.

Referenced by llvm::SpillPlacement::addConstraints(), llvm::SpillPlacement::addLinks(), llvm::SpillPlacement::addPrefSpill(), llvm::AllocationOrder::AllocationOrder(), buildExtractionBlockSet(), buildFixItLine(), BuildSubAggregate(), llvm::LiveIntervals::checkRegMaskInterference(), llvm::SchedDFSResult::compute(), llvm::ScheduleDAGMILive::computeCyclicCriticalPath(), llvm::ComputeLinearIndex(), llvm::ConstantArray::ConstantArray(), ConstantFoldGetElementPtrImpl(), llvm::ConstantStruct::ConstantStruct(), llvm::ConstantVector::ConstantVector(), llvm::sys::UnicodeCharSet::contains(), containsReg(), llvm::convertUTF16ToUTF8String(), llvm::ArrayRef< uint64_t >::copy(), llvm::discoverAndMapSubloop(), llvm::Instruction::dropUnknownMetadata(), llvm::TargetLoweringObjectFileMachO::emitModuleFlags(), llvm::TargetLoweringObjectFileCOFF::emitModuleFlags(), llvm::ArrayRef< uint64_t >::equals(), Find(), llvm::FindInsertedValue(), llvm::SchedBoundary::findMaxLatency(), llvm::gep_type_end(), llvm::AttributeSetNode::get(), llvm::AttributeSet::get(), llvm::ConstantArray::get(), llvm::AnonStructTypeKeyInfo::getHashValue(), llvm::FunctionTypeKeyInfo::getHashValue(), llvm::SelectionDAG::getNode(), llvm::ARMBaseRegisterInfo::getRegAllocationHints(), llvm::TargetRegisterInfo::getRegAllocationHints(), llvm::SelectionDAG::getVTList(), llvm::RegPressureTracker::initLiveThru(), llvm::ScheduleDAGMI::initQueues(), isEXTMask(), isHorizontalBinOp(), isIntegerWideningViable(), isVectorPromotionViable(), lowerV8I16SingleInputVectorShuffle(), LowerVECTOR_SHUFFLEv8i8(), ProfileBitsInit(), ProfileDagInit(), ProfileListInit(), ReadWideAPInt(), llvm::ArrayRef< uint64_t >::rend(), llvm::MachineModuleInfo::setCallSiteLandingPad(), llvm::PMTopLevelManager::setLastUser(), llvm::MachineInstr::setPhysRegsDeadExcept(), llvm::SimplifyCall(), llvm::SelectionDAG::TransferDbgValues(), UpdateAnalysisInformation(), and UpdatePHINodes().

template<typename T>
bool llvm::ArrayRef< T >::equals ( ArrayRef< T RHS) const [inline]

equals - Check for element-wise equality.

Definition at line 143 of file ArrayRef.h.

Referenced by combineX86ShuffleChain(), and llvm::operator==().

template<typename T>
bool llvm::ArrayRef< T >::equals ( TRefOrNothing  Arg0 = TRefOrNothing(),
TRefOrNothing  Arg1 = TRefOrNothing(),
TRefOrNothing  Arg2 = TRefOrNothing(),
TRefOrNothing  Arg3 = TRefOrNothing(),
TRefOrNothing  Arg4 = TRefOrNothing(),
TRefOrNothing  Arg5 = TRefOrNothing(),
TRefOrNothing  Arg6 = TRefOrNothing(),
TRefOrNothing  Arg7 = TRefOrNothing(),
TRefOrNothing  Arg8 = TRefOrNothing(),
TRefOrNothing  Arg9 = TRefOrNothing(),
TRefOrNothing  Arg10 = TRefOrNothing(),
TRefOrNothing  Arg11 = TRefOrNothing(),
TRefOrNothing  Arg12 = TRefOrNothing(),
TRefOrNothing  Arg13 = TRefOrNothing(),
TRefOrNothing  Arg14 = TRefOrNothing(),
TRefOrNothing  Arg15 = TRefOrNothing() 
) [inline]

Predicate for testing that the array equals the exact sequence of arguments.

Will return false if the size is not equal to the exact number of arguments given or if the array elements don't equal the argument elements in order. Currently supports up to 16 arguments, but can easily be extended.

Definition at line 193 of file ArrayRef.h.

template<typename T>
const T& llvm::ArrayRef< T >::front ( ) const [inline]

front - Get the first element.

Reimplemented in llvm::MutableArrayRef< T >, and llvm::MutableArrayRef< CounterMappingRegion >.

Definition at line 124 of file ArrayRef.h.

Referenced by DecodeFixedType(), llvm::ConstantVector::get(), and llvm::PrintMessage().

template<typename T>
llvm::ArrayRef< T >::operator std::vector< T > ( ) const [inline]

Definition at line 180 of file ArrayRef.h.

template<typename T>
const T& llvm::ArrayRef< T >::operator[] ( size_t  Index) const [inline]

Reimplemented in llvm::MutableArrayRef< T >, and llvm::MutableArrayRef< CounterMappingRegion >.

Definition at line 169 of file ArrayRef.h.

template<typename T>
reverse_iterator llvm::ArrayRef< T >::rbegin ( ) const [inline]
template<typename T>
reverse_iterator llvm::ArrayRef< T >::rend ( ) const [inline]
template<typename T>
size_t llvm::ArrayRef< T >::size ( ) const [inline]

size - Get the array size.

Definition at line 121 of file ArrayRef.h.

Referenced by llvm::MachineModuleInfo::addCatchTypeInfo(), llvm::MachineModuleInfo::addFilterTypeInfo(), llvm::InstrProfWriter::addFunctionCounts(), llvm::RegPressureTracker::addLiveRegs(), areAdjacentMasksSequential(), llvm::MutableArrayRef< CounterMappingRegion >::back(), llvm::yaml::BinaryRef::binary_size(), llvm::PBQPBuilder::build(), BuildNew(), CanEvaluateShuffled(), CastGEPIndices(), combineX86ShuffleChain(), combineX86ShufflesRecursively(), llvm::ComputeEditDistance(), computeExcessPressureDelta(), computeMaxPressureDelta(), llvm::ConstantArray::ConstantArray(), ConstantFoldGetElementPtrImpl(), llvm::ConstantFoldInstOperands(), llvm::ConstantFoldLoadThroughGEPIndices(), ConstantFoldScalarCall(), ConstantFoldVectorCall(), llvm::ConstantStruct::ConstantStruct(), llvm::ConstantVector::ConstantVector(), ConvertToString(), llvm::convertUTF16ToUTF8String(), llvm::AArch64InstrInfo::copyPhysRegTuple(), llvm::GetElementPtrConstantExpr::Create(), llvm::ConstantArrayCreator< ConstantClass, TypeClass >::create(), llvm::GetElementPtrInst::Create(), llvm::CallInst::Create(), llvm::InvokeInst::Create(), llvm::MDBuilder::createBranchWeights(), llvm::DIBuilder::createComplexVariable(), llvm::IRBuilder< true, TargetFolder >::CreateGEP(), llvm::IRBuilder< true, TargetFolder >::CreateInBoundsGEP(), createPHIsForSplitLoopExit(), llvm::MDBuilder::createTBAAStructNode(), DecodeIITType(), llvm::RegPressureTracker::decreaseRegPressure(), llvm::ArrayRef< uint64_t >::drop_back(), llvm::coverage::CounterMappingContext::dump(), llvm::dumpRegSetPressure(), llvm::LiveRangeEdit::eliminateDeadDefs(), llvm::MCDwarfLineTableHeader::Emit(), llvm::MCDwarfFrameEmitter::Emit(), llvm::MutableArrayRef< CounterMappingRegion >::end(), llvm::ArrayRef< uint64_t >::equals(), llvm::coverage::CounterMappingContext::evaluate(), llvm::LiveIntervals::extendToIndices(), llvm::DWARFDebugInfoEntryMinimal::extractFast(), llvm::FindInsertedValue(), llvm::FunctionType::get(), llvm::AttributeSet::get(), llvm::ConstantArray::get(), llvm::ConstantStruct::get(), llvm::ConstantVector::get(), llvm::ConstantDataArray::get(), llvm::ConstantDataVector::get(), llvm::SelectionDAG::getAtomic(), llvm::SubtargetFeatures::getFeatureBits(), llvm::ConstantExpr::getGetElementPtr(), llvm::DataLayout::getIndexedOffset(), getIndexedTypeInternal(), llvm::Intrinsic::getIntrinsicInfoTableEntries(), llvm::SelectionDAG::getMachineNode(), llvm::SelectionDAG::getMergeValues(), llvm::SourceMgr::GetMessage(), llvm::Intrinsic::getName(), llvm::SelectionDAG::getNode(), getNoopInput(), llvm::DIBuilder::getOrCreateTypeArray(), llvm::ARMBaseRegisterInfo::getRegAllocationHints(), llvm::MachineTraceMetrics::Trace::getResourceDepth(), llvm::MachineTraceMetrics::Trace::getResourceLength(), llvm::MCSubtargetInfo::getSchedModelForCPU(), llvm::MDNode::getTemporary(), llvm::ConstantStruct::getTypeForElements(), llvm::RegPressureTracker::getUpwardPressureDelta(), getV4X86ShuffleImm8ForMask(), llvm::SelectionDAG::getVectorShuffle(), llvm::SelectionDAG::getVTList(), llvm::ConstantExpr::getWithOperands(), llvm::hasUTF16ByteOrderMark(), llvm::RegPressureTracker::increaseRegPressure(), isInBoundsIndices(), isINSMask(), isNoopShuffleMask(), isReverseMask(), isVTBLMask(), lowerV16I8VectorShuffle(), lowerV8I16BasicBlendVectorShuffle(), lowerV8I16SingleInputVectorShuffle(), lowerV8I16VectorShuffle(), llvm::SelectionDAG::MorphNodeTo(), llvm::AllocationOrder::next(), llvm::MutableArrayRef< CounterMappingRegion >::operator[](), parseCond(), llvm::PrintMessage(), ProcessSDDbgValues(), llvm::AttributeSetNode::Profile(), ProfileBitsInit(), ProfileListInit(), ReadWideAPInt(), llvm::LiveIntervals::repairIntervalsInRange(), llvm::SDNode::SDNode(), llvm::StructType::setBody(), shouldLowerAsInterleaving(), SimplifyGEPInst(), llvm::ArrayRef< uint64_t >::slice(), llvm::MutableArrayRef< CounterMappingRegion >::slice(), llvm::SplitBlockPredecessors(), llvm::SplitLandingPadPredecessors(), SymbolicallyEvaluateGEP(), llvm::MD5::update(), llvm::SelectionDAG::UpdateNodeOperands(), UpdatePHINodes(), llvm::ScheduleDAGMILive::updatePressureDiffs(), llvm::coverage::CoverageFilenamesSectionWriter::write(), llvm::coverage::CoverageMappingWriter::write(), and llvm::yaml::BinaryRef::writeAsBinary().

template<typename T>
ArrayRef<T> llvm::ArrayRef< T >::slice ( unsigned  N) const [inline]
template<typename T>
ArrayRef<T> llvm::ArrayRef< T >::slice ( unsigned  N,
unsigned  M 
) const [inline]

slice(n, m) - Chop off the first N elements of the array, and keep M elements in the array.

Reimplemented in llvm::MutableArrayRef< T >, and llvm::MutableArrayRef< CounterMappingRegion >.

Definition at line 157 of file ArrayRef.h.

template<typename T>
std::vector<T> llvm::ArrayRef< T >::vec ( ) const [inline]

Definition at line 175 of file ArrayRef.h.


The documentation for this class was generated from the following file: