gatb.core-API-0.0.0
Public Member Functions | List of all members
Bag< Item > Class Template Referenceabstract

Bag interface. More...

#include <Bag.hpp>

Inheritance diagram for Bag< Item >:
Inheritance graph

Public Member Functions

virtual void insert (const Item &item)=0
 
virtual void insert (const std::vector< Item > &items, size_t length=0)
 
virtual void insert (const Item *items, size_t length)
 
virtual void flush ()=0
 
- Public Member Functions inherited from ISmartPointer
virtual ~ISmartPointer ()
 
virtual void use ()=0
 
virtual void forget ()=0
 

Detailed Description

template<class Item>
class gatb::core::tools::collections::Bag< Item >

Bag interface.

A bag is something we can put items into. Such items are typed and the type is provided as a template.

Several ways for inserting items exist. There is also a flush method that makes sure that all the inserted items are actually in the bag.

Member Function Documentation

virtual void flush ( )
pure virtual

Flush the current content. May be useful for implementation that uses a cache.

Implemented in BloomNull< Item >, Bloom< Item >, BagCacheSorted< Item >, BagCacheSortedBuffered< Item >, BankComposite, BagHDF5< Item >, CollectionAbstract< Item >, BagCache< Item >, BagCache< Type >, BankStrings, BagFile< Item >, BankDelegate, BankBinary, BankFasta, BankSplitter, BankRandom, and BankKmers.

virtual void insert ( const Item &  item)
pure virtual

Insert an item into the bag.

Parameters
[in]item: the item to be inserted.

Implemented in BloomExtendedNeighborCoherent< Item >, BloomNeighborCoherent< Item >, BloomCacheCoherent< Item >, BloomSynchronized< Item >, BloomNull< Item >, Bloom< Item >, BagCacheSorted< Item >, BagCacheSortedBuffered< Item >, CollectionAbstract< Item >, BagCache< Item >, BagCache< Type >, BagFile< Item >, and BagHDF5< Item >.

virtual void insert ( const std::vector< Item > &  items,
size_t  length = 0 
)
inlinevirtual

Insert items into the bag.

Parameters
[in]items: items to be inserted.
[in]length: the number of items to be inserted. If 0 (default value), all the items of the vector are inserted.

Reimplemented in CollectionAbstract< Item >, BagFile< Item >, and BagHDF5< Item >.

virtual void insert ( const Item *  items,
size_t  length 
)
inlinevirtual

Insert items into the bag.

Parameters
[in]items: items to be inserted.
[in]length: number of items to be inserted.

Reimplemented in CollectionAbstract< Item >, BagFile< Item >, and BagHDF5< Item >.

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