Software Project Documentation

Automatically generated with Code Structure Viewer (CS), Project Version: 3o4d 17-November-2020

Software Project Code Structure - Files

Software Project Code Structure - Functions

File LRPmain Documentation

File Name: LRPmain.cpp/.hpp

File Description: LRP main

File Function List

main

File Diagram (functions hierarchy)

Function main()

Function Summary

name	return type	description
main	int	main

Function Arguments

name	type	description
argc	const int	argc
argv	const char**	argv

Function Reference List

- SHAREDvarsClass::getCurrentDirectory
- SHAREDvarsClass::argumentExists
  - SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::argumentExists
  - SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
  - SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
  - SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
  - SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
  - SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
  - SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
  - SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
  - SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
  - SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::setCurrentDirectory
- LRPpreprocessorPOStaggerDatabaseClass::initialisePOStaggerDatabase
- LRPpreprocessorWordIdentificationClass::initialiseLRP
- LRPpreprocessorPOStaggerClass::generatePOStaggerDatabaseFromWikiDumpText
- LRPpreprocessorPOStaggerClass::generatePOStaggerDatabaseFromWikiDumpText

File SHAREDvars Documentation

File Name: SHAREDvars.cpp/.hpp

File Description: SHARED vars

File Function List

- argumentExists
- getFloatArgument
- getStringArgument
- getCurrentDirectory
  - setCurrentDirectory
- directoryExists
- convertStringToLowerCase
- convertDoubleToString
- convertIntToString
- convertIntToString
- convertLongToString
- textInTextArray
- textInTextArray
- charInCharArray
- getFileContents
- getLinesFromFile
- writeStringListToFile
- fileExists
- sprintfSafeDouble
- sprintfSafeInt
- sprintfSafeLong
- copyFiles
  - openFileAndCopyDataIntoCurrentFileObject
- getBitValue
- setBitValue

File Diagram (functions hierarchy)

Function SHAREDvarsClass::argumentExists()

Function Summary

name	return type	description
argumentExists	bool	argument exists

Function Arguments

name	type	description
argc	const int	argc
argv	const char**	argv
keystr	const string	keystr

Function Reference List

N/A

Function SHAREDvarsClass::getFloatArgument()

Function Summary

name	return type	description
getFloatArgument	float	get float argument

Function Arguments

name	type	description
argc	const int	argc
argv	const char**	argv
keystr	const string	keystr

Function Reference List

N/A

Function SHAREDvarsClass::getStringArgument()

Function Summary

name	return type	description
getStringArgument	string	get string argument

Function Arguments

name	type	description
argc	const int	argc
argv	const char**	argv
keystr	const string	keystr

Function Reference List

N/A

Function SHAREDvarsClass::getCurrentDirectory()

Function Summary

name	return type	description
getCurrentDirectory	string	get current directory

Function Reference List

N/A

Function SHAREDvarsClass::setCurrentDirectory()

Function Summary

name	return type	description
setCurrentDirectory	void	set current directory

Function Arguments

name	type	description
folder	const string*	folder

Function Reference List

N/A

Function SHAREDvarsClass::directoryExists()

Function Summary

name	return type	description
directoryExists	bool	directory exists

Function Arguments

name	type	description
folder	const string*	folder

Function Reference List

N/A

Function SHAREDvarsClass::convertStringToLowerCase()

Function Summary

name	return type	description
convertStringToLowerCase	string	convert string to lower case

Function Arguments

name	type	description
arbitraryCaseString	const string*	arbitrary case string

Function Reference List

N/A

Function SHAREDvarsClass::convertDoubleToString()

Function Summary

name	return type	description
convertDoubleToString	string	convert double to string

Function Arguments

name	type	description
number	const double	number
format	const string	format

Function Reference List

- sprintfSafeDouble

Function SHAREDvarsClass::convertIntToString()

Function Summary

name	return type	description
convertIntToString	string	convert int to string

Function Arguments

name	type	description
number	const int	number

Function Reference List

- sprintfSafeInt

Function SHAREDvarsClass::convertIntToString()

Function Summary

name	return type	description
convertIntToString	string	convert int to string

Function Arguments

name	type	description
number	const int	number
format	const string	format

Function Reference List

- sprintfSafeInt

Function SHAREDvarsClass::convertLongToString()

Function Summary

name	return type	description
convertLongToString	string	convert long to string

Function Arguments

name	type	description
number	const int64_t	number

Function Reference List

- sprintfSafeLong

Function SHAREDvarsClass::textInTextArray()

Function Summary

name	return type	description
textInTextArray	bool	text in text array

Function Arguments

name	type	description
text	const string	text
textArray	const string*	text array
arraySize	const int	array size

Function Reference List

- textInTextArray

Function SHAREDvarsClass::textInTextArray()

Function Summary

name	return type	description
textInTextArray	bool	text in text array

Function Arguments

name	type	description
text	const string	text
textArray	const string*	text array
arraySize	const int	array size
arrayIndexOfResultFound	int*	array index of result found

Function Reference List

N/A

Function SHAREDvarsClass::charInCharArray()

Function Summary

name	return type	description
charInCharArray	bool	char in char array

Function Arguments

name	type	description
c	const char	c
charArray	const char*	char array
arraySize	const int	array size

Function Reference List

N/A

Function SHAREDvarsClass::getFileContents()

Function Summary

name	return type	description
getFileContents	string	get file contents

Function Arguments

name	type	description
inputFileName	const string	input file name

Function Reference List

N/A

Function SHAREDvarsClass::getLinesFromFile()

Function Summary

name	return type	description
getLinesFromFile	bool	get lines from file

Function Arguments

name	type	description
fileContentsString	const string*	file contents string
fileLinesList	vector<string>*	file lines list
numberOfLinesInFile	int*	number of lines in file

Function Reference List

N/A

Function SHAREDvarsClass::writeStringListToFile()

Function Summary

name	return type	description
writeStringListToFile	void	write string list to file

Function Arguments

name	type	description
fileName	const string	file name
stringList	const vector<string>*	string list

Function Reference List

N/A

Function SHAREDvarsClass::fileExists()

Function Summary

name	return type	description
fileExists	bool	file exists

Function Arguments

name	type	description
inputFileName	const string	input file name

Function Reference List

N/A

Function SHAREDvarsClass::sprintfSafeDouble()

Function Summary

name	return type	description
sprintfSafeDouble	void	sprintf safe double

Function Arguments

name	type	description
stringCharStar	char*	string char star
type	const char*	type
number	double	number

Function Reference List

N/A

Function SHAREDvarsClass::sprintfSafeInt()

Function Summary

name	return type	description
sprintfSafeInt	void	sprintf safe int

Function Arguments

name	type	description
stringCharStar	char*	string char star
type	const char*	type
number	int	number

Function Reference List

N/A

Function SHAREDvarsClass::sprintfSafeLong()

Function Summary

name	return type	description
sprintfSafeLong	void	sprintf safe long

Function Arguments

name	type	description
stringCharStar	char*	string char star
type	const char*	type
number	int64_t	number

Function Reference List

N/A

Function SHAREDvarsClass::copyFiles()

Function Summary

name	return type	description
copyFiles	void	copy files

Function Arguments

name	type	description
fileToCopyName	const string	file to copy name
newFileName	const string	new file name

Function Reference List

- openFileAndCopyDataIntoCurrentFileObject

Function SHAREDvarsClass::openFileAndCopyDataIntoCurrentFileObject()

Function Summary

name	return type	description
openFileAndCopyDataIntoCurrentFileObject	bool	open file and copy data into current file object

Function Arguments

name	type	description
fileToOpenName	const string	file to open name
writeFileObject	ofstream*	write file object

Function Reference List

N/A

Function SHAREDvarsClass::getBitValue()

Function Summary

name	return type	description
getBitValue	bool	get bit value

Function Arguments

name	type	description
number	int64_t	number
x	int	x

Function Reference List

N/A

Function SHAREDvarsClass::setBitValue()

Function Summary

name	return type	description
setBitValue	int64_t	set bit value

Function Arguments

name	type	description
number	int64_t	number
x	int	x
val	bool	val

Function Reference List

N/A

File LRPpreprocessorWordClass Documentation

File Name: LRPpreprocessorWordClass.cpp/.hpp

File Description: LRP preprocessor word class

File Function List

- generateTextFromPreprocessorSentenceWordList
  - generateTextFromPreprocessorSentenceWordList
    - generateTextFromPreprocessorSentenceWord
- generateSentenceWordList
- generateSentenceWordList
- generateFlatSentenceWordList
- isIntrawordPunctuationMark
- findStringInWordList
  - findStringInWordList
- preprocessorFillCurrentWord
- getPOStypeFromName
- isStringNumber
- isMidSentenceUppercaseWordLikelyProperNoun
- wordIsUpperCase
- convertSentenceContentsIndexToEntityIndex

File Diagram (functions hierarchy)

Class LRPpreprocessorWord

Class Data

name	type	description
tagName	string	tag name
plainTextWord	bool	plain text word
nextTag	LRPpreprocessorWord*	next tag

Class LRPpreprocessorMultiwordReductionWord

Class Data

name	type	description
base	bool	base
grammaticalTenseFormsArray[LRP_PREPROCESSOR_WORD_VERB_DATABASE_TAG_BASE_MAX_NUM_TENSE_FORMS]	vector<string>	grammatical tense forms array [LRP_PREPROCESSOR_WORD_VERB_DATABASE_TAG_BASE_MAX_NUM_TENSE_FORMS]
grammaticalTenseForm	int	grammatical tense form
grammaticalTenseModifier	int	grammatical tense modifier
baseName	string	base name
alternateTagBasic	LRPpreprocessorMultiwordReductionWord*	alternate tag basic

Class LRPpreprocessorMultiwordReductionPhrasalVerbWord

Class Data

name	type	description
tagSpecialArbitraryName	bool	tag special arbitrary name
tagSpecialArbitraryNameType	int	tag special arbitrary name type
optional	bool	optional
alternateTag	LRPpreprocessorMultiwordReductionPhrasalVerbWord*	alternate tag

Class LRPpreprocessorMultiwordReductionIrregularVerbWord

Class Data

name	type	description
alternateTag	LRPpreprocessorMultiwordReductionIrregularVerbWord*	alternate tag

Class LRPpreprocessorPlainTextWord

Class Data

name	type	description
featureReferencePrelim	GIAfeature*	feature reference prelim
featureReferenceOriginal	GIAfeature*	feature reference original
featureReference	GIAfeature*	feature reference
entityReference	GIAentityNode*	entity reference
wordShortcutToConceptNeuron	ANNneuron*	word shortcut to concept neuron
neuralNetworkPreprocessorWordType	int	neural network preprocessor word type
tagNameOriginalNonLemma	string	tag name original non lemma
POStaggerExperiencePermutations	vector<ANNexperience*>	POS tagger experience permutations
POStaggerExperience	ANNexperience*	POS tagger experience
centreWordPOSambiguityInfo	uint32_t	centre word POS ambiguity info
alreadyFoundMatch	bool	already found match
unambiguousPOSindex	uchar	unambiguous POS index
POSambiguityInfo	uint64_t	POS ambiguity info
wordPOStypeInferred	int	word POS type inferred
translatorSentenceEntityIndex	int	translator sentence entity index
translatorSentenceWordIndex	int	translator sentence word index
translatorEntity	GIAentityNode*	translator entity
wordVerbVariantGrammaticalTenseForm	int	word verb variant grammatical tense form
wordNounVariantGrammaticalTenseForm	int	word noun variant grammatical tense form

Class LRPpreprocessorMultiwordReductionPlainTextWord

Class Data

name	type	description
tagNameLemma	string	tag name lemma
entityIndex	int	entity index
collapsedPhrasalVerbExactDefinedSection	bool	collapsed phrasal verb exact defined section
collapsedMultiwordWord	bool	collapsed multiword word
collapsedMultiwordWordType	int	collapsed multiword word type
collapsedMultiwordWordTemp	bool	collapsed multiword word temp
grammaticalTenseFormDetected	int	grammatical tense form detected
preprocessorUpperLevelWordReference	LRPpreprocessorMultiwordReductionPlainTextWord*	preprocessor upper level word reference
preprocessorUpperLevelWordReferenceSize	int	preprocessor upper level word reference size
preprocessorLowerLevelWordReference	LRPpreprocessorMultiwordReductionPlainTextWord*	preprocessor lower level word reference
characterIndexInSentenceContentsOriginalText	int	character index in sentence contents original text
tagNameLRPforNLP	string	tag name LRP for NLP

Class LRPpreprocessorMultiwordReductionBasicSentence

Class Data

name	type	description
firstTagInSentence	LRPpreprocessorMultiwordReductionWord*	first tag in sentence
nextSentence	LRPpreprocessorMultiwordReductionBasicSentence*	next sentence

Class LRPpreprocessorMultiwordReductionPhrasalVerbSentence

Class Data

name	type	description
firstTagInSentence	LRPpreprocessorMultiwordReductionPhrasalVerbWord*	first tag in sentence
alternateSentence	LRPpreprocessorMultiwordReductionPhrasalVerbSentence*	alternate sentence
nextSentence	LRPpreprocessorMultiwordReductionPhrasalVerbSentence*	next sentence

Class LRPpreprocessorMultiwordReductionIrregularVerbSentence

Class Data

name	type	description
firstTagInSentence	LRPpreprocessorMultiwordReductionIrregularVerbWord*	first tag in sentence
nextSentence	LRPpreprocessorMultiwordReductionIrregularVerbSentence*	next sentence

Class LRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo

Class Data

name	type	description
wordWithLRP	string	word with LRP
lemmaWithLRP	string	lemma with LRP
wordWithLRPforNLPonly	string	word with LRP for NLP only
entityIndex	int	entity index
sentenceIndex	int	sentence index
next	LRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo*	next

Function LRPpreprocessorWordClassClass::generateTextFromPreprocessorSentenceWordList()

Function Summary

name	return type	description
generateTextFromPreprocessorSentenceWordList	string	generate text from preprocessor sentence word list

Function Arguments

name	type	description
firstWordInSentence	constEffective LRPpreprocessorPlainTextWord*	first word in sentence

Function Reference List

- generateTextFromPreprocessorSentenceWordList

Function LRPpreprocessorWordClassClass::generateTextFromPreprocessorSentenceWordList()

Function Summary

name	return type	description
generateTextFromPreprocessorSentenceWordList	string	generate text from preprocessor sentence word list

Function Arguments

name	type	description
firstWordInSentence	constEffective LRPpreprocessorPlainTextWord*	first word in sentence
LRPforNLP	const bool	LRP for NLP

Function Reference List

- - generateTextFromPreprocessorSentenceWord

Function LRPpreprocessorWordClassClass::generateTextFromPreprocessorSentenceWord()

Function Summary

name	return type	description
generateTextFromPreprocessorSentenceWord	string	generate text from preprocessor sentence word

Function Arguments

name	type	description
word	constEffective LRPpreprocessorPlainTextWord*	word
LRPforNLP	const bool	LRP for NLP
isFirstWordInSentence	const bool	is first word in sentence

Function Reference List

N/A

Function LRPpreprocessorWordClassClass::generateSentenceWordList()

Function Summary

name	return type	description
generateSentenceWordList	bool	generate sentence word list

Function Arguments

name	type	description
sentenceContentsFirstWord	LRPpreprocessorPlainTextWord*	sentence contents first word
wordList	vector<LRPpreprocessorPlainTextWord>	word list

Function Reference List

- generateSentenceWordList

Function LRPpreprocessorWordClassClass::generateSentenceWordList()

Function Summary

name	return type	description
generateSentenceWordList	bool	generate sentence word list

Function Arguments

name	type	description
sentenceContentsFirstWord	LRPpreprocessorPlainTextWord*	sentence contents first word
wordList	vector<LRPpreprocessorPlainTextWord>	word list
startIndex	const int	start index
endIndex	const int	end index

Function Reference List

N/A

Function LRPpreprocessorWordClassClass::generateFlatSentenceWordList()

Function Summary

name	return type	description
generateFlatSentenceWordList	bool	generate flat sentence word list

Function Arguments

name	type	description
wordList	vector<LRPpreprocessorPlainTextWord>	word list
sentenceContentsFirstWord	LRPpreprocessorMultiwordReductionPlainTextWord**	sentence contents first word

Function Reference List

N/A

Function LRPpreprocessorWordClassClass::isIntrawordPunctuationMark()

Function Summary

name	return type	description
isIntrawordPunctuationMark	bool	is intraword punctuation mark

Function Arguments

name	type	description
indexOfCurrentToken	int	index of current token
lineContents	string*	line contents

Function Reference List

- - - SHAREDvarsClass::charInCharArray
      - SHAREDvarsClass::charInCharArray

Function LRPpreprocessorWordClassClass::findStringInWordList()

Function Summary

name	return type	description
findStringInWordList	int	find string in word list

Function Arguments

name	type	description
wordList	vector<LRPpreprocessorPlainTextWord>	word list
stringToFind	const string	string to find

Function Reference List

- findStringInWordList

Function LRPpreprocessorWordClassClass::findStringInWordList()

Function Summary

name	return type	description
findStringInWordList	int	find string in word list

Function Arguments

name	type	description
wordList	vector<LRPpreprocessorPlainTextWord>	word list
stringToFind	const string	string to find
startIndexToPerformFind	int	start index to perform find

Function Reference List

N/A

Function LRPpreprocessorWordClassClass::preprocessorFillCurrentWord()

Function Summary

name	return type	description
preprocessorFillCurrentWord	void	preprocessor fill current word

Function Arguments

name	type	description
currentWordInSentence	LRPpreprocessorMultiwordReductionPlainTextWord**	current word in sentence
currentWord	string*	current word
entityIndex	int*	entity index
lastCharacterIndexOfWordInSentence	const int	last character index of word in sentence

Function Reference List

N/A

Function LRPpreprocessorWordClassClass::getPOStypeFromName()

Function Summary

name	return type	description
getPOStypeFromName	int	get POS type from name

Function Arguments

name	type	description
wordPOStypeName	const string	word POS type name

Function Reference List

- SHAREDvarsClass::textInTextArray

Function LRPpreprocessorWordClassClass::isStringNumber()

Function Summary

name	return type	description
isStringNumber	bool	is string number

Function Arguments

name	type	description
phrase	const string	phrase

Function Reference List

- - - SHAREDvarsClass::charInCharArray

Function LRPpreprocessorWordClassClass::isMidSentenceUppercaseWordLikelyProperNoun()

Function Summary

name	return type	description
isMidSentenceUppercaseWordLikelyProperNoun	bool	is mid sentence uppercase word likely proper noun

Function Arguments

name	type	description
contextWord	constEffective LRPpreprocessorPlainTextWord*	context word

Function Reference List

- - wordIsUpperCase

Function LRPpreprocessorWordClassClass::wordIsUpperCase()

Function Summary

name	return type	description
wordIsUpperCase	bool	word is upper case

Function Arguments

name	type	description
wordText	string	word text

Function Reference List

N/A

Function LRPpreprocessorWordClassClass::convertSentenceContentsIndexToEntityIndex()

Function Summary

name	return type	description
convertSentenceContentsIndexToEntityIndex	int	convert sentence contents index to entity index

Function Arguments

name	type	description
sentenceContentsIndex	const int	sentence contents index

Function Reference List

N/A

File LRPpreprocessorWordIdentification Documentation

File Name: LRPpreprocessorWordIdentification.cpp/.hpp

File Description: LRP preprocessor word identification

File Function List

- getWordList
  - getWordListIfExistent
- transferWordList
- getWordListAllTypesWithPOSambiguityInfo
- insertInstanceInMapWordListAllTypesWithPOSambiguityInfo
- initialiseLRP
  - loadWordListWrapper
    - loadWordList
  - loadStructuredDataListIrregularVerb
- generateNounPluralVariantsList
  - generateNounPluralVariants
- generateVerbCaseStandardAndAdditionalList
  - generateAdditionalTenseVariantsOfVerbBase
    - addVerbCaseAdditional
- loadStructuredDataList
  - - - verbCaseDetectGrammaticallyStrictVariant
- findSentenceInSentenceListBasic
- createWordIndexListFromLRPfiles

File Diagram (functions hierarchy)

Function LRPpreprocessorWordIdentificationClass::getWordList()

Function Summary

name	return type	description
getWordList	unordered_map*	get word list

Function Arguments

name	type	description
GIAposType	const int	GIA pos type

Function Reference List

- getWordListIfExistent

Function LRPpreprocessorWordIdentificationClass::getWordListIfExistent()

Function Summary

name	return type	description
getWordListIfExistent	unordered_map*	get word list if existent

Function Arguments

name	type	description
GIAposType	const int	GIA pos type
result	bool*	result

Function Reference List

N/A

Function LRPpreprocessorWordIdentificationClass::transferWordList()

Function Summary

name	return type	description
transferWordList	bool	transfer word list

Function Arguments

name	type	description
GIAposType1	const int	GIA pos type 1
GIAposType2	const int	GIA pos type 2
wordList1record	unordered_map<string,LRPpreprocessorMultiwordReductionWord>*	word list 1record

Function Reference List

- getWordList
- getWordList

Function LRPpreprocessorWordIdentificationClass::getWordListAllTypesWithPOSambiguityInfo()

Function Summary

name	return type	description
getWordListAllTypesWithPOSambiguityInfo	unordered_map>*	get word list all types with POS ambiguity info

Function Reference List

N/A

Function LRPpreprocessorWordIdentificationClass::insertInstanceInMapWordListAllTypesWithPOSambiguityInfo()

Function Summary

name	return type	description
insertInstanceInMapWordListAllTypesWithPOSambiguityInfo	void	insert instance in map word list all types with POS ambiguity info

Function Arguments

name	type	description
mapWordListAllTypesWithPOSambiguityInfo	unordered_map<string,pair<LRPpreprocessorMultiwordReductionWord, uint64_t>>	map word list all types with POS ambiguity info
wordIndex	string	word index
word	constEffective LRPpreprocessorMultiwordReductionWord*	word
POSambiguityInfo	constEffective uint64_t	POS ambiguity info

Function Reference List

N/A

Function LRPpreprocessorWordIdentificationClass::initialiseLRP()

Function Summary

name	return type	description
initialiseLRP	bool	initialise LRP

Function Arguments

name	type	description
newLRPDataFolderName	const string	new LRPD ata folder name
newUseLRP	const bool	new use LRP

Function Reference List

- - SHAREDvarsClass::getCurrentDirectory
  - SHAREDvarsClass::setCurrentDirectory
  - loadStructuredDataList
  - SHAREDvarsClass::getLinesFromFile
    - - loadWordListWrapper
  - transferWordList
  - transferWordList
  - transferWordList
  - transferWordList
  - loadStructuredDataListIrregularVerb
  - loadStructuredDataList
  - generateVerbCaseStandardAndAdditionalList
  - generateNounPluralVariantsList
  - LRPpreprocessorWordReductionClass::initialiseLRPreduction
  - SHAREDvarsClass::setCurrentDirectory

Function LRPpreprocessorWordIdentificationClass::loadWordListWrapper()

Function Summary

name	return type	description
loadWordListWrapper	bool	load word list wrapper

Function Arguments

name	type	description
wordListLoaded	bool*	word list loaded
wordListFileName	const string	word list file name
wordList	unordered_map<string,LRPpreprocessorMultiwordReductionWord>	word list

Function Reference List

- loadWordList

Function LRPpreprocessorWordIdentificationClass::loadWordList()

Function Summary

name	return type	description
loadWordList	bool	load word list

Function Arguments

name	type	description
wordListFileName	const string	word list file name
wordList	unordered_map<string,LRPpreprocessorMultiwordReductionWord>	word list

Function Reference List

- - - - SHAREDvarsClass::convertStringToLowerCase

Function LRPpreprocessorWordIdentificationClass::loadStructuredDataListIrregularVerb()

Function Summary

name	return type	description
loadStructuredDataListIrregularVerb	bool	load structured data list irregular verb

Function Arguments

name	type	description
irregularVerbListFileName	const string	irregular verb list file name
irregularVerbList	unordered_map<string,LRPpreprocessorMultiwordReductionIrregularVerbSentence>	irregular verb list

Function Reference List

N/A

Function LRPpreprocessorWordIdentificationClass::generateNounPluralVariantsList()

Function Summary

name	return type	description
generateNounPluralVariantsList	bool	generate noun plural variants list

Function Arguments

name	type	description
irregularNounList	unordered_map<string,LRPpreprocessorMultiwordReductionBasicSentence>	irregular noun list

Function Reference List

- - getWordList
    - generateNounPluralVariants

Function LRPpreprocessorWordIdentificationClass::generateNounPluralVariants()

Function Summary

name	return type	description
generateNounPluralVariants	bool	generate noun plural variants

Function Arguments

name	type	description
wordTag	LRPpreprocessorMultiwordReductionWord*	word tag
nounPluralVariantsList	unordered_map<string,LRPpreprocessorMultiwordReductionWord>	noun plural variants list
irregularNounList	unordered_map<string,LRPpreprocessorMultiwordReductionBasicSentence>	irregular noun list

Function Reference List

- findSentenceInSentenceListBasic
  - - - SHAREDvarsClass::charInCharArray

Function LRPpreprocessorWordIdentificationClass::generateVerbCaseStandardAndAdditionalList()

Function Summary

name	return type	description
generateVerbCaseStandardAndAdditionalList	bool	generate verb case standard and additional list

Function Arguments

name	type	description
grammaticallyStrict	bool	grammatically strict

Function Reference List

- - getWordList
    - LRPpreprocessorWordReductionClass::generateIrregularTenseVariantsOfVerbBase
    - LRPpreprocessorWordReductionClass::generateStandardTenseVariantsOfVerbBase
    - generateAdditionalTenseVariantsOfVerbBase

Function LRPpreprocessorWordIdentificationClass::generateAdditionalTenseVariantsOfVerbBase()

Function Summary

name	return type	description
generateAdditionalTenseVariantsOfVerbBase	bool	generate additional tense variants of verb base

Function Arguments

name	type	description
verbCaseAdditionalList	unordered_map<string,LRPpreprocessorMultiwordReductionWord>	verb case additional list
baseTag	const LRPpreprocessorMultiwordReductionWord*	base tag
irregularVerbFound	const bool	irregular verb found
grammaticallyStrict	const bool	grammatically strict

Function Reference List

- SHAREDvarsClass::convertStringToLowerCase
  - addVerbCaseAdditional
    - - addVerbCaseAdditional
      - addVerbCaseAdditional
      - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional
    - addVerbCaseAdditional

Function LRPpreprocessorWordIdentificationClass::addVerbCaseAdditional()

Function Summary

name	return type	description
addVerbCaseAdditional	void	add verb case additional

Function Arguments

name	type	description
currentTagInVerbList	const LRPpreprocessorMultiwordReductionWord*	current tag in verb list
verbCaseAdditionalList	unordered_map<string,LRPpreprocessorMultiwordReductionWord>	verb case additional list
baseTenseFormStart	const string	base tense form start
baseTenseFormAppend	const string	base tense form append
grammaticalTenseFormNew	const int	grammatical tense form new

Function Reference List

N/A

Function LRPpreprocessorWordIdentificationClass::loadStructuredDataList()

Function Summary

name	return type	description
loadStructuredDataList	bool	load structured data list

Function Arguments

name	type	description
structuredDataListFileName	const string	structured data list file name
structuredDataList	unordered_map<string,LRPpreprocessorMultiwordReductionBasicSentence>	structured data list

Function Reference List

N/A

Function LRPpreprocessorWordIdentificationClass::verbCaseDetectGrammaticallyStrictVariant()

Function Summary

name	return type	description
verbCaseDetectGrammaticallyStrictVariant	bool	verb case detect grammatically strict variant

Function Arguments

name	type	description
grammaticalTenseForm	const int	grammatical tense form

Function Reference List

N/A

Function LRPpreprocessorWordIdentificationClass::findSentenceInSentenceListBasic()

Function Summary

name	return type	description
findSentenceInSentenceListBasic	bool	find sentence in sentence list basic

Function Arguments

name	type	description
sentenceList	unordered_map<string,LRPpreprocessorMultiwordReductionBasicSentence>	sentence list
word	const string	word
sentenceFound	LRPpreprocessorMultiwordReductionBasicSentence**	sentence found

Function Reference List

N/A

Function LRPpreprocessorWordIdentificationClass::createWordIndexListFromLRPfiles()

Function Summary

name	return type	description
createWordIndexListFromLRPfiles	bool	create word index list from LRP files

Function Reference List

- - - - getWordList
      - getWordList
        verbCaseDetectGrammaticallyStrictVariant
        
        verbCaseDetectGrammaticallyStrictVariant
        
        getWordListIfExistent
        
        SHAREDvarsClass::setBitValue
      - insertInstanceInMapWordListAllTypesWithPOSambiguityInfo
      - getWordListIfExistent

File LRPpreprocessorWordReduction Documentation

File Name: LRPpreprocessorWordReduction.cpp/.hpp

File Description: LRP preprocessor word reduction

File Function List

- initialiseLRPreduction
  - loadPhrasalVerbDataAndGenerateAllTenseVariants
- getActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo
- setActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo
- initialiseActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo
- deinitialiseActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo
- parseTextFileAndReduceLanguage
  - searchAndReplacePhrasalVerbs
  - loadMultiwordWordList
  - searchAndReplaceMultiwordWordList
  - searchAndReplaceMultiwordWordListDynamic
    - createNewCorrespondenceInfo
    - renumberEntityIndiciesInCorrespondenceInfo
  - writeTagListToFile
    - generateWordWithLRPforNLPonly
- generateIrregularTenseVariantsOfVerbBase
- generateStandardTenseVariantsOfVerbBase
- findSentenceInSentenceListIrregularVerb
- replaceAllNumericalWordsWithNumbers
  - convertWordToNumber
    - parseNumerals
      - getValueOf

File Diagram (functions hierarchy)

Function LRPpreprocessorWordReductionClass::initialiseLRPreduction()

Function Summary

name	return type	description
initialiseLRPreduction	bool	initialise LRP reduction

Function Arguments

name	type	description
irregularVerbList	unordered_map<string,LRPpreprocessorMultiwordReductionIrregularVerbSentence>	irregular verb list

Function Reference List

- loadPhrasalVerbDataAndGenerateAllTenseVariants
- SHAREDvarsClass::getLinesFromFile
  - - - loadMultiwordWordList

Function LRPpreprocessorWordReductionClass::loadPhrasalVerbDataAndGenerateAllTenseVariants()

Function Summary

name	return type	description
loadPhrasalVerbDataAndGenerateAllTenseVariants	bool	load phrasal verb data and generate all tense variants

Function Arguments

name	type	description
phrasalVerbDatabaseFileName	const string	phrasal verb database file name
phrasalVerbList	multimap<string, LRPpreprocessorMultiwordReductionPhrasalVerbSentence>	phrasal verb list
irregularVerbList	unordered_map<string,LRPpreprocessorMultiwordReductionIrregularVerbSentence>	irregular verb list

Function Reference List

- - - - SHAREDvarsClass::textInTextArray
        generateIrregularTenseVariantsOfVerbBase
        
        generateStandardTenseVariantsOfVerbBase
      - SHAREDvarsClass::textInTextArray
        generateIrregularTenseVariantsOfVerbBase
        
        generateStandardTenseVariantsOfVerbBase

Function LRPpreprocessorWordReductionClass::getActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo()

Function Summary

name	return type	description
getActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo	LRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo*	get active LRP preprocessor multiword reduction tag text correspondence info

Function Reference List

N/A

Function LRPpreprocessorWordReductionClass::setActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo()

Function Summary

name	return type	description
setActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo	void	set active LRP preprocessor multiword reduction tag text correspondence info

Function Arguments

name	type	description
isQuery	const bool	is query

Function Reference List

N/A

Function LRPpreprocessorWordReductionClass::initialiseActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo()

Function Summary

name	return type	description
initialiseActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo	void	initialise active LRP preprocessor multiword reduction tag text correspondence info

Function Arguments

name	type	description
isQuery	const bool	is query

Function Reference List

N/A

Function LRPpreprocessorWordReductionClass::deinitialiseActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo()

Function Summary

name	return type	description
deinitialiseActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo	void	deinitialise active LRP preprocessor multiword reduction tag text correspondence info

Function Arguments

name	type	description
isQuery	const bool	is query

Function Reference List

N/A

Function LRPpreprocessorWordReductionClass::parseTextFileAndReduceLanguage()

Function Summary

name	return type	description
parseTextFileAndReduceLanguage	bool	parse text file and reduce language

Function Arguments

name	type	description
firstLRPpreprocessorSentenceInList	LRPpreprocessorSentence*	first LRP preprocessor sentence in list
plainTextLRPoutputFileName	const string	plain text LRP output file name
plainTextLRPforNLPoutputFileName	const string	plain text LRP for NLP output file name

Function Reference List

- SHAREDvarsClass::getCurrentDirectory
- replaceAllNumericalWordsWithNumbers
- getActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo
- searchAndReplacePhrasalVerbs
  - LRPpreprocessorWordClassClass::getPOStypeFromName
  - searchAndReplaceMultiwordWordList
  - LRPpreprocessorWordClassClass::getPOStypeFromName
  - searchAndReplaceMultiwordWordListDynamic
- SHAREDvarsClass::setCurrentDirectory
- writeTagListToFile
- SHAREDvarsClass::setCurrentDirectory

Function LRPpreprocessorWordReductionClass::searchAndReplacePhrasalVerbs()

Function Summary

name	return type	description
searchAndReplacePhrasalVerbs	bool	search and replace phrasal verbs

Function Arguments

name	type	description
firstLRPpreprocessorSentenceInList	LRPpreprocessorSentence*	first LRP preprocessor sentence in list
phrasalVerbList	multimap<string, LRPpreprocessorMultiwordReductionPhrasalVerbSentence>	phrasal verb list
firstLRPpreprocessorMultiwordReductiontagCorrespondenceInfo	LRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo*	first LRP preprocessor multiword reductiontag correspondence info

Function Reference List

- - LRPpreprocessorWordClassClass::generateFlatSentenceWordList
    - - LRPpreprocessorWordClassClass::generateTextFromPreprocessorSentenceWordList
        
        generateWordWithLRPforNLPonly
  - LRPpreprocessorWordClassClass::generateSentenceWordList

Function LRPpreprocessorWordReductionClass::loadMultiwordWordList()

Function Summary

name	return type	description
loadMultiwordWordList	bool	load multiword word list

Function Arguments

name	type	description
multiwordWordListFileName	const string	multiword word list file name
multiwordWordList	multimap<string, LRPpreprocessorMultiwordReductionBasicSentence>	multiword word list

Function Reference List

N/A

Function LRPpreprocessorWordReductionClass::searchAndReplaceMultiwordWordList()

Function Summary

name	return type	description
searchAndReplaceMultiwordWordList	bool	search and replace multiword word list

Function Arguments

name	type	description
firstLRPpreprocessorSentenceInList	LRPpreprocessorSentence*	first LRP preprocessor sentence in list
multiwordWordList	multimap<string, LRPpreprocessorMultiwordReductionBasicSentence>	multiword word list
firstLRPpreprocessorMultiwordReductiontagCorrespondenceInfo	LRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo*	first LRP preprocessor multiword reductiontag correspondence info
wordListType	const int	word list type

Function Reference List

- - LRPpreprocessorWordClassClass::generateFlatSentenceWordList
    - - createNewCorrespondenceInfo
  - LRPpreprocessorWordClassClass::generateSentenceWordList

Function LRPpreprocessorWordReductionClass::searchAndReplaceMultiwordWordListDynamic()

Function Summary

name	return type	description
searchAndReplaceMultiwordWordListDynamic	bool	search and replace multiword word list dynamic

Function Arguments

name	type	description
firstLRPpreprocessorSentenceInList	LRPpreprocessorSentence*	first LRP preprocessor sentence in list
wordList	unordered_map<string,LRPpreprocessorMultiwordReductionWord>	word list
firstLRPpreprocessorMultiwordReductiontagCorrespondenceInfo	LRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo*	first LRP preprocessor multiword reductiontag correspondence info
wordListType	const int	word list type

Function Reference List

- - LRPpreprocessorWordClassClass::generateFlatSentenceWordList
    - - createNewCorrespondenceInfo
  - LRPpreprocessorWordClassClass::generateSentenceWordList

Function LRPpreprocessorWordReductionClass::createNewCorrespondenceInfo()

Function Summary

name	return type	description
createNewCorrespondenceInfo	void	create new correspondence info

Function Arguments

name	type	description
firstLRPpreprocessorMultiwordReductiontagCorrespondenceInfo	LRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo*	first LRP preprocessor multiword reductiontag correspondence info
currentCorrespondenceInfo	LRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo**	current correspondence info
currentLRPpreprocessorSentenceInList	const LRPpreprocessorSentence*	current LRP preprocessor sentence in list
firstTagInPlainTextSentence	LRPpreprocessorMultiwordReductionPlainTextWord*	first tag in plain text sentence
currentTagInPlainTextSentence	constEffective LRPpreprocessorMultiwordReductionPlainTextWord**	current tag in plain text sentence
entityIndex	const int	entity index
numberWordsInMultiwordMatched	int	number words in multiword matched

Function Reference List

- renumberEntityIndiciesInCorrespondenceInfo
  - - - LRPpreprocessorWordClassClass::generateTextFromPreprocessorSentenceWordList
    - generateWordWithLRPforNLPonly

Function LRPpreprocessorWordReductionClass::renumberEntityIndiciesInCorrespondenceInfo()

Function Summary

name	return type	description
renumberEntityIndiciesInCorrespondenceInfo	void	renumber entity indicies in correspondence info

Function Arguments

name	type	description
firstLRPpreprocessorMultiwordReductiontagCorrespondenceInfo	LRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo*	first LRP preprocessor multiword reductiontag correspondence info
sentenceIndex	const int	sentence index
entityIndex	const int	entity index
numberWordsInMultiwordMatched	int	number words in multiword matched

Function Reference List

N/A

Function LRPpreprocessorWordReductionClass::writeTagListToFile()

Function Summary

name	return type	description
writeTagListToFile	bool	write tag list to file

Function Arguments

name	type	description
firstLRPpreprocessorSentenceInList	LRPpreprocessorSentence*	first LRP preprocessor sentence in list
plainTextLRPoutputFileName	const string	plain text LRP output file name
plainTextLRPforNLPoutputFileName	const string	plain text LRP for NLP output file name
performLRPoutput	const bool	perform LRP output
performLRPforNLPoutput	const bool	perform LRP for NLP output

Function Reference List

- - LRPpreprocessorWordClassClass::generateFlatSentenceWordList
    - - generateWordWithLRPforNLPonly

Function LRPpreprocessorWordReductionClass::generateWordWithLRPforNLPonly()

Function Summary

name	return type	description
generateWordWithLRPforNLPonly	string	generate word with LRP for NLP only

Function Arguments

name	type	description
currentTagInPlainTextSentence	const LRPpreprocessorMultiwordReductionPlainTextWord*	current tag in plain text sentence

Function Reference List

N/A

Function LRPpreprocessorWordReductionClass::generateIrregularTenseVariantsOfVerbBase()

Function Summary

name	return type	description
generateIrregularTenseVariantsOfVerbBase	bool	generate irregular tense variants of verb base

Function Arguments

name	type	description
baseTag	LRPpreprocessorMultiwordReductionWord*	base tag
irregularVerbList	unordered_map<string,LRPpreprocessorMultiwordReductionIrregularVerbSentence>	irregular verb list
grammaticallyStrict	const bool	grammatically strict

Function Reference List

- SHAREDvarsClass::convertStringToLowerCase
- findSentenceInSentenceListIrregularVerb

Function LRPpreprocessorWordReductionClass::generateStandardTenseVariantsOfVerbBase()

Function Summary

name	return type	description
generateStandardTenseVariantsOfVerbBase	bool	generate standard tense variants of verb base

Function Arguments

name	type	description
baseTag	LRPpreprocessorMultiwordReductionWord*	base tag
irregularVerbFound	const bool	irregular verb found
grammaticallyStrict	const bool	grammatically strict

Function Reference List

- SHAREDvarsClass::convertStringToLowerCase
- SHAREDvarsClass::charInCharArray
- SHAREDvarsClass::charInCharArray
- SHAREDvarsClass::charInCharArray

Function LRPpreprocessorWordReductionClass::findSentenceInSentenceListIrregularVerb()

Function Summary

name	return type	description
findSentenceInSentenceListIrregularVerb	bool	find sentence in sentence list irregular verb

Function Arguments

name	type	description
sentenceList	unordered_map<string,LRPpreprocessorMultiwordReductionIrregularVerbSentence>	sentence list
word	const string	word
sentenceFound	LRPpreprocessorMultiwordReductionIrregularVerbSentence**	sentence found

Function Reference List

N/A

Function LRPpreprocessorWordReductionClass::replaceAllNumericalWordsWithNumbers()

Function Summary

name	return type	description
replaceAllNumericalWordsWithNumbers	bool	replace all numerical words with numbers

Function Arguments

name	type	description
firstLRPpreprocessorSentenceInList	LRPpreprocessorSentence*	first LRP preprocessor sentence in list

Function Reference List

- - LRPpreprocessorWordClassClass::generateFlatSentenceWordList
    - SHAREDvarsClass::convertStringToLowerCase
    - SHAREDvarsClass::textInTextArray
      - LRPpreprocessorWordClassClass::generateSentenceWordList
        SHAREDvarsClass::convertStringToLowerCase
        
        convertWordToNumber
        
        SHAREDvarsClass::convertLongToString
  - LRPpreprocessorWordClassClass::generateSentenceWordList

Function LRPpreprocessorWordReductionClass::convertWordToNumber()

Function Summary

name	return type	description
convertWordToNumber	int64_t	convert word to number

Function Arguments

name	type	description
numericalWordList	vector<LRPpreprocessorPlainTextWord>	numerical word list

Function Reference List

- - LRPpreprocessorWordClassClass::findStringInWordList
    - parseNumerals
    - convertWordToNumber
  - parseNumerals

Function LRPpreprocessorWordReductionClass::parseNumerals()

Function Summary

name	return type	description
parseNumerals	int64_t	parse numerals

Function Arguments

name	type	description
numericalWordListSubset	const vector<LRPpreprocessorPlainTextWord>	numerical word list subset

Function Reference List

- - SHAREDvarsClass::textInTextArray
  - getValueOf

Function LRPpreprocessorWordReductionClass::getValueOf()

Function Summary

name	return type	description
getValueOf	int64_t	get value of

Function Arguments

name	type	description
wordText	const string	word text

Function Reference List

- SHAREDvarsClass::textInTextArray

File LRPpreprocessorPOStagger Documentation

File Name: LRPpreprocessorPOStagger.cpp/.hpp

File Description: LRP preprocessor POS tagger

File Function List

- generatePOStaggerDatabaseFromWikiDumpText
- generatePOStaggerDatabaseFromWikiDumpText
  - addPOStaggerDatabaseEntry1
  - addPOStaggerDatabaseEntry2
  - addPOStaggerDatabaseEntry3
  - addPOStaggerDatabaseEntry4
  - generateWikiDumpTextInputFileName
  - generatePreprocessorSentenceObjectsFromText
    - createPreprocessSentencesBasic
  - generateANNexperienceFromPOSambiguityInfoPermutation
  - generatePOSambiguityInfoPermutation
- generatePOSambiguityInfoUnambiguousPermutationArray
  - determinePOSambiguityInfo
    - findWordInWordListAllTypesWithPOSambiguityInfo
- generateANNexperienceFromPOSambiguityInfoPermutationStandalone
- setSentenceContentsWordsUnambiguousPOSindex

File Diagram (functions hierarchy)

Function LRPpreprocessorPOStaggerClass::generatePOStaggerDatabaseFromWikiDumpText()

Function Summary

name	return type	description
generatePOStaggerDatabaseFromWikiDumpText	bool	generate POS tagger database from wiki dump text

Function Arguments

name	type	description
wikiDumpFolderName	string	wiki dump folder name
useLRP	const bool	use LRP

Function Reference List

- SHAREDvarsClass::getCurrentDirectory
  - generatePOStaggerDatabaseFromWikiDumpText
- LRPpreprocessorPOStaggerDatabaseClass::writeDatabaseNeuralNetwork
- LRPpreprocessorPOStaggerDatabaseClass::externalANNtrainEpoch
- LRPpreprocessorPOStaggerDatabaseClass::externalANNtrain
- SHAREDvarsClass::setCurrentDirectory

Function LRPpreprocessorPOStaggerClass::generatePOStaggerDatabaseFromWikiDumpText()

Function Summary

name	return type	description
generatePOStaggerDatabaseFromWikiDumpText	bool	generate POS tagger database from wiki dump text

Function Arguments

name	type	description
wikiDumpFolderName	string	wiki dump folder name
wikiDumpFileBatchIndex	int	wiki dump file batch index
useLRP	const bool	use LRP

Function Reference List

- LRPpreprocessorWordIdentificationClass::createWordIndexListFromLRPfiles
- generateWikiDumpTextInputFileName
- SHAREDvarsClass::setCurrentDirectory
- generatePreprocessorSentenceObjectsFromText
- LRPpreprocessorPOStaggerDatabaseClass::externalANNgenerateBatchFileName
- LRPpreprocessorPOStaggerDatabaseClass::externalANNgenerateBatchFileName
  - - - SHAREDvarsClass::convertStringToLowerCase
      - findWordInWordListAllTypesWithPOSambiguityInfo
      - generatePOSambiguityInfoPermutation
        
        LRPpreprocessorPOStaggerDatabaseClass::determinePOSambiguityInfoIsAmbiguous
        
        setSentenceContentsWordsUnambiguousPOSindex
        
        generatePOSambiguityInfoUnambiguousPermutationArray
        setSentenceContentsWordsUnambiguousPOSindex
        
        addPOStaggerDatabaseEntry1
        
        addPOStaggerDatabaseEntry2
        
        addPOStaggerDatabaseEntry3
        
        addPOStaggerDatabaseEntry4
- LRPpreprocessorPOStaggerDatabaseClass::writeDatabaseNeuralNetwork
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::copyFiles
- LRPpreprocessorPOStaggerDatabaseClass::externalANNgenerateBatchTrainDataExecuteFeed
- LRPpreprocessorPOStaggerDatabaseClass::externalANNgenerateBatchTrainData

Function LRPpreprocessorPOStaggerClass::addPOStaggerDatabaseEntry1()

Function Summary

name	return type	description
addPOStaggerDatabaseEntry1	bool	add POS tagger database entry 1

Function Arguments

name	type	description
POSambiguityInfoPermutation	const vector<uint64_t>*	POS ambiguity info permutation
XtrainBatchFileObject	ofstream*	Xtrain batch file object

Function Reference List

- generateANNexperienceFromPOSambiguityInfoPermutation
- LRPpreprocessorPOStaggerDatabaseClass::externalANNgenerateBatchDataExperienceInput

Function LRPpreprocessorPOStaggerClass::addPOStaggerDatabaseEntry2()

Function Summary

name	return type	description
addPOStaggerDatabaseEntry2	bool	add POS tagger database entry 2

Function Arguments

name	type	description
centreWordPOSambiguityInfo	uint64_t	centre word POS ambiguity info
POSambiguityInfoPermutation	vector<uint64_t>*	POS ambiguity info permutation
centreWordUnambiguousPOSindex	uchar	centre word unambiguous POS index
XtrainBatchFileObject	ofstream*	Xtrain batch file object
YtrainBatchFileObject	ofstream*	Ytrain batch file object

Function Reference List

N/A

Function LRPpreprocessorPOStaggerClass::addPOStaggerDatabaseEntry3()

Function Summary

name	return type	description
addPOStaggerDatabaseEntry3	bool	add POS tagger database entry 3

Function Arguments

name	type	description
centreWordPOSambiguityInfo	uint64_t	centre word POS ambiguity info
POSambiguityInfoPermutation	vector<uint64_t>*	POS ambiguity info permutation
centreWordUnambiguousPOSindex	uchar	centre word unambiguous POS index
currentExperienceInList	ANNexperience**	current experience in list

Function Reference List

N/A

Function LRPpreprocessorPOStaggerClass::addPOStaggerDatabaseEntry4()

Function Summary

name	return type	description
addPOStaggerDatabaseEntry4	bool	add POS tagger database entry 4

Function Arguments

name	type	description
centreWordPOSambiguityInfo	uint64_t	centre word POS ambiguity info
POSambiguityInfoPermutation	vector<uint64_t>*	POS ambiguity info permutation
centreWordUnambiguousPOSindex	uchar	centre word unambiguous POS index
numberOfNeuralNetworkFeeds	int64_t*	number of neural network feeds

Function Reference List

N/A

Function LRPpreprocessorPOStaggerClass::generateWikiDumpTextInputFileName()

Function Summary

name	return type	description
generateWikiDumpTextInputFileName	string	generate wiki dump text input file name

Function Arguments

name	type	description
wikiDumpFileBatchIndex	const int	wiki dump file batch index

Function Reference List

- LRPpreprocessorPOStaggerDatabaseClass::generateIntFormatString
- SHAREDvarsClass::convertIntToString

Function LRPpreprocessorPOStaggerClass::generatePreprocessorSentenceObjectsFromText()

Function Summary

name	return type	description
generatePreprocessorSentenceObjectsFromText	bool	generate preprocessor sentence objects from text

Function Arguments

name	type	description
inputFileName	const string	input file name
firstLRPpreprocessorSentenceInText	LRPpreprocessorSentence*	first LRP preprocessor sentence in text
useLRP	const bool	use LRP

Function Reference List

- SHAREDvarsClass::getFileContents
- createPreprocessSentencesBasic
  - LRPpreprocessorWordReductionClass::initialiseActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo
  - LRPpreprocessorWordReductionClass::setActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo
  - LRPpreprocessorWordReductionClass::parseTextFileAndReduceLanguage
  - LRPpreprocessorWordReductionClass::deinitialiseActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo
    - LRPpreprocessorWordClassClass::convertSentenceContentsIndexToEntityIndex

Function LRPpreprocessorPOStaggerClass::createPreprocessSentencesBasic()

Function Summary

name	return type	description
createPreprocessSentencesBasic	bool	create preprocess sentences basic

Function Arguments

name	type	description
fileContents	string	file contents
firstLRPpreprocessorSentenceInList	LRPpreprocessorSentence*	first LRP preprocessor sentence in list
interpretNewLinesAsNewSentences	const bool	interpret new lines as new sentences

Function Reference List

- - SHAREDvarsClass::charInCharArray
    - LRPpreprocessorWordClassClass::isIntrawordPunctuationMark
  - SHAREDvarsClass::charInCharArray
  - SHAREDvarsClass::charInCharArray
    - - LRPpreprocessorWordClassClass::preprocessorFillCurrentWord
      - LRPpreprocessorWordClassClass::preprocessorFillCurrentWord
      - SHAREDvarsClass::charInCharArray
        LRPpreprocessorWordClassClass::isIntrawordPunctuationMark
        
        LRPpreprocessorWordClassClass::generateSentenceWordList
        
        LRPpreprocessorWordClassClass::generateSentenceWordList

Function LRPpreprocessorPOStaggerClass::generateANNexperienceFromPOSambiguityInfoPermutation()

Function Summary

name	return type	description
generateANNexperienceFromPOSambiguityInfoPermutation	bool	generate ANN experience from POS ambiguity info permutation

Function Arguments

name	type	description
POSambiguityInfoPermutation	const vector<uint64_t>*	POS ambiguity info permutation
centreWordUnambiguousPOSindex	uchar	centre word unambiguous POS index
currentExperience	ANNexperience*	current experience

Function Reference List

- generateANNexperienceFromPOSambiguityInfoPermutationStandalone

Function LRPpreprocessorPOStaggerClass::generatePOSambiguityInfoPermutation()

Function Summary

name	return type	description
generatePOSambiguityInfoPermutation	bool	generate POS ambiguity info permutation

Function Arguments

name	type	description
sentenceContents	vector<LRPpreprocessorPlainTextWord>	sentence contents
wCentre	const int	wCentre
identifiedEveryWordInDatabasePOSpermutation	bool*	identified every word in database POS permutation
identifiedEveryWordInDatabasePOSpermutationIsUnambiguous	bool*	identified every word in database POS permutation is unambiguous
POSambiguityInfoPermutation	vector<uint64_t>*	POS ambiguity info permutation

Function Reference List

- - - - SHAREDvarsClass::setBitValue
      - determinePOSambiguityInfo

Function LRPpreprocessorPOStaggerClass::generatePOSambiguityInfoUnambiguousPermutationArray()

Function Summary

name	return type	description
generatePOSambiguityInfoUnambiguousPermutationArray	void	generate POS ambiguity info unambiguous permutation array

Function Arguments

name	type	description
POSambiguityInfoUnambiguousPermutationArray	vector<vector<uint64_t>>	POS ambiguity info unambiguous permutation array
POSambiguityInfoPermutation	vector<uint64_t>*	POS ambiguity info permutation
POSambiguityInfoUnambiguousPermutationLocal	vector<uint64_t>*	POS ambiguity info unambiguous permutation local
wordIndex	int	word index

Function Reference List

- - - - SHAREDvarsClass::getBitValue
        SHAREDvarsClass::setBitValue
        
        generatePOSambiguityInfoUnambiguousPermutationArray
    - generatePOSambiguityInfoUnambiguousPermutationArray

Function LRPpreprocessorPOStaggerClass::determinePOSambiguityInfo()

Function Summary

name	return type	description
determinePOSambiguityInfo	bool	determine POS ambiguity info

Function Arguments

name	type	description
contextWord	constEffective LRPpreprocessorPlainTextWord*	context word
contextWordPOSambiguityInfo	uint64_t*	context word POS ambiguity info
contextWordPOSisAmbiguous	bool*	context word POS is ambiguous
contextWordUnambiguousPOSindex	uchar*	context word unambiguous POS index
identifiedEveryWordInDatabasePOSpermutation	bool*	identified every word in database POS permutation

Function Reference List

- findWordInWordListAllTypesWithPOSambiguityInfo
- LRPpreprocessorWordClassClass::isMidSentenceUppercaseWordLikelyProperNoun
  - SHAREDvarsClass::setBitValue
    - LRPpreprocessorWordClassClass::wordIsUpperCase
      - SHAREDvarsClass::convertStringToLowerCase
      - findWordInWordListAllTypesWithPOSambiguityInfo
      - SHAREDvarsClass::convertStringToLowerCase
      - findWordInWordListAllTypesWithPOSambiguityInfo
- SHAREDvarsClass::convertStringToLowerCase
- findWordInWordListAllTypesWithPOSambiguityInfo
- LRPpreprocessorWordClassClass::isMidSentenceUppercaseWordLikelyProperNoun
  - SHAREDvarsClass::setBitValue
  - SHAREDvarsClass::setBitValue
  - LRPpreprocessorWordClassClass::isStringNumber
    - SHAREDvarsClass::setBitValue
  - LRPpreprocessorPOStaggerDatabaseClass::determinePOSambiguityInfoIsAmbiguous

Function LRPpreprocessorPOStaggerClass::findWordInWordListAllTypesWithPOSambiguityInfo()

Function Summary

name	return type	description
findWordInWordListAllTypesWithPOSambiguityInfo	bool	find word in word list all types with POS ambiguity info

Function Arguments

name	type	description
word	const string	word
wordFound	LRPpreprocessorMultiwordReductionWord**	word found
POSambiguityInfoFound	uint64_t*	POS ambiguity info found

Function Reference List

- LRPpreprocessorWordIdentificationClass::getWordListAllTypesWithPOSambiguityInfo

Function LRPpreprocessorPOStaggerClass::generateANNexperienceFromPOSambiguityInfoPermutationStandalone()

Function Summary

name	return type	description
generateANNexperienceFromPOSambiguityInfoPermutationStandalone	bool	generate ANN experience from POS ambiguity info permutation standalone

Function Arguments

name	type	description
POSambiguityInfoPermutation	const vector<uint64_t>*	POS ambiguity info permutation
outputNeuronExperienceValue	uchar	output neuron experience value
currentExperience	ANNexperience*	current experience

Function Reference List

- - - SHAREDvarsClass::getBitValue

Function LRPpreprocessorPOStaggerClass::setSentenceContentsWordsUnambiguousPOSindex()

Function Summary

name	return type	description
setSentenceContentsWordsUnambiguousPOSindex	bool	set sentence contents words unambiguous POS index

Function Arguments

name	type	description
sentenceContents	vector<LRPpreprocessorPlainTextWord>	sentence contents
POSambiguityInfoPermutationTemp	const vector<uint64_t>*	POS ambiguity info permutation temp

Function Reference List

- - LRPpreprocessorPOStaggerDatabaseClass::determinePOSambiguityInfoIsAmbiguous

File LRPpreprocessorPOStaggerDatabase Documentation

File Name: LRPpreprocessorPOStaggerDatabase.cpp/.hpp

File Description: LRP preprocessor POS tagger database

File Function List

- initialisePOStaggerDatabase
- writeDatabaseNeuralNetwork
- externalANNgenerateBatchTrainData
  - externalANNgenerateBatchFileName
  - externalANNgenerateBatchTrainDataExecuteFeed
- externalANNtrain
- externalANNtrainEpoch
- externalANNtrainEpochBatch
  - externalANNgenerateBatchDataExperiences
    - externalANNgenerateBatchDataExperienceInput
  - externalANNexecuteScript
- generateIntFormatString
  - determinePOSambiguityInfoIsAmbiguous
- externalANNgenerateExperienceInputStandalone

File Diagram (functions hierarchy)

Function LRPpreprocessorPOStaggerDatabaseClass::initialisePOStaggerDatabase()

Function Summary

name	return type	description
initialisePOStaggerDatabase	void	initialise POS tagger database

Function Arguments

name	type	description
newLRPposTaggerDatabaseFolderName	const string	new LRP pos tagger database folder name

Function Reference List

- SHAREDvarsClass::directoryExists
- SHAREDvarsClass::setCurrentDirectory
- SHAREDvarsClass::fileExists

Function LRPpreprocessorPOStaggerDatabaseClass::writeDatabaseNeuralNetwork()

Function Summary

name	return type	description
writeDatabaseNeuralNetwork	bool	write database neural network

Function Reference List

- SHAREDvarsClass::setCurrentDirectory

Function LRPpreprocessorPOStaggerDatabaseClass::externalANNgenerateBatchTrainData()

Function Summary

name	return type	description
externalANNgenerateBatchTrainData	bool	external ANN generate batch train data

Function Arguments

name	type	description
firstExperienceInList	const ANNexperience*	first experience in list
batchIndex	const int	batch index

Function Reference List

- externalANNgenerateBatchFileName
- externalANNgenerateBatchFileName
- externalANNgenerateBatchDataExperiences
- SHAREDvarsClass::writeStringListToFile
- SHAREDvarsClass::writeStringListToFile
- externalANNgenerateBatchTrainDataExecuteFeed

Function LRPpreprocessorPOStaggerDatabaseClass::externalANNgenerateBatchFileName()

Function Summary

name	return type	description
externalANNgenerateBatchFileName	string	external ANN generate batch file name

Function Arguments

name	type	description
fileNamePrepend	const string	file name prepend
batchIndex	const int	batch index

Function Reference List

- SHAREDvarsClass::setCurrentDirectory
- generateIntFormatString
- SHAREDvarsClass::convertIntToString

Function LRPpreprocessorPOStaggerDatabaseClass::externalANNgenerateBatchTrainDataExecuteFeed()

Function Summary

name	return type	description
externalANNgenerateBatchTrainDataExecuteFeed	bool	external ANN generate batch train data execute feed

Function Reference List

- externalANNtrainEpochBatch

Function LRPpreprocessorPOStaggerDatabaseClass::externalANNtrain()

Function Summary

name	return type	description
externalANNtrain	bool	external ANN train

Function Reference List

- externalANNexecuteScript

Function LRPpreprocessorPOStaggerDatabaseClass::externalANNtrainEpoch()

Function Summary

name	return type	description
externalANNtrainEpoch	bool	external ANN train epoch

Function Reference List

- externalANNexecuteScript

Function LRPpreprocessorPOStaggerDatabaseClass::externalANNtrainEpochBatch()

Function Summary

name	return type	description
externalANNtrainEpochBatch	bool	external ANN train epoch batch

Function Reference List

- externalANNexecuteScript

Function LRPpreprocessorPOStaggerDatabaseClass::externalANNgenerateBatchDataExperiences()

Function Summary

name	return type	description
externalANNgenerateBatchDataExperiences	bool	external ANN generate batch data experiences

Function Arguments

name	type	description
firstExperienceInList	const ANNexperience*	first experience in list
batchDataInput	vector<string>*	batch data input
batchDataOutput	vector<string>*	batch data output

Function Reference List

- - externalANNgenerateBatchDataExperienceInput
  - externalANNgenerateBatchDataExperienceInput

Function LRPpreprocessorPOStaggerDatabaseClass::externalANNgenerateBatchDataExperienceInput()

Function Summary

name	return type	description
externalANNgenerateBatchDataExperienceInput	string	external ANN generate batch data experience input

Function Arguments

name	type	description
currentExperienceInList	const ANNexperience*	current experience in list

Function Reference List

- externalANNgenerateExperienceInputStandalone

Function LRPpreprocessorPOStaggerDatabaseClass::externalANNexecuteScript()

Function Summary

name	return type	description
externalANNexecuteScript	bool	external ANN execute script

Function Arguments

name	type	description
scriptName	string	script name

Function Reference List

- SHAREDvarsClass::setCurrentDirectory

Function LRPpreprocessorPOStaggerDatabaseClass::generateIntFormatString()

Function Summary

name	return type	description
generateIntFormatString	string	generate int format string

Function Arguments

name	type	description
numberOfCharacters	const int	number of characters

Function Reference List

- SHAREDvarsClass::convertIntToString

Function LRPpreprocessorPOStaggerDatabaseClass::determinePOSambiguityInfoIsAmbiguous()

Function Summary

name	return type	description
determinePOSambiguityInfoIsAmbiguous	bool	determine POS ambiguity info is ambiguous

Function Arguments

name	type	description
POSambiguityInfo	const uint64_t	POS ambiguity info
unambiguousPOSinfoIndex	uchar*	unambiguous POS info index
treatWordAsAmbiguousIfNullPOSvalue	const bool	treat word as ambiguous if null POS value

Function Reference List

- - SHAREDvarsClass::getBitValue

Function LRPpreprocessorPOStaggerDatabaseClass::externalANNgenerateExperienceInputStandalone()

Function Summary

name	return type	description
externalANNgenerateExperienceInputStandalone	string	external ANN generate experience input standalone

Function Arguments

name	type	description
currentExperienceInList	const ANNexperience*	current experience in list

Function Reference List

- - SHAREDvarsClass::convertDoubleToString