Xpace
Xpace::SortContext Struct Reference

Parameters for sorting. More...

#include <index.h>

Public Types

enum  unindexedAct { unindexedDrop = 0, unindexedfirst = 1, unindexedLast = 2 }
 What to do with unindexed terms. More...
 

Public Member Functions

 SortContext (const Index *index, bool ascend=true, bool keepDuplicates=true, unindexedAct unindexed=unindexedDrop)
 

Public Attributes

const Indexindex
 Sort using this index. More...
 
bool ascend
 Sort ascending if true, descending if false. More...
 
bool keepDuplicates
 If true, repeat recurring terms (single sort only) More...
 
unindexedAct unindexed
 

Detailed Description

Parameters for sorting.

Definition at line 381 of file index.h.

Member Enumeration Documentation

What to do with unindexed terms.

Enumerator
unindexedDrop 

drop them

unindexedfirst 

return them first

unindexedLast 

return them last

Definition at line 389 of file index.h.

Constructor & Destructor Documentation

Xpace::SortContext::SortContext ( const Index index,
bool  ascend = true,
bool  keepDuplicates = true,
unindexedAct  unindexed = unindexedDrop 
)

Member Data Documentation

const Index* Xpace::SortContext::index

Sort using this index.

Definition at line 383 of file index.h.

bool Xpace::SortContext::ascend

Sort ascending if true, descending if false.

Definition at line 385 of file index.h.

bool Xpace::SortContext::keepDuplicates

If true, repeat recurring terms (single sort only)

Definition at line 386 of file index.h.

unindexedAct Xpace::SortContext::unindexed

Definition at line 395 of file index.h.


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

current as of Wed Jun 10 2026 12:00:06