Class representing a set of documents in a cluster. More...
#include <cluster.h>
Collaboration diagram for Xapian::DocumentSet:
Public Member Functions | |
| DocumentSet (const DocumentSet &other) | |
| Copying is allowed. More... | |
| DocumentSet & | operator= (const DocumentSet &other) |
| Assignment is allowed. More... | |
| DocumentSet (DocumentSet &&other) | |
| Move constructor. More... | |
| DocumentSet & | operator= (DocumentSet &&other) |
| Move assignment operator. More... | |
| DocumentSet () | |
| Default constructor. More... | |
| ~DocumentSet () | |
| Destructor. More... | |
| Xapian::doccount | size () const |
| Return the size of the DocumentSet. More... | |
| const Xapian::Document & | operator[] (Xapian::doccount i) const |
| Return the Document in the DocumentSet at index i. More... | |
| void | add_document (const Document &document) |
| Add a new Document to the DocumentSet. More... | |
Private Attributes | |
| Xapian::Internal::intrusive_ptr_nonnull< Internal > | internal |
Detailed Description
Constructor & Destructor Documentation
◆ DocumentSet() [1/3]
| Xapian::DocumentSet::DocumentSet | ( | const DocumentSet & | other | ) |
Copying is allowed.
The internals are reference counted, so copying is cheap.
- Parameters
-
other The object to copy.
◆ DocumentSet() [2/3]
| Xapian::DocumentSet::DocumentSet | ( | DocumentSet && | other | ) |
Move constructor.
- Parameters
-
other The object to move.
◆ DocumentSet() [3/3]
| Xapian::DocumentSet::DocumentSet | ( | ) |
Default constructor.
◆ ~DocumentSet()
| Xapian::DocumentSet::~DocumentSet | ( | ) |
Destructor.
Member Function Documentation
◆ add_document()
| void Xapian::DocumentSet::add_document | ( | const Document & | document | ) |
Add a new Document to the DocumentSet.
- Parameters
-
document Document object that is to be added to the DocumentSet
◆ operator=() [1/2]
| DocumentSet& Xapian::DocumentSet::operator= | ( | const DocumentSet & | other | ) |
Assignment is allowed.
The internals are reference counted, so assignment is cheap.
- Parameters
-
other The object to copy.
◆ operator=() [2/2]
| DocumentSet& Xapian::DocumentSet::operator= | ( | DocumentSet && | other | ) |
Move assignment operator.
- Parameters
-
other The object to move.
◆ operator[]()
| const Xapian::Document& Xapian::DocumentSet::operator[] | ( | Xapian::doccount | i | ) | const |
Return the Document in the DocumentSet at index i.
◆ size()
| Xapian::doccount Xapian::DocumentSet::size | ( | ) | const |
Return the size of the DocumentSet.
Member Data Documentation
◆ internal
|
private |
The documentation for this class was generated from the following file:
- include/xapian/cluster.h