SimilarityScheduler< SIM > Class Template Reference

#include <SimilarityScheduler.h>

Public Types
typedef size_t	ContainerIdentifier

Public Member Functions
	SimilarityScheduler (JsonContainerQueue::queue_t *queue, size_t contSize=0)
ContainerIdentifier	getContainerForDoc (std::string &raw)
ContainerIdentifier	getContainerForDoc (const RJDocument &doc)
ContainerIdentifier	getContainerForDoc (rapidjson::IStreamWrapper &stream)
std::unique_ptr< RJDocument >	getNewDoc (ContainerIdentifier id)
void	scheduleDocument (ContainerIdentifier id, std::unique_ptr< RJDocument > &&doc, std::unique_ptr< IOrigin > &&origin, size_t size)
virtual	~SimilarityScheduler ()=default
void	finalize ()

Detailed Description

template<typename SIM>
class SimilarityScheduler< SIM >

A document scheduler based on document similarity. Similar documents are grouped into the same containers.

Template Parameters

SIM	The similarity measure to use.

Member Typedef Documentation

ContainerIdentifier

template<typename SIM >

typedef size_t SimilarityScheduler< SIM >::ContainerIdentifier

Constructor & Destructor Documentation

SimilarityScheduler()

template<typename SIM >

SimilarityScheduler< SIM >::SimilarityScheduler ( JsonContainerQueue::queue_t *  queue, size_t  contSize = 0  )

explicit

Constructs a scheduler for use within the parsers.

Parameters

queue	The container queue to use to pass finalized containers through.
contSize	The size of newly constructed containers.

~SimilarityScheduler()

template<typename SIM >

virtual SimilarityScheduler< SIM >::~SimilarityScheduler ( )

virtualdefault

Member Function Documentation

finalize()

template<typename SIM >

void SimilarityScheduler< SIM >::finalize

Finalizes the Scheduler. Has to be called before deconstructing it.

getContainerForDoc() [1/3]

template<typename SIM >

SimilarityScheduler< SIM >::ContainerIdentifier SimilarityScheduler< SIM >::getContainerForDoc

(

const RJDocument &

doc

)

Uses the document to get the container in which the document should be stored.

Parameters

doc	The document

Returns

An identifier representing the container in which the document will be stored.

Here is the call graph for this function:

getContainerForDoc() [2/3]

template<typename SIM >

SimilarityScheduler< SIM >::ContainerIdentifier SimilarityScheduler< SIM >::getContainerForDoc

(

rapidjson::IStreamWrapper &

stream

)

Uses the stream of a document to get the container in which the document should be stored.

Parameters

stream

The document in a stream (before parsing)

Returns

An identifier representing the container in which the document will be stored.

Here is the call graph for this function:

getContainerForDoc() [3/3]

template<typename SIM >

SimilarityScheduler< SIM >::ContainerIdentifier SimilarityScheduler< SIM >::getContainerForDoc

(

std::string &

raw

)

Uses the string representation of a document to get the container in which the document should be stored.

Parameters

raw	The document in string representation (before parsing)

Returns

An identifier representing the container in which the document will be stored.

Here is the call graph for this function:

getNewDoc()

template<typename SIM >

std::unique_ptr< RJDocument > SimilarityScheduler< SIM >::getNewDoc

(

ContainerIdentifier

id

)

Returns a document initialized with the allocator of the container represented by id

Parameters

id	The id representing the container

Returns

A new document

scheduleDocument()

template<typename SIM >

void SimilarityScheduler< SIM >::scheduleDocument	(	ContainerIdentifier	id,
		std::unique_ptr< RJDocument > &&	doc,
		std::unique_ptr< IOrigin > &&	origin,
		size_t	size
	)

Schedules the document into the container given by id.

Parameters

id	The id of the container
doc	The document to schedule
origin	The origin of the document
size	The size of the document (bytes)

---

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

• /home/nico/joda_tmp/tmp-joda-dirs/JODA-gh/libs/joda/core/modules/similarity/include/joda/similarity/SimilarityScheduler.h