NCBI C++ ToolKit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
CIndexDeltaSumCache Class Reference

Search Toolkit Book for CIndexDeltaSumCache

#include <objects/seqtable/impl/delta_cache.hpp>

+ Inheritance diagram for CIndexDeltaSumCache:
+ Collaboration diagram for CIndexDeltaSumCache:

Public Types

typedef CSeqTable_sparse_index_Base::TIndexes_delta TDeltas
 
typedef size_t TValue
 
- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 

Public Member Functions

 CIndexDeltaSumCache (size_t size)
 
 ~CIndexDeltaSumCache (void)
 
TValue GetDeltaSum (const TDeltas &deltas, size_t index)
 
size_t FindDeltaSum (const TDeltas &deltas, TValue find_sum)
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 

Protected Member Functions

TValue x_GetDeltaSum2 (const TDeltas &deltas, size_t block_index, size_t block_offset)
 
size_t x_FindDeltaSum2 (const TDeltas &deltas, size_t block_index, TValue find_sum)
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Protected Attributes

AutoArray< TValuem_Blocks
 
size_t m_BlocksFilled
 
AutoArray< TValuem_CacheBlockInfo
 
size_t m_CacheBlockIndex
 

Static Protected Attributes

static const size_t kBlockSize = 128
 
static const size_t kInvalidRow = CSeqTable_sparse_index::kInvalidRow
 
static const size_t kBlockTooLow = CIndexDeltaSumCache::kInvalidRow-1
 

Additional Inherited Members

- Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 

Detailed Description

Definition at line 132 of file delta_cache.hpp.

Member Typedef Documentation

◆ TDeltas

Definition at line 138 of file delta_cache.hpp.

◆ TValue

Definition at line 139 of file delta_cache.hpp.

Constructor & Destructor Documentation

◆ CIndexDeltaSumCache()

CIndexDeltaSumCache::CIndexDeltaSumCache ( size_t  size)

Definition at line 238 of file SeqTable_sparse_index.cpp.

◆ ~CIndexDeltaSumCache()

CIndexDeltaSumCache::~CIndexDeltaSumCache ( void  )

Definition at line 249 of file SeqTable_sparse_index.cpp.

Member Function Documentation

◆ FindDeltaSum()

size_t CIndexDeltaSumCache::FindDeltaSum ( const TDeltas deltas,
TValue  find_sum 
)

◆ GetDeltaSum()

CIndexDeltaSumCache::TValue CIndexDeltaSumCache::GetDeltaSum ( const TDeltas deltas,
size_t  index 
)

◆ x_FindDeltaSum2()

size_t CIndexDeltaSumCache::x_FindDeltaSum2 ( const TDeltas deltas,
size_t  block_index,
TValue  find_sum 
)
inlineprotected

◆ x_GetDeltaSum2()

CIndexDeltaSumCache::TValue CIndexDeltaSumCache::x_GetDeltaSum2 ( const TDeltas deltas,
size_t  block_index,
size_t  block_offset 
)
inlineprotected

Member Data Documentation

◆ kBlockSize

const size_t CIndexDeltaSumCache::kBlockSize = 128
staticprotected

Definition at line 155 of file delta_cache.hpp.

Referenced by FindDeltaSum(), GetDeltaSum(), x_FindDeltaSum2(), and x_GetDeltaSum2().

◆ kBlockTooLow

const size_t CIndexDeltaSumCache::kBlockTooLow = CIndexDeltaSumCache::kInvalidRow-1
staticprotected

Definition at line 159 of file delta_cache.hpp.

Referenced by FindDeltaSum(), and x_FindDeltaSum2().

◆ kInvalidRow

const size_t CIndexDeltaSumCache::kInvalidRow = CSeqTable_sparse_index::kInvalidRow
staticprotected

Definition at line 158 of file delta_cache.hpp.

Referenced by FindDeltaSum(), and x_FindDeltaSum2().

◆ m_Blocks

AutoArray<TValue> CIndexDeltaSumCache::m_Blocks
protected

Definition at line 165 of file delta_cache.hpp.

Referenced by FindDeltaSum(), x_FindDeltaSum2(), and x_GetDeltaSum2().

◆ m_BlocksFilled

size_t CIndexDeltaSumCache::m_BlocksFilled
protected

Definition at line 167 of file delta_cache.hpp.

Referenced by FindDeltaSum(), GetDeltaSum(), x_FindDeltaSum2(), and x_GetDeltaSum2().

◆ m_CacheBlockIndex

size_t CIndexDeltaSumCache::m_CacheBlockIndex
protected

Definition at line 176 of file delta_cache.hpp.

Referenced by x_GetDeltaSum2().

◆ m_CacheBlockInfo

AutoArray<TValue> CIndexDeltaSumCache::m_CacheBlockInfo
protected

Definition at line 174 of file delta_cache.hpp.

Referenced by x_FindDeltaSum2(), and x_GetDeltaSum2().


The documentation for this class was generated from the following files:
Modified on Thu Dec 07 10:06:11 2023 by modify_doxy.py rev. 669887