NCBI C++ ToolKit
Classes | Macros | Typedefs | Functions
dbindex_sp.hpp File Reference
#include <corelib/ncbifile.hpp>
#include <algo/blast/dbindex/dbindex.hpp>
+ Include dependency graph for dbindex_sp.hpp:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Go to the SVN repository for this file.

Classes

class  CPreOrderedOffsetIterator
 Iterator for 0-terminated pre-ordered offset lists. More...
 
class  COffsetData< iterator_t >
 Iterator specific functionality of offset list manager class. More...
 
struct  CDbIndex_Traits< LEGACY >
 Some computed type definitions. More...
 
class  CDbIndex_Impl< LEGACY >
 Implementation of the BLAST database index. More...
 

Macros

#define INLINE   NCBI_INLINE
 

Typedefs

typedef CDbIndex::TSeqNum TSeqNum
 Forwarding declarations for convenience. More...
 
typedef CDbIndex::TWord TWord
 

Functions

template<typename word_t >
void ReadWord (CNcbiIstream &is, word_t &data)
 Read a word from the input stream. More...
 
template<bool LEGACY>
const SIndexHeader ReadIndexHeader (void *map)
 Read the index header information from the given input stream. More...
 
template<bool LEGACY>
unsigned long GetIndexStride (const SIndexHeader &header)
 Get the stride value associated with the index. More...
 
template<bool LEGACY>
unsigned long GetIndexWSHint (const SIndexHeader &header)
 Get the ws_hint value associated with the index. More...
 
CMemoryFileMapFile (const std::string &fname)
 Memory map a file and return a pointer to the mapped area. More...
 

Macro Definition Documentation

◆ INLINE

#define INLINE   NCBI_INLINE

Definition at line 42 of file dbindex_sp.hpp.

Typedef Documentation

◆ TSeqNum

Forwarding declarations for convenience.

Definition at line 45 of file dbindex_sp.hpp.

◆ TWord

Definition at line 46 of file dbindex_sp.hpp.

Function Documentation

◆ GetIndexStride()

template<bool LEGACY>
unsigned long GetIndexStride ( const SIndexHeader header)

Get the stride value associated with the index.

Parameters
headerthe index header structure
Returns
the stride value

◆ GetIndexWSHint()

template<bool LEGACY>
unsigned long GetIndexWSHint ( const SIndexHeader header)

Get the ws_hint value associated with the index.

Parameters
headerthe index header structure
Returns
the ws_hint value

◆ MapFile()

CMemoryFile* MapFile ( const std::string fname)

Memory map a file and return a pointer to the mapped area.

Parameters
fname[I] file name
Returns
pointer to the start of the mapped memory area

Definition at line 68 of file dbindex_search.cpp.

References ERR_POST, and result.

Referenced by CDbIndex::LoadIndex().

◆ ReadIndexHeader()

template<bool LEGACY>
const SIndexHeader ReadIndexHeader ( void *  map)

Read the index header information from the given input stream.

Parameters
map[I] pointer to the start of the mapped index data
Returns
the index header structure filled with the values read from map

◆ ReadWord()

template<typename word_t >
void ReadWord ( CNcbiIstream is,
word_t &  data 
)

Read a word from the input stream.

Parameters
word_tword type (must be an integer type)
is[I/O] input stream
data[O] storage for the value obtained from the stream

Definition at line 55 of file dbindex_sp.hpp.

References data, and result.

Referenced by GetIndexVersion().

Modified on Mon Jul 15 05:33:24 2024 by modify_doxy.py rev. 669887