Classes
class	AbstractBoWDocumentHandler

class	AbstractBoWElement
	This class is the abstract base class of all elements that can be stored in a BoWText. More...

class	BinaryWriterBoWDocumentHandler

class	BoWBinaryReader

class	BoWBinaryReaderPrivate

class	BoWBinaryWriter

class	BoWBinaryWriterPrivate

class	BoWComplexToken
	This is a complex token for an index. More...

class	BoWComplexTokenPrivate

class	BoWDocument
	represent a document as a Bag Of Word, with associated document properties. More...

class	BoWDocumentST

class	BoWNamedEntity
	This is a complex token used to represent a named entity token. More...

class	BoWNamedEntityPrivate

class	BoWPredicate
	This is a BoW element used to represent a predicate (n-ary relation, template or semantic frame). More...

class	BoWPredicatePrivate

class	BoWRelation
	This class is used to type the relation between a part and its enclosing complex token. More...

class	BoWTerm
	This is a complex token used to represent a multiword term. More...

class	BoWTermPrivate

class	BoWText
	This class represents a list of elements, that are pointers on polymmorphic tokens that can be simple tokens or complex tokens such as terms or named entities. More...

class	BoWToken
	This class contains the representation of an element of the bag of words. More...

class	BoWTokenIterator

class	BoWTokenIteratorPrivate

class	BoWTokenPrivate

class	BoWXmlReader
	XML input/output for BoW elements. More...

class	BoWXmlReaderPrivate

class	BoWXMLWriter

class	BoWXMLWriterPrivate

class	DefaultIdGenerator

class	DefaultIdGeneratorPrivate

class	IndexElement
	Represent an element of an index If it is a predicate, its simple term is "PredicateElement" and its neType is the type of the predicate. More...

class	IndexElementIterator
	An iterator on the bowText that returns IndexElements. More...

class	IndexElementIteratorPrivate

class	IndexElementPrivate

class	InputErrorException

class	LTR_Text
	a linear text representation More...

class	LTR_Token
	a token of a linear text representation Each LTR_Token represents the set of words that start at a position. More...

class	NoAttributeException

class	TextWriterBoWDocumentHandler

class	TextWriterBoWDocumentHandlerPrivate

Enumerations
enum class	BoWType : unsigned short { BOW_NOTYPE , BOW_TOKEN , BOW_TERM , BOW_NAMEDENTITY , BOW_PREDICATE }
	enum to characterize the type of the AbstractBoWElement More...

enum	BoWFileType : unsigned char { BOWFILE_NOTYPE , BOWFILE_TEXT , BOWFILE_DOCUMENT , BOWFILE_DOCUMENTST , BOWFILE_SDOCUMENT }

enum	BoWBlocType : unsigned char { DOCUMENT_PROPERTIES_BLOC , BOW_TEXT_BLOC , BIN_NUM_BLOC , ST_BLOC , END_BLOC , NODE_PROPERTIES_BLOC , HIERARCHY_BLOC , INDEXING_BLOC }

enum	BoWTokenIteratorNamedEntitiesPartsPolicy { ITERATE_THROUGH_NAMEDENTITIES_PARTS , DO_NOT_ITERATE_THROUGH_NAMEDENTITIES_PARTS }

Functions
LIMA_BOW_EXPORT uint8_t	toInt (const BoWType &bt)

template<typename T >
T &	operator<< (T &qd, const BoWType &bt)

std::ostream &	operator<< (std::ostream &out, const BoWBlocType &blocType)

QDebug &	operator<< (QDebug &out, const BoWBlocType &blocType)

std::istream &	operator>> (std::istream &in, BoWBlocType &blocType)

std::string	getBlocTypeString (BoWBlocType blocType)

std::ostream &	operator<< (std::ostream &os, const BoWDocument &d)

QDebug &	operator<< (QDebug &os, const BoWDocument &d)

std::ostream &	operator<< (std::ostream &os, const BoWDocumentST &d)
	!!! ugly cut'n'paste !!!!

std::ostream &	operator<< (std::ostream &os, const BoWRelation &rel)

QDebug &	operator<< (QDebug &os, const BoWRelation &rel)

std::ostream &	operator<< (std::ostream &os, const BoWTerm &t)

std::ostream &	operator<< (std::ostream &os, const BoWText &text)

QDebug &	operator<< (QDebug &os, const BoWText &text)

std::ostream &	operator<< (std::ostream &os, const BoWToken &tok)

QDebug &	operator<< (QDebug &os, const BoWToken &tok)

std::ostream &	operator<< (std::ostream &os, const IndexElement &elt)

QDebug &	operator<< (QDebug &os, const IndexElement &elt)

QTextStream &	operator<< (QTextStream &os, const IndexElement &elt)

std::ostream &	operator<< (std::ostream &os, const LTR_Text &text)

QDebug &	operator<< (QDebug &os, const LTR_Text &text)

std::ostream &	operator<< (std::ostream &os, const LTR_Token &tok)

QDebug &	operator<< (QDebug &os, const LTR_Token &tok)

Enumeration Type Documentation

◆ BoWBlocType

enum Lima::Common::BagOfWords::BoWBlocType : unsigned char

Enumerator
DOCUMENT_PROPERTIES_BLOC
BOW_TEXT_BLOC
BIN_NUM_BLOC
ST_BLOC
END_BLOC
NODE_PROPERTIES_BLOC
HIERARCHY_BLOC
INDEXING_BLOC

Definition at line 34 of file bowDocument.h.

◆ BoWFileType

enum Lima::Common::BagOfWords::BoWFileType : unsigned char

Enumerator
BOWFILE_NOTYPE
BOWFILE_TEXT
BOWFILE_DOCUMENT
BOWFILE_DOCUMENTST
BOWFILE_SDOCUMENT

Definition at line 48 of file bowBinaryReaderWriter.h.

◆ BoWTokenIteratorNamedEntitiesPartsPolicy

enum Lima::Common::BagOfWords::BoWTokenIteratorNamedEntitiesPartsPolicy

Enumerator
ITERATE_THROUGH_NAMEDENTITIES_PARTS
DO_NOT_ITERATE_THROUGH_NAMEDENTITIES_PARTS

Definition at line 32 of file bowTokenIterator.h.

◆ BoWType

enum class Lima::Common::BagOfWords::BoWType : unsigned short

strong

enum to characterize the type of the AbstractBoWElement

Enumerator
BOW_NOTYPE	the AbstractBoWElement is an abstract one that should not be instanciated
BOW_TOKEN	the AbstractBoWElement is a simple token
BOW_TERM	the AbstractBoWElement is a multi-term
BOW_NAMEDENTITY	the AbstractBoWElement is a named entity
BOW_PREDICATE	the AbstractBoWElement is a predicate (n-ary relation, template or semantic frame

Definition at line 38 of file AbstractBoWElement.h.

Function Documentation

◆ getBlocTypeString()

LIMA_BOW_EXPORT std::string Lima::Common::BagOfWords::getBlocTypeString ( BoWBlocType blocType )

Definition at line 55 of file bowDocument.cpp.

◆ operator<<() [1/20]

QDebug & Lima::Common::BagOfWords::operator<<	(	QDebug &	os,
		const BoWDocument &	d
	)

Definition at line 238 of file bowDocument.cpp.

◆ operator<<() [2/20]

LIMA_BOW_EXPORT QDebug & Lima::Common::BagOfWords::operator<<	(	QDebug &	os,
		const BoWRelation &	rel
	)

Definition at line 212 of file BoWRelation.cpp.

◆ operator<<() [3/20]

QDebug & Lima::Common::BagOfWords::operator<<	(	QDebug &	os,
		const BoWText &	text
	)

Definition at line 110 of file bowText.cpp.

◆ operator<<() [4/20]

QDebug & Lima::Common::BagOfWords::operator<<	(	QDebug &	os,
		const BoWToken &	tok
	)

Definition at line 423 of file bowToken.cpp.

◆ operator<<() [5/20]

QDebug & Lima::Common::BagOfWords::operator<<	(	QDebug &	os,
		const IndexElement &	elt
	)

Definition at line 378 of file indexElement.cpp.

◆ operator<<() [6/20]

LIMA_LINEARTEXTREPRESENTATION_EXPORT QDebug & Lima::Common::BagOfWords::operator<<	(	QDebug &	os,
		const LTR_Text &	text
	)

Definition at line 157 of file ltrText.cpp.

◆ operator<<() [7/20]

LIMA_LINEARTEXTREPRESENTATION_EXPORT QDebug & Lima::Common::BagOfWords::operator<<	(	QDebug &	os,
		const LTR_Token &	tok
	)

Definition at line 110 of file ltrToken.cpp.

◆ operator<<() [8/20]

LIMA_BOW_EXPORT QDebug & Lima::Common::BagOfWords::operator<<	(	QDebug &	out,
		const BoWBlocType &	blocType
	)

Definition at line 40 of file bowDocument.cpp.

◆ operator<<() [9/20]

QTextStream & Lima::Common::BagOfWords::operator<<	(	QTextStream &	os,
		const IndexElement &	elt
	)

Definition at line 412 of file indexElement.cpp.

◆ operator<<() [10/20]

std::ostream & Lima::Common::BagOfWords::operator<<	(	std::ostream &	os,
		const BoWDocument &	d
	)

Definition at line 231 of file bowDocument.cpp.

◆ operator<<() [11/20]

std::ostream & Lima::Common::BagOfWords::operator<<	(	std::ostream &	os,
		const BoWDocumentST &	d
	)

!!! ugly cut'n'paste !!!!

specialization of << operator for taking into account sentence breaks and topic shifts

Author: Olivier Ferret

Definition at line 133 of file bowDocumentST.cpp.

◆ operator<<() [12/20]

LIMA_BOW_EXPORT std::ostream & Lima::Common::BagOfWords::operator<<	(	std::ostream &	os,
		const BoWRelation &	rel
	)

Definition at line 206 of file BoWRelation.cpp.

◆ operator<<() [13/20]

LIMA_BOW_EXPORT std::ostream & Lima::Common::BagOfWords::operator<<	(	std::ostream &	os,
		const BoWTerm &	t
	)

Definition at line 115 of file bowTerm.cpp.

◆ operator<<() [14/20]

std::ostream & Lima::Common::BagOfWords::operator<<	(	std::ostream &	os,
		const BoWText &	text
	)

Definition at line 103 of file bowText.cpp.

◆ operator<<() [15/20]

std::ostream & Lima::Common::BagOfWords::operator<<	(	std::ostream &	os,
		const BoWToken &	tok
	)

Definition at line 416 of file bowToken.cpp.

◆ operator<<() [16/20]

std::ostream & Lima::Common::BagOfWords::operator<<	(	std::ostream &	os,
		const IndexElement &	elt
	)

Definition at line 337 of file indexElement.cpp.

◆ operator<<() [17/20]

LIMA_LINEARTEXTREPRESENTATION_EXPORT std::ostream & Lima::Common::BagOfWords::operator<<	(	std::ostream &	os,
		const LTR_Text &	text
	)

Definition at line 136 of file ltrText.cpp.

◆ operator<<() [18/20]

LIMA_LINEARTEXTREPRESENTATION_EXPORT std::ostream & Lima::Common::BagOfWords::operator<<	(	std::ostream &	os,
		const LTR_Token &	tok
	)

Definition at line 99 of file ltrToken.cpp.

◆ operator<<() [19/20]

LIMA_BOW_EXPORT std::ostream & Lima::Common::BagOfWords::operator<<	(	std::ostream &	out,
		const BoWBlocType &	blocType
	)

Definition at line 33 of file bowDocument.cpp.

◆ operator<<() [20/20]

template<typename T >

T & Lima::Common::BagOfWords::operator<<	(	T &	qd,
		const BoWType &	bt
	)

Definition at line 54 of file AbstractBoWElement.h.

◆ operator>>()

LIMA_BOW_EXPORT std::istream & Lima::Common::BagOfWords::operator>>	(	std::istream &	in,
		BoWBlocType &	blocType
	)

Definition at line 47 of file bowDocument.cpp.

◆ toInt()

uint8_t Lima::Common::BagOfWords::toInt ( const BoWType & bt )

Definition at line 42 of file bowToken.cpp.

Classes

Enumerations

Functions