LLVM API Documentation

llvm::PointerIntPair< PointerTy, IntBits, IntType > Class Template Reference

#include <PointerIntPair.h>

Inheritance diagram for llvm::PointerIntPair< PointerTy, IntBits, IntType >:
[legend]
Collaboration diagram for llvm::PointerIntPair< PointerTy, IntBits, IntType >:
[legend]

List of all members.

Public Member Functions

 PointerIntPair ()
 PointerIntPair (PointerTy Ptr, IntType Int)
PointerTy getPointer () const
IntType getInt () const
void setPointer (PointerTy Ptr)
void setInt (IntType Int)
void * getOpaqueValue () const
void setFromOpaqueValue (void *Val)
bool operator== (const PointerIntPair &RHS) const
bool operator!= (const PointerIntPair &RHS) const
bool operator< (const PointerIntPair &RHS) const
bool operator> (const PointerIntPair &RHS) const
bool operator<= (const PointerIntPair &RHS) const
bool operator>= (const PointerIntPair &RHS) const


Detailed Description

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned>
class llvm::PointerIntPair< PointerTy, IntBits, IntType >

PointerIntPair - This class implements a pair of a pointer and small integer. It is designed to represent this in the space required by one pointer by bitmangling the integer into the low part of the pointer. This can only be done for small integers: typically up to 3 bits, but it depends on the alignment returned by the allocator in use.

Definition at line 32 of file PointerIntPair.h.


Constructor & Destructor Documentation

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned>
llvm::PointerIntPair< PointerTy, IntBits, IntType >::PointerIntPair (  )  [inline]

Definition at line 35 of file PointerIntPair.h.

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned>
llvm::PointerIntPair< PointerTy, IntBits, IntType >::PointerIntPair ( PointerTy  Ptr,
IntType  Int 
) [inline]

Definition at line 36 of file PointerIntPair.h.


Member Function Documentation

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned>
PointerTy llvm::PointerIntPair< PointerTy, IntBits, IntType >::getPointer (  )  const [inline]

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned>
IntType llvm::PointerIntPair< PointerTy, IntBits, IntType >::getInt (  )  const [inline]

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned>
void llvm::PointerIntPair< PointerTy, IntBits, IntType >::setPointer ( PointerTy  Ptr  )  [inline]

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned>
void llvm::PointerIntPair< PointerTy, IntBits, IntType >::setInt ( IntType  Int  )  [inline]

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned>
void* llvm::PointerIntPair< PointerTy, IntBits, IntType >::getOpaqueValue (  )  const [inline]

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned>
void llvm::PointerIntPair< PointerTy, IntBits, IntType >::setFromOpaqueValue ( void *  Val  )  [inline]

Definition at line 63 of file PointerIntPair.h.

Referenced by llvm::MemoryDependenceAnalysis::removeInstruction().

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned>
bool llvm::PointerIntPair< PointerTy, IntBits, IntType >::operator== ( const PointerIntPair< PointerTy, IntBits, IntType > &  RHS  )  const [inline]

Definition at line 65 of file PointerIntPair.h.

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned>
bool llvm::PointerIntPair< PointerTy, IntBits, IntType >::operator!= ( const PointerIntPair< PointerTy, IntBits, IntType > &  RHS  )  const [inline]

Definition at line 66 of file PointerIntPair.h.

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned>
bool llvm::PointerIntPair< PointerTy, IntBits, IntType >::operator< ( const PointerIntPair< PointerTy, IntBits, IntType > &  RHS  )  const [inline]

Definition at line 67 of file PointerIntPair.h.

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned>
bool llvm::PointerIntPair< PointerTy, IntBits, IntType >::operator> ( const PointerIntPair< PointerTy, IntBits, IntType > &  RHS  )  const [inline]

Definition at line 68 of file PointerIntPair.h.

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned>
bool llvm::PointerIntPair< PointerTy, IntBits, IntType >::operator<= ( const PointerIntPair< PointerTy, IntBits, IntType > &  RHS  )  const [inline]

Definition at line 69 of file PointerIntPair.h.

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned>
bool llvm::PointerIntPair< PointerTy, IntBits, IntType >::operator>= ( const PointerIntPair< PointerTy, IntBits, IntType > &  RHS  )  const [inline]

Definition at line 70 of file PointerIntPair.h.


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