Lucene++ - a full-featured, c++ search engine
API Documentation

Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes
Lucene::Set< TYPE, LESS > Class Template Reference

Utility template class to handle set based collections that can be safely copied and shared. More...

#include <Set.h>

Inheritance diagram for Lucene::Set< TYPE, LESS >:

Public Types

typedef Set< TYPE, LESS > this_type
typedef std::set< TYPE, LESS > set_type
typedef set_type::iterator iterator
typedef set_type::const_iterator const_iterator
typedef TYPE value_type

Public Member Functions

virtual ~Set ()
void reset ()
int32_t size () const
bool empty () const
void clear ()
iterator begin ()
iterator end ()
const_iterator begin () const
const_iterator end () const
bool add (const TYPE &type)
template<class ITER>
void addAll (ITER first, ITER last)
bool remove (const TYPE &type)
iterator find (const TYPE &type)
bool contains (const TYPE &type) const
bool equals (const this_type &other) const
template<class PRED>
bool equals (const this_type &other, PRED comp) const
void swap (this_type &other)
 operator bool () const
bool operator! () const
bool operator== (const this_type &other)
bool operator!= (const this_type &other)
Public Member Functions inherited from Lucene::LuceneSync
virtual ~LuceneSync ()
virtual SynchronizePtr getSync ()
 Return this object synchronize lock.
virtual LuceneSignalPtr getSignal ()
 Return this object signal.
virtual void lock (int32_t timeout=0)
 Lock this object using an optional timeout.
virtual void unlock ()
 Unlock this object.
virtual bool holdsLock ()
 Returns true if this object is currently locked by current thread.
virtual void wait (int32_t timeout=0)
 Wait for signal using an optional timeout.
virtual void notifyAll ()
 Notify all threads waiting for signal.

Static Public Member Functions

static this_type newInstance ()
template<class ITER>
static this_type newInstance (ITER first, ITER last)

Protected Attributes

boost::shared_ptr< set_type > setContainer
Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
LuceneSignalPtr objectSignal

Detailed Description

template<class TYPE, class LESS = std::less<TYPE>>
class Lucene::Set< TYPE, LESS >

Utility template class to handle set based collections that can be safely copied and shared.

Member Typedef Documentation

◆ const_iterator

template<class TYPE, class LESS = std::less<TYPE>>
typedef set_type::const_iterator Lucene::Set< TYPE, LESS >::const_iterator

◆ iterator

template<class TYPE, class LESS = std::less<TYPE>>
typedef set_type::iterator Lucene::Set< TYPE, LESS >::iterator

◆ set_type

template<class TYPE, class LESS = std::less<TYPE>>
typedef std::set<TYPE, LESS> Lucene::Set< TYPE, LESS >::set_type

◆ this_type

template<class TYPE, class LESS = std::less<TYPE>>
typedef Set<TYPE, LESS> Lucene::Set< TYPE, LESS >::this_type

◆ value_type

template<class TYPE, class LESS = std::less<TYPE>>
typedef TYPE Lucene::Set< TYPE, LESS >::value_type

Constructor & Destructor Documentation

◆ ~Set()

template<class TYPE, class LESS = std::less<TYPE>>
virtual Lucene::Set< TYPE, LESS >::~Set ( )
inlinevirtual

Member Function Documentation

◆ add()

template<class TYPE, class LESS = std::less<TYPE>>
bool Lucene::Set< TYPE, LESS >::add ( const TYPE & type)
inline

◆ addAll()

template<class TYPE, class LESS = std::less<TYPE>>
template<class ITER>
void Lucene::Set< TYPE, LESS >::addAll ( ITER first,
ITER last )
inline

◆ begin() [1/2]

template<class TYPE, class LESS = std::less<TYPE>>
iterator Lucene::Set< TYPE, LESS >::begin ( )
inline

◆ begin() [2/2]

template<class TYPE, class LESS = std::less<TYPE>>
const_iterator Lucene::Set< TYPE, LESS >::begin ( ) const
inline

◆ clear()

template<class TYPE, class LESS = std::less<TYPE>>
void Lucene::Set< TYPE, LESS >::clear ( )
inline

◆ contains()

template<class TYPE, class LESS = std::less<TYPE>>
bool Lucene::Set< TYPE, LESS >::contains ( const TYPE & type) const
inline

◆ empty()

template<class TYPE, class LESS = std::less<TYPE>>
bool Lucene::Set< TYPE, LESS >::empty ( ) const
inline

◆ end() [1/2]

template<class TYPE, class LESS = std::less<TYPE>>
iterator Lucene::Set< TYPE, LESS >::end ( )
inline

◆ end() [2/2]

template<class TYPE, class LESS = std::less<TYPE>>
const_iterator Lucene::Set< TYPE, LESS >::end ( ) const
inline

◆ equals() [1/2]

template<class TYPE, class LESS = std::less<TYPE>>
bool Lucene::Set< TYPE, LESS >::equals ( const this_type & other) const
inline

Referenced by equals().

◆ equals() [2/2]

template<class TYPE, class LESS = std::less<TYPE>>
template<class PRED>
bool Lucene::Set< TYPE, LESS >::equals ( const this_type & other,
PRED comp ) const
inline

◆ find()

template<class TYPE, class LESS = std::less<TYPE>>
iterator Lucene::Set< TYPE, LESS >::find ( const TYPE & type)
inline

◆ newInstance() [1/2]

template<class TYPE, class LESS = std::less<TYPE>>
this_type Lucene::Set< TYPE, LESS >::newInstance ( )
inlinestatic

◆ newInstance() [2/2]

template<class TYPE, class LESS = std::less<TYPE>>
template<class ITER>
this_type Lucene::Set< TYPE, LESS >::newInstance ( ITER first,
ITER last )
inlinestatic

◆ operator bool()

template<class TYPE, class LESS = std::less<TYPE>>
Lucene::Set< TYPE, LESS >::operator bool ( ) const
inline

◆ operator!()

template<class TYPE, class LESS = std::less<TYPE>>
bool Lucene::Set< TYPE, LESS >::operator! ( ) const
inline

◆ operator!=()

template<class TYPE, class LESS = std::less<TYPE>>
bool Lucene::Set< TYPE, LESS >::operator!= ( const this_type & other)
inline

◆ operator==()

template<class TYPE, class LESS = std::less<TYPE>>
bool Lucene::Set< TYPE, LESS >::operator== ( const this_type & other)
inline

◆ remove()

template<class TYPE, class LESS = std::less<TYPE>>
bool Lucene::Set< TYPE, LESS >::remove ( const TYPE & type)
inline

◆ reset()

template<class TYPE, class LESS = std::less<TYPE>>
void Lucene::Set< TYPE, LESS >::reset ( )
inline

◆ size()

template<class TYPE, class LESS = std::less<TYPE>>
int32_t Lucene::Set< TYPE, LESS >::size ( ) const
inline

◆ swap()

template<class TYPE, class LESS = std::less<TYPE>>
void Lucene::Set< TYPE, LESS >::swap ( this_type & other)
inline

Field Documentation

◆ setContainer

template<class TYPE, class LESS = std::less<TYPE>>
boost::shared_ptr<set_type> Lucene::Set< TYPE, LESS >::setContainer
protected

Referenced by equals(), newInstance(), newInstance(), operator!=(), operator==(), and swap().

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

clucene.sourceforge.net