NCBI C++ ToolKit
Public Attributes | List of all members
CDbIndex::SOptions Struct Reference

Search Toolkit Book for CDbIndex::SOptions

Simple record type used to specify index creation parameters. More...

#include <algo/blast/dbindex/dbindex.hpp>

+ Collaboration diagram for CDbIndex::SOptions:

Public Attributes

bool idmap
 Indicator of the index map creation. More...
 
bool legacy
 Indicator of the legacy index format. More...
 
unsigned long stride
 Stride to use for stored database locations. More...
 
unsigned long ws_hint
 Most likely word size to use for searches. More...
 
unsigned long hkey_width
 Width of the hash key in bits. More...
 
unsigned long chunk_size
 Long sequences are split into chunks of this size. More...
 
unsigned long chunk_overlap
 Amount by which individual chunks overlap. More...
 
unsigned long report_level
 Verbose index creation. More...
 
unsigned long max_index_size
 Maximum index size in megabytes. More...
 
std::string stat_file_name
 File to write index statistics into. More...
 

Detailed Description

Simple record type used to specify index creation parameters.

Definition at line 467 of file dbindex.hpp.

Member Data Documentation

◆ chunk_overlap

unsigned long CDbIndex::SOptions::chunk_overlap

Amount by which individual chunks overlap.

Definition at line 476 of file dbindex.hpp.

◆ chunk_size

unsigned long CDbIndex::SOptions::chunk_size

Long sequences are split into chunks of this size.

Definition at line 474 of file dbindex.hpp.

Referenced by CSubjectMap_Factory::CSubjectMap_Factory().

◆ hkey_width

unsigned long CDbIndex::SOptions::hkey_width

Width of the hash key in bits.

Definition at line 473 of file dbindex.hpp.

Referenced by CMkIndexApplication::Run(), CDbIndex_Factory::SaveHeader(), and COffsetList::SetIndexParams().

◆ idmap

bool CDbIndex::SOptions::idmap

Indicator of the index map creation.

Definition at line 469 of file dbindex.hpp.

Referenced by CDbIndex_Factory::do_create_1_2(), and CMkIndexApplication::Run().

◆ legacy

bool CDbIndex::SOptions::legacy

Indicator of the legacy index format.

Definition at line 470 of file dbindex.hpp.

Referenced by CMkIndexApplication::Run(), and CDbIndex_Factory::SaveHeader().

◆ max_index_size

unsigned long CDbIndex::SOptions::max_index_size

Maximum index size in megabytes.

Definition at line 478 of file dbindex.hpp.

Referenced by CDbIndex_Factory::do_create_1_2(), and CMkIndexApplication::Run().

◆ report_level

unsigned long CDbIndex::SOptions::report_level

Verbose index creation.

Definition at line 477 of file dbindex.hpp.

Referenced by CMkIndexApplication::Run().

◆ stat_file_name

std::string CDbIndex::SOptions::stat_file_name

File to write index statistics into.

Definition at line 480 of file dbindex.hpp.

Referenced by CMkIndexApplication::Run(), and COffsetData_Factory::Save().

◆ stride

unsigned long CDbIndex::SOptions::stride

Stride to use for stored database locations.

Definition at line 471 of file dbindex.hpp.

Referenced by COffsetData_Factory::EncodeAndAddOffset(), CMkIndexApplication::Run(), CDbIndex_Factory::SaveHeader(), and COffsetList::SetIndexParams().

◆ ws_hint

unsigned long CDbIndex::SOptions::ws_hint

Most likely word size to use for searches.

Definition at line 472 of file dbindex.hpp.

Referenced by CMkIndexApplication::Run(), CDbIndex_Factory::SaveHeader(), and COffsetList::SetIndexParams().


The documentation for this struct was generated from the following file:
Modified on Mon Feb 26 04:04:17 2024 by modify_doxy.py rev. 669887