Class representing a list of search results. More...
#include <eset.h>
Collaboration diagram for Xapian::ESet:
Classes | |
| class | Internal |
| Class which actually implements Xapian::ESet. More... | |
Public Member Functions | |
| ESet (const ESet &o) | |
| Copying is allowed. More... | |
| ESet & | operator= (const ESet &o) |
| Copying is allowed. More... | |
| ESet (ESet &&o) | |
| Move constructor. More... | |
| ESet & | operator= (ESet &&o) |
| Move assignment operator. More... | |
| ESet () | |
| Default constructor. More... | |
| ~ESet () | |
| Destructor. More... | |
| Xapian::termcount | size () const |
| Return number of items in this ESet object. More... | |
| bool | empty () const |
| Return true if this ESet object is empty. More... | |
| Xapian::termcount | get_ebound () const |
| Return a bound on the full size of this ESet object. More... | |
| void | swap (ESet &o) |
| Efficiently swap this ESet object with another. More... | |
| ESetIterator | begin () const |
| Return iterator pointing to the first item in this ESet. More... | |
| ESetIterator | end () const |
| Return iterator pointing to just after the last item in this ESet. More... | |
| ESetIterator | operator[] (Xapian::termcount i) const |
| Return iterator pointing to the i-th object in this ESet. More... | |
| ESetIterator | back () const |
| Return iterator pointing to the last object in this ESet. More... | |
| std::string | get_description () const |
| Return a string describing this object. More... | |
Private Types | |
| typedef Xapian::ESetIterator | value_type |
| typedef Xapian::termcount | size_type |
| typedef Xapian::termcount_diff | difference_type |
| typedef Xapian::ESetIterator | iterator |
| typedef Xapian::ESetIterator | const_iterator |
| typedef value_type * | pointer |
| typedef const value_type * | const_pointer |
| typedef value_type | reference |
| typedef const value_type | const_reference |
Private Member Functions | |
| Xapian::termcount | max_size () const |
Private Attributes | |
| Xapian::Internal::intrusive_ptr_nonnull< Internal > | internal |
Friends | |
| class | ESetIterator |
Detailed Description
Member Typedef Documentation
◆ const_iterator
|
private |
◆ const_pointer
|
private |
◆ const_reference
|
private |
◆ difference_type
|
private |
◆ iterator
|
private |
◆ pointer
|
private |
◆ reference
|
private |
◆ size_type
|
private |
◆ value_type
|
private |
ESet is what the C++ STL calls a container.
The following typedefs allow the class to be used in templates in the same way the standard containers can be.
These are deliberately hidden from the Doxygen-generated docs, as the machinery here isn't interesting to API users. They just need to know that Xapian container classes are compatible with the STL.
See "The C++ Programming Language", 3rd ed. section 16.3.1:
Constructor & Destructor Documentation
◆ ESet() [1/3]
|
default |
Copying is allowed.
The internals are reference counted, so copying is cheap.
◆ ESet() [2/3]
|
default |
Move constructor.
◆ ESet() [3/3]
| Xapian::ESet::ESet | ( | ) |
Default constructor.
Creates an empty ESet, mostly useful as a placeholder.
Definition at line 184 of file esetinternal.cc.
◆ ~ESet()
| Xapian::ESet::~ESet | ( | ) |
Destructor.
Definition at line 196 of file esetinternal.cc.
Member Function Documentation
◆ back()
|
inline |
Return iterator pointing to the last object in this ESet.
Definition at line 341 of file eset.h.
References ESetIterator.
Referenced by DEFINE_TESTCASE().
◆ begin()
|
inline |
Return iterator pointing to the first item in this ESet.
Definition at line 324 of file eset.h.
References ESetIterator, and size().
Referenced by DEFINE_TESTCASE(), and main().
◆ empty()
|
inline |
◆ end()
|
inline |
Return iterator pointing to just after the last item in this ESet.
Definition at line 329 of file eset.h.
References ESetIterator.
Referenced by DEFINE_TESTCASE(), and main().
◆ get_description()
| std::string Xapian::ESet::get_description | ( | ) | const |
Return a string describing this object.
Definition at line 211 of file esetinternal.cc.
Referenced by DEFINE_TESTCASE().
◆ get_ebound()
| Xapian::termcount Xapian::ESet::get_ebound | ( | ) | const |
Return a bound on the full size of this ESet object.
This is a bound on size() if get_eset() had been called with maxitems set high enough that all results were returned.
Definition at line 205 of file esetinternal.cc.
Referenced by DEFINE_TESTCASE().
◆ max_size()
|
inlineprivate |
ESet is what the C++ STL calls a container.
The following methods allow the class to be used in templates in the same way the standard containers can be.
These are deliberately hidden from the Doxygen-generated docs, as the machinery here isn't interesting to API users. They just need to know that Xapian container classes are compatible with the STL.
◆ operator=() [1/2]
Copying is allowed.
The internals are reference counted, so assignment is cheap.
◆ operator=() [2/2]
◆ operator[]()
|
inline |
Return iterator pointing to the i-th object in this ESet.
Definition at line 336 of file eset.h.
References ESetIterator, and size().
◆ size()
| Xapian::termcount Xapian::ESet::size | ( | ) | const |
Return number of items in this ESet object.
Definition at line 199 of file esetinternal.cc.
References internal, and Xapian::ESet::Internal::items.
Referenced by begin(), DEFINE_TESTCASE(), Xapian::iterator_rewind(), Xapian::iterator_rewound(), and operator[]().
◆ swap()
|
inline |
Friends And Related Function Documentation
◆ ESetIterator
|
friend |
Member Data Documentation
◆ internal
|
private |
Reference counted internals.
Definition at line 49 of file eset.h.
Referenced by Xapian::ESetIterator::get_description(), Xapian::Enquire::Internal::get_eset(), Xapian::ESetIterator::get_weight(), Xapian::ESetIterator::operator*(), size(), and swap().
The documentation for this class was generated from the following files:
- include/xapian/eset.h
- expand/esetinternal.cc