Software Project Documentation

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

Copyright © 2020, BAI Research. All Rights Reserved.


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


File Diagram (functions hierarchy)


Function main()

Function Summary
namereturn typedescription
mainintmain

Function Arguments
nametypedescription
argcconst int argc
argv const char** argv

Function Reference List


File SHAREDvars Documentation

File Name: SHAREDvars.cpp/.hpp

File Description: SHARED vars

File Function List


File Diagram (functions hierarchy)


Function SHAREDvarsClass::argumentExists()

Function Summary
namereturn typedescription
argumentExistsboolargument exists

Function Arguments
nametypedescription
argcconst int argc
argv const char** argv
keystr const string keystr

Function Reference List
N/A


Function SHAREDvarsClass::getFloatArgument()

Function Summary
namereturn typedescription
getFloatArgumentfloatget float argument

Function Arguments
nametypedescription
argcconst int argc
argv const char** argv
keystr const string keystr

Function Reference List
N/A


Function SHAREDvarsClass::getStringArgument()

Function Summary
namereturn typedescription
getStringArgumentstringget string argument

Function Arguments
nametypedescription
argcconst int argc
argv const char** argv
keystr const string keystr

Function Reference List
N/A


Function SHAREDvarsClass::getCurrentDirectory()

Function Summary
namereturn typedescription
getCurrentDirectorystringget current directory

Function Reference List
N/A


Function SHAREDvarsClass::setCurrentDirectory()

Function Summary
namereturn typedescription
setCurrentDirectoryvoidset current directory

Function Arguments
nametypedescription
folderconst string* folder

Function Reference List
N/A


Function SHAREDvarsClass::directoryExists()

Function Summary
namereturn typedescription
directoryExistsbooldirectory exists

Function Arguments
nametypedescription
folderconst string* folder

Function Reference List
N/A


Function SHAREDvarsClass::convertStringToLowerCase()

Function Summary
namereturn typedescription
convertStringToLowerCasestringconvert string to lower case

Function Arguments
nametypedescription
arbitraryCaseStringconst string* arbitrary case string

Function Reference List
N/A


Function SHAREDvarsClass::convertDoubleToString()

Function Summary
namereturn typedescription
convertDoubleToStringstringconvert double to string

Function Arguments
nametypedescription
numberconst double number
format const string format

Function Reference List


Function SHAREDvarsClass::convertIntToString()

Function Summary
namereturn typedescription
convertIntToStringstringconvert int to string

Function Arguments
nametypedescription
numberconst int number

Function Reference List


Function SHAREDvarsClass::convertIntToString()

Function Summary
namereturn typedescription
convertIntToStringstringconvert int to string

Function Arguments
nametypedescription
numberconst int number
format const string format

Function Reference List


Function SHAREDvarsClass::convertLongToString()

Function Summary
namereturn typedescription
convertLongToStringstringconvert long to string

Function Arguments
nametypedescription
numberconst int64_t number

Function Reference List


Function SHAREDvarsClass::textInTextArray()

Function Summary
namereturn typedescription
textInTextArraybooltext in text array

Function Arguments
nametypedescription
textconst string text
textArray const string* text array
arraySize const int array size

Function Reference List


Function SHAREDvarsClass::textInTextArray()

Function Summary
namereturn typedescription
textInTextArraybooltext in text array

Function Arguments
nametypedescription
textconst 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
namereturn typedescription
charInCharArrayboolchar in char array

Function Arguments
nametypedescription
cconst char c
charArray const char* char array
arraySize const int array size

Function Reference List
N/A


Function SHAREDvarsClass::getFileContents()

Function Summary
namereturn typedescription
getFileContentsstringget file contents

Function Arguments
nametypedescription
inputFileNameconst string input file name

Function Reference List
N/A


Function SHAREDvarsClass::getLinesFromFile()

Function Summary
namereturn typedescription
getLinesFromFileboolget lines from file

Function Arguments
nametypedescription
fileContentsStringconst 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
namereturn typedescription
writeStringListToFilevoidwrite string list to file

Function Arguments
nametypedescription
fileNameconst string file name
stringList const vector<string>* string list

Function Reference List
N/A


Function SHAREDvarsClass::fileExists()

Function Summary
namereturn typedescription
fileExistsboolfile exists

Function Arguments
nametypedescription
inputFileNameconst string input file name

Function Reference List
N/A


Function SHAREDvarsClass::sprintfSafeDouble()

Function Summary
namereturn typedescription
sprintfSafeDoublevoidsprintf safe double

Function Arguments
nametypedescription
stringCharStarchar* string char star
type const char* type
number double number

Function Reference List
N/A


Function SHAREDvarsClass::sprintfSafeInt()

Function Summary
namereturn typedescription
sprintfSafeIntvoidsprintf safe int

Function Arguments
nametypedescription
stringCharStarchar* string char star
type const char* type
number int number

Function Reference List
N/A


Function SHAREDvarsClass::sprintfSafeLong()

Function Summary
namereturn typedescription
sprintfSafeLongvoidsprintf safe long

Function Arguments
nametypedescription
stringCharStarchar* string char star
type const char* type
number int64_t number

Function Reference List
N/A


Function SHAREDvarsClass::copyFiles()

Function Summary
namereturn typedescription
copyFilesvoidcopy files

Function Arguments
nametypedescription
fileToCopyNameconst string file to copy name
newFileName const string new file name

Function Reference List


Function SHAREDvarsClass::openFileAndCopyDataIntoCurrentFileObject()

Function Summary
namereturn typedescription
openFileAndCopyDataIntoCurrentFileObjectboolopen file and copy data into current file object

Function Arguments
nametypedescription
fileToOpenNameconst string file to open name
writeFileObject ofstream* write file object

Function Reference List
N/A


Function SHAREDvarsClass::getBitValue()

Function Summary
namereturn typedescription
getBitValueboolget bit value

Function Arguments
nametypedescription
numberint64_t number
x int x

Function Reference List
N/A


Function SHAREDvarsClass::setBitValue()

Function Summary
namereturn typedescription
setBitValueint64_tset bit value

Function Arguments
nametypedescription
numberint64_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


File Diagram (functions hierarchy)


Class LRPpreprocessorWord

Class Data
nametypedescription
tagNamestringtag name
plainTextWordboolplain text word
nextTagLRPpreprocessorWord*next tag

Class LRPpreprocessorMultiwordReductionWord

Class Data
nametypedescription
baseboolbase
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]
grammaticalTenseFormintgrammatical tense form
grammaticalTenseModifierintgrammatical tense modifier
baseNamestringbase name
alternateTagBasicLRPpreprocessorMultiwordReductionWord*alternate tag basic

Class LRPpreprocessorMultiwordReductionPhrasalVerbWord

Class Data
nametypedescription
tagSpecialArbitraryNamebooltag special arbitrary name
tagSpecialArbitraryNameTypeinttag special arbitrary name type
optionalbooloptional
alternateTagLRPpreprocessorMultiwordReductionPhrasalVerbWord*alternate tag

Class LRPpreprocessorMultiwordReductionIrregularVerbWord

Class Data
nametypedescription
alternateTagLRPpreprocessorMultiwordReductionIrregularVerbWord*alternate tag

Class LRPpreprocessorPlainTextWord

Class Data
nametypedescription
featureReferencePrelimGIAfeature*feature reference prelim
featureReferenceOriginalGIAfeature*feature reference original
featureReferenceGIAfeature*feature reference
entityReferenceGIAentityNode*entity reference
wordShortcutToConceptNeuronANNneuron*word shortcut to concept neuron
neuralNetworkPreprocessorWordTypeintneural network preprocessor word type
tagNameOriginalNonLemmastringtag name original non lemma
POStaggerExperiencePermutationsvector<ANNexperience*>POS tagger experience permutations
POStaggerExperienceANNexperience*POS tagger experience
centreWordPOSambiguityInfouint32_tcentre word POS ambiguity info
alreadyFoundMatchboolalready found match
unambiguousPOSindexucharunambiguous POS index
POSambiguityInfouint64_tPOS ambiguity info
wordPOStypeInferredintword POS type inferred
translatorSentenceEntityIndexinttranslator sentence entity index
translatorSentenceWordIndexinttranslator sentence word index
translatorEntityGIAentityNode*translator entity
wordVerbVariantGrammaticalTenseFormintword verb variant grammatical tense form
wordNounVariantGrammaticalTenseFormintword noun variant grammatical tense form

Class LRPpreprocessorMultiwordReductionPlainTextWord

Class Data
nametypedescription
tagNameLemmastringtag name lemma
entityIndexintentity index
collapsedPhrasalVerbExactDefinedSectionboolcollapsed phrasal verb exact defined section
collapsedMultiwordWordboolcollapsed multiword word
collapsedMultiwordWordTypeintcollapsed multiword word type
collapsedMultiwordWordTempboolcollapsed multiword word temp
grammaticalTenseFormDetectedintgrammatical tense form detected
preprocessorUpperLevelWordReferenceLRPpreprocessorMultiwordReductionPlainTextWord*preprocessor upper level word reference
preprocessorUpperLevelWordReferenceSizeintpreprocessor upper level word reference size
preprocessorLowerLevelWordReferenceLRPpreprocessorMultiwordReductionPlainTextWord*preprocessor lower level word reference
characterIndexInSentenceContentsOriginalTextintcharacter index in sentence contents original text
tagNameLRPforNLPstringtag name LRP for NLP

Class LRPpreprocessorMultiwordReductionBasicSentence

Class Data
nametypedescription
firstTagInSentenceLRPpreprocessorMultiwordReductionWord*first tag in sentence
nextSentenceLRPpreprocessorMultiwordReductionBasicSentence*next sentence

Class LRPpreprocessorMultiwordReductionPhrasalVerbSentence

Class Data
nametypedescription
firstTagInSentenceLRPpreprocessorMultiwordReductionPhrasalVerbWord*first tag in sentence
alternateSentenceLRPpreprocessorMultiwordReductionPhrasalVerbSentence*alternate sentence
nextSentenceLRPpreprocessorMultiwordReductionPhrasalVerbSentence*next sentence

Class LRPpreprocessorMultiwordReductionIrregularVerbSentence

Class Data
nametypedescription
firstTagInSentenceLRPpreprocessorMultiwordReductionIrregularVerbWord*first tag in sentence
nextSentenceLRPpreprocessorMultiwordReductionIrregularVerbSentence*next sentence

Class LRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo

Class Data
nametypedescription
wordWithLRPstringword with LRP
lemmaWithLRPstringlemma with LRP
wordWithLRPforNLPonlystringword with LRP for NLP only
entityIndexintentity index
sentenceIndexintsentence index
nextLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo*next

Function LRPpreprocessorWordClassClass::generateTextFromPreprocessorSentenceWordList()

Function Summary
namereturn typedescription
generateTextFromPreprocessorSentenceWordListstringgenerate text from preprocessor sentence word list

Function Arguments
nametypedescription
firstWordInSentenceconstEffective LRPpreprocessorPlainTextWord* first word in sentence

Function Reference List


Function LRPpreprocessorWordClassClass::generateTextFromPreprocessorSentenceWordList()

Function Summary
namereturn typedescription
generateTextFromPreprocessorSentenceWordListstringgenerate text from preprocessor sentence word list

Function Arguments
nametypedescription
firstWordInSentenceconstEffective LRPpreprocessorPlainTextWord* first word in sentence
LRPforNLP const bool LRP for NLP

Function Reference List


Function LRPpreprocessorWordClassClass::generateTextFromPreprocessorSentenceWord()

Function Summary
namereturn typedescription
generateTextFromPreprocessorSentenceWordstringgenerate text from preprocessor sentence word

Function Arguments
nametypedescription
wordconstEffective 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
namereturn typedescription
generateSentenceWordListboolgenerate sentence word list

Function Arguments
nametypedescription
sentenceContentsFirstWordLRPpreprocessorPlainTextWord* sentence contents first word
wordList vector<LRPpreprocessorPlainTextWord*>* word list

Function Reference List


Function LRPpreprocessorWordClassClass::generateSentenceWordList()

Function Summary
namereturn typedescription
generateSentenceWordListboolgenerate sentence word list

Function Arguments
nametypedescription
sentenceContentsFirstWordLRPpreprocessorPlainTextWord* 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
namereturn typedescription
generateFlatSentenceWordListboolgenerate flat sentence word list

Function Arguments
nametypedescription
wordListvector<LRPpreprocessorPlainTextWord*>* word list
sentenceContentsFirstWord LRPpreprocessorMultiwordReductionPlainTextWord** sentence contents first word

Function Reference List
N/A


Function LRPpreprocessorWordClassClass::isIntrawordPunctuationMark()

Function Summary
namereturn typedescription
isIntrawordPunctuationMarkboolis intraword punctuation mark

Function Arguments
nametypedescription
indexOfCurrentTokenint index of current token
lineContents string* line contents

Function Reference List


Function LRPpreprocessorWordClassClass::findStringInWordList()

Function Summary
namereturn typedescription
findStringInWordListintfind string in word list

Function Arguments
nametypedescription
wordListvector<LRPpreprocessorPlainTextWord*>* word list
stringToFind const string string to find

Function Reference List


Function LRPpreprocessorWordClassClass::findStringInWordList()

Function Summary
namereturn typedescription
findStringInWordListintfind string in word list

Function Arguments
nametypedescription
wordListvector<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
namereturn typedescription
preprocessorFillCurrentWordvoidpreprocessor fill current word

Function Arguments
nametypedescription
currentWordInSentenceLRPpreprocessorMultiwordReductionPlainTextWord** 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
namereturn typedescription
getPOStypeFromNameintget POS type from name

Function Arguments
nametypedescription
wordPOStypeNameconst string word POS type name

Function Reference List


Function LRPpreprocessorWordClassClass::isStringNumber()

Function Summary
namereturn typedescription
isStringNumberboolis string number

Function Arguments
nametypedescription
phraseconst string phrase

Function Reference List


Function LRPpreprocessorWordClassClass::isMidSentenceUppercaseWordLikelyProperNoun()

Function Summary
namereturn typedescription
isMidSentenceUppercaseWordLikelyProperNounboolis mid sentence uppercase word likely proper noun

Function Arguments
nametypedescription
contextWordconstEffective LRPpreprocessorPlainTextWord* context word

Function Reference List


Function LRPpreprocessorWordClassClass::wordIsUpperCase()

Function Summary
namereturn typedescription
wordIsUpperCaseboolword is upper case

Function Arguments
nametypedescription
wordTextstring word text

Function Reference List
N/A


Function LRPpreprocessorWordClassClass::convertSentenceContentsIndexToEntityIndex()

Function Summary
namereturn typedescription
convertSentenceContentsIndexToEntityIndexintconvert sentence contents index to entity index

Function Arguments
nametypedescription
sentenceContentsIndexconst 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


File Diagram (functions hierarchy)


Function LRPpreprocessorWordIdentificationClass::getWordList()

Function Summary
namereturn typedescription
getWordListunordered_map*get word list

Function Arguments
nametypedescription
GIAposTypeconst int GIA pos type

Function Reference List


Function LRPpreprocessorWordIdentificationClass::getWordListIfExistent()

Function Summary
namereturn typedescription
getWordListIfExistentunordered_map*get word list if existent

Function Arguments
nametypedescription
GIAposTypeconst int GIA pos type
result bool* result

Function Reference List
N/A


Function LRPpreprocessorWordIdentificationClass::transferWordList()

Function Summary
namereturn typedescription
transferWordListbooltransfer word list

Function Arguments
nametypedescription
GIAposType1const int GIA pos type 1
GIAposType2 const int GIA pos type 2
wordList1record unordered_map<string,LRPpreprocessorMultiwordReductionWord*>** word list 1record

Function Reference List


Function LRPpreprocessorWordIdentificationClass::getWordListAllTypesWithPOSambiguityInfo()

Function Summary
namereturn typedescription
getWordListAllTypesWithPOSambiguityInfounordered_map>*get word list all types with POS ambiguity info

Function Reference List
N/A


Function LRPpreprocessorWordIdentificationClass::insertInstanceInMapWordListAllTypesWithPOSambiguityInfo()

Function Summary
namereturn typedescription
insertInstanceInMapWordListAllTypesWithPOSambiguityInfovoidinsert instance in map word list all types with POS ambiguity info

Function Arguments
nametypedescription
mapWordListAllTypesWithPOSambiguityInfounordered_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
namereturn typedescription
initialiseLRPboolinitialise LRP

Function Arguments
nametypedescription
newLRPDataFolderNameconst string new LRPD ata folder name
newUseLRP const bool new use LRP

Function Reference List


Function LRPpreprocessorWordIdentificationClass::loadWordListWrapper()

Function Summary
namereturn typedescription
loadWordListWrapperboolload word list wrapper

Function Arguments
nametypedescription
wordListLoadedbool* word list loaded
wordListFileName const string word list file name
wordList unordered_map<string,LRPpreprocessorMultiwordReductionWord*>* word list

Function Reference List


Function LRPpreprocessorWordIdentificationClass::loadWordList()

Function Summary
namereturn typedescription
loadWordListboolload word list

Function Arguments
nametypedescription
wordListFileNameconst string word list file name
wordList unordered_map<string,LRPpreprocessorMultiwordReductionWord*>* word list

Function Reference List


Function LRPpreprocessorWordIdentificationClass::loadStructuredDataListIrregularVerb()

Function Summary
namereturn typedescription
loadStructuredDataListIrregularVerbboolload structured data list irregular verb

Function Arguments
nametypedescription
irregularVerbListFileNameconst string irregular verb list file name
irregularVerbList unordered_map<string,LRPpreprocessorMultiwordReductionIrregularVerbSentence*>* irregular verb list

Function Reference List
N/A


Function LRPpreprocessorWordIdentificationClass::generateNounPluralVariantsList()

Function Summary
namereturn typedescription
generateNounPluralVariantsListboolgenerate noun plural variants list

Function Arguments
nametypedescription
irregularNounListunordered_map<string,LRPpreprocessorMultiwordReductionBasicSentence*>* irregular noun list

Function Reference List


Function LRPpreprocessorWordIdentificationClass::generateNounPluralVariants()

Function Summary
namereturn typedescription
generateNounPluralVariantsboolgenerate noun plural variants

Function Arguments
nametypedescription
wordTagLRPpreprocessorMultiwordReductionWord* word tag
nounPluralVariantsList unordered_map<string,LRPpreprocessorMultiwordReductionWord*>* noun plural variants list
irregularNounList unordered_map<string,LRPpreprocessorMultiwordReductionBasicSentence*>* irregular noun list

Function Reference List


Function LRPpreprocessorWordIdentificationClass::generateVerbCaseStandardAndAdditionalList()

Function Summary
namereturn typedescription
generateVerbCaseStandardAndAdditionalListboolgenerate verb case standard and additional list

Function Arguments
nametypedescription
grammaticallyStrictbool grammatically strict

Function Reference List


Function LRPpreprocessorWordIdentificationClass::generateAdditionalTenseVariantsOfVerbBase()

Function Summary
namereturn typedescription
generateAdditionalTenseVariantsOfVerbBaseboolgenerate additional tense variants of verb base

Function Arguments
nametypedescription
verbCaseAdditionalListunordered_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


Function LRPpreprocessorWordIdentificationClass::addVerbCaseAdditional()

Function Summary
namereturn typedescription
addVerbCaseAdditionalvoidadd verb case additional

Function Arguments
nametypedescription
currentTagInVerbListconst 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
namereturn typedescription
loadStructuredDataListboolload structured data list

Function Arguments
nametypedescription
structuredDataListFileNameconst string structured data list file name
structuredDataList unordered_map<string,LRPpreprocessorMultiwordReductionBasicSentence*>* structured data list

Function Reference List
N/A


Function LRPpreprocessorWordIdentificationClass::verbCaseDetectGrammaticallyStrictVariant()

Function Summary
namereturn typedescription
verbCaseDetectGrammaticallyStrictVariantboolverb case detect grammatically strict variant

Function Arguments
nametypedescription
grammaticalTenseFormconst int grammatical tense form

Function Reference List
N/A


Function LRPpreprocessorWordIdentificationClass::findSentenceInSentenceListBasic()

Function Summary
namereturn typedescription
findSentenceInSentenceListBasicboolfind sentence in sentence list basic

Function Arguments
nametypedescription
sentenceListunordered_map<string,LRPpreprocessorMultiwordReductionBasicSentence*>* sentence list
word const string word
sentenceFound LRPpreprocessorMultiwordReductionBasicSentence** sentence found

Function Reference List
N/A


Function LRPpreprocessorWordIdentificationClass::createWordIndexListFromLRPfiles()

Function Summary
namereturn typedescription
createWordIndexListFromLRPfilesboolcreate word index list from LRP files

Function Reference List


File LRPpreprocessorWordReduction Documentation

File Name: LRPpreprocessorWordReduction.cpp/.hpp

File Description: LRP preprocessor word reduction

File Function List


File Diagram (functions hierarchy)


Function LRPpreprocessorWordReductionClass::initialiseLRPreduction()

Function Summary
namereturn typedescription
initialiseLRPreductionboolinitialise LRP reduction

Function Arguments
nametypedescription
irregularVerbListunordered_map<string,LRPpreprocessorMultiwordReductionIrregularVerbSentence*>* irregular verb list

Function Reference List


Function LRPpreprocessorWordReductionClass::loadPhrasalVerbDataAndGenerateAllTenseVariants()

Function Summary
namereturn typedescription
loadPhrasalVerbDataAndGenerateAllTenseVariantsboolload phrasal verb data and generate all tense variants

Function Arguments
nametypedescription
phrasalVerbDatabaseFileNameconst string phrasal verb database file name
phrasalVerbList multimap<string, LRPpreprocessorMultiwordReductionPhrasalVerbSentence*>* phrasal verb list
irregularVerbList unordered_map<string,LRPpreprocessorMultiwordReductionIrregularVerbSentence*>* irregular verb list

Function Reference List


Function LRPpreprocessorWordReductionClass::getActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo()

Function Summary
namereturn typedescription
getActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfoLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo*get active LRP preprocessor multiword reduction tag text correspondence info

Function Reference List
N/A


Function LRPpreprocessorWordReductionClass::setActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo()

Function Summary
namereturn typedescription
setActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfovoidset active LRP preprocessor multiword reduction tag text correspondence info

Function Arguments
nametypedescription
isQueryconst bool is query

Function Reference List
N/A


Function LRPpreprocessorWordReductionClass::initialiseActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo()

Function Summary
namereturn typedescription
initialiseActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfovoidinitialise active LRP preprocessor multiword reduction tag text correspondence info

Function Arguments
nametypedescription
isQueryconst bool is query

Function Reference List
N/A


Function LRPpreprocessorWordReductionClass::deinitialiseActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo()

Function Summary
namereturn typedescription
deinitialiseActiveLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfovoiddeinitialise active LRP preprocessor multiword reduction tag text correspondence info

Function Arguments
nametypedescription
isQueryconst bool is query

Function Reference List
N/A


Function LRPpreprocessorWordReductionClass::parseTextFileAndReduceLanguage()

Function Summary
namereturn typedescription
parseTextFileAndReduceLanguageboolparse text file and reduce language

Function Arguments
nametypedescription
firstLRPpreprocessorSentenceInListLRPpreprocessorSentence* 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


Function LRPpreprocessorWordReductionClass::searchAndReplacePhrasalVerbs()

Function Summary
namereturn typedescription
searchAndReplacePhrasalVerbsboolsearch and replace phrasal verbs

Function Arguments
nametypedescription
firstLRPpreprocessorSentenceInListLRPpreprocessorSentence* 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


Function LRPpreprocessorWordReductionClass::loadMultiwordWordList()

Function Summary
namereturn typedescription
loadMultiwordWordListboolload multiword word list

Function Arguments
nametypedescription
multiwordWordListFileNameconst string multiword word list file name
multiwordWordList multimap<string, LRPpreprocessorMultiwordReductionBasicSentence*>* multiword word list

Function Reference List
N/A


Function LRPpreprocessorWordReductionClass::searchAndReplaceMultiwordWordList()

Function Summary
namereturn typedescription
searchAndReplaceMultiwordWordListboolsearch and replace multiword word list

Function Arguments
nametypedescription
firstLRPpreprocessorSentenceInListLRPpreprocessorSentence* 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


Function LRPpreprocessorWordReductionClass::searchAndReplaceMultiwordWordListDynamic()

Function Summary
namereturn typedescription
searchAndReplaceMultiwordWordListDynamicboolsearch and replace multiword word list dynamic

Function Arguments
nametypedescription
firstLRPpreprocessorSentenceInListLRPpreprocessorSentence* 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


Function LRPpreprocessorWordReductionClass::createNewCorrespondenceInfo()

Function Summary
namereturn typedescription
createNewCorrespondenceInfovoidcreate new correspondence info

Function Arguments
nametypedescription
firstLRPpreprocessorMultiwordReductiontagCorrespondenceInfoLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo* 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


Function LRPpreprocessorWordReductionClass::renumberEntityIndiciesInCorrespondenceInfo()

Function Summary
namereturn typedescription
renumberEntityIndiciesInCorrespondenceInfovoidrenumber entity indicies in correspondence info

Function Arguments
nametypedescription
firstLRPpreprocessorMultiwordReductiontagCorrespondenceInfoLRPpreprocessorMultiwordReductionTagTextCorrespondenceInfo* 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
namereturn typedescription
writeTagListToFileboolwrite tag list to file

Function Arguments
nametypedescription
firstLRPpreprocessorSentenceInListLRPpreprocessorSentence* 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


Function LRPpreprocessorWordReductionClass::generateWordWithLRPforNLPonly()

Function Summary
namereturn typedescription
generateWordWithLRPforNLPonlystringgenerate word with LRP for NLP only

Function Arguments
nametypedescription
currentTagInPlainTextSentenceconst LRPpreprocessorMultiwordReductionPlainTextWord* current tag in plain text sentence

Function Reference List
N/A


Function LRPpreprocessorWordReductionClass::generateIrregularTenseVariantsOfVerbBase()

Function Summary
namereturn typedescription
generateIrregularTenseVariantsOfVerbBaseboolgenerate irregular tense variants of verb base

Function Arguments
nametypedescription
baseTagLRPpreprocessorMultiwordReductionWord* base tag
irregularVerbList unordered_map<string,LRPpreprocessorMultiwordReductionIrregularVerbSentence*>* irregular verb list
grammaticallyStrict const bool grammatically strict

Function Reference List


Function LRPpreprocessorWordReductionClass::generateStandardTenseVariantsOfVerbBase()

Function Summary
namereturn typedescription
generateStandardTenseVariantsOfVerbBaseboolgenerate standard tense variants of verb base

Function Arguments
nametypedescription
baseTagLRPpreprocessorMultiwordReductionWord* base tag
irregularVerbFound const bool irregular verb found
grammaticallyStrict const bool grammatically strict

Function Reference List


Function LRPpreprocessorWordReductionClass::findSentenceInSentenceListIrregularVerb()

Function Summary
namereturn typedescription
findSentenceInSentenceListIrregularVerbboolfind sentence in sentence list irregular verb

Function Arguments
nametypedescription
sentenceListunordered_map<string,LRPpreprocessorMultiwordReductionIrregularVerbSentence*>* sentence list
word const string word
sentenceFound LRPpreprocessorMultiwordReductionIrregularVerbSentence** sentence found

Function Reference List
N/A


Function LRPpreprocessorWordReductionClass::replaceAllNumericalWordsWithNumbers()

Function Summary
namereturn typedescription
replaceAllNumericalWordsWithNumbersboolreplace all numerical words with numbers

Function Arguments
nametypedescription
firstLRPpreprocessorSentenceInListLRPpreprocessorSentence* first LRP preprocessor sentence in list

Function Reference List


Function LRPpreprocessorWordReductionClass::convertWordToNumber()

Function Summary
namereturn typedescription
convertWordToNumberint64_tconvert word to number

Function Arguments
nametypedescription
numericalWordListvector<LRPpreprocessorPlainTextWord*>* numerical word list

Function Reference List


Function LRPpreprocessorWordReductionClass::parseNumerals()

Function Summary
namereturn typedescription
parseNumeralsint64_tparse numerals

Function Arguments
nametypedescription
numericalWordListSubsetconst vector<LRPpreprocessorPlainTextWord*>* numerical word list subset

Function Reference List


Function LRPpreprocessorWordReductionClass::getValueOf()

Function Summary
namereturn typedescription
getValueOfint64_tget value of

Function Arguments
nametypedescription
wordTextconst string word text

Function Reference List


File LRPpreprocessorPOStagger Documentation

File Name: LRPpreprocessorPOStagger.cpp/.hpp

File Description: LRP preprocessor POS tagger

File Function List


File Diagram (functions hierarchy)


Function LRPpreprocessorPOStaggerClass::generatePOStaggerDatabaseFromWikiDumpText()

Function Summary
namereturn typedescription
generatePOStaggerDatabaseFromWikiDumpTextboolgenerate POS tagger database from wiki dump text

Function Arguments
nametypedescription
wikiDumpFolderNamestring wiki dump folder name
useLRP const bool use LRP

Function Reference List


Function LRPpreprocessorPOStaggerClass::generatePOStaggerDatabaseFromWikiDumpText()

Function Summary
namereturn typedescription
generatePOStaggerDatabaseFromWikiDumpTextboolgenerate POS tagger database from wiki dump text

Function Arguments
nametypedescription
wikiDumpFolderNamestring wiki dump folder name
wikiDumpFileBatchIndex int wiki dump file batch index
useLRP const bool use LRP

Function Reference List


Function LRPpreprocessorPOStaggerClass::addPOStaggerDatabaseEntry1()

Function Summary
namereturn typedescription
addPOStaggerDatabaseEntry1booladd POS tagger database entry 1

Function Arguments
nametypedescription
POSambiguityInfoPermutationconst vector<uint64_t>* POS ambiguity info permutation
XtrainBatchFileObject ofstream* Xtrain batch file object

Function Reference List


Function LRPpreprocessorPOStaggerClass::addPOStaggerDatabaseEntry2()

Function Summary
namereturn typedescription
addPOStaggerDatabaseEntry2booladd POS tagger database entry 2

Function Arguments
nametypedescription
centreWordPOSambiguityInfouint64_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
namereturn typedescription
addPOStaggerDatabaseEntry3booladd POS tagger database entry 3

Function Arguments
nametypedescription
centreWordPOSambiguityInfouint64_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
namereturn typedescription
addPOStaggerDatabaseEntry4booladd POS tagger database entry 4

Function Arguments
nametypedescription
centreWordPOSambiguityInfouint64_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
namereturn typedescription
generateWikiDumpTextInputFileNamestringgenerate wiki dump text input file name

Function Arguments
nametypedescription
wikiDumpFileBatchIndexconst int wiki dump file batch index

Function Reference List


Function LRPpreprocessorPOStaggerClass::generatePreprocessorSentenceObjectsFromText()

Function Summary
namereturn typedescription
generatePreprocessorSentenceObjectsFromTextboolgenerate preprocessor sentence objects from text

Function Arguments
nametypedescription
inputFileNameconst string input file name
firstLRPpreprocessorSentenceInText LRPpreprocessorSentence* first LRP preprocessor sentence in text
useLRP const bool use LRP

Function Reference List


Function LRPpreprocessorPOStaggerClass::createPreprocessSentencesBasic()

Function Summary
namereturn typedescription
createPreprocessSentencesBasicboolcreate preprocess sentences basic

Function Arguments
nametypedescription
fileContentsstring file contents
firstLRPpreprocessorSentenceInList LRPpreprocessorSentence* first LRP preprocessor sentence in list
interpretNewLinesAsNewSentences const bool interpret new lines as new sentences

Function Reference List


Function LRPpreprocessorPOStaggerClass::generateANNexperienceFromPOSambiguityInfoPermutation()

Function Summary
namereturn typedescription
generateANNexperienceFromPOSambiguityInfoPermutationboolgenerate ANN experience from POS ambiguity info permutation

Function Arguments
nametypedescription
POSambiguityInfoPermutationconst vector<uint64_t>* POS ambiguity info permutation
centreWordUnambiguousPOSindex uchar centre word unambiguous POS index
currentExperience ANNexperience* current experience

Function Reference List


Function LRPpreprocessorPOStaggerClass::generatePOSambiguityInfoPermutation()

Function Summary
namereturn typedescription
generatePOSambiguityInfoPermutationboolgenerate POS ambiguity info permutation

Function Arguments
nametypedescription
sentenceContentsvector<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


Function LRPpreprocessorPOStaggerClass::generatePOSambiguityInfoUnambiguousPermutationArray()

Function Summary
namereturn typedescription
generatePOSambiguityInfoUnambiguousPermutationArrayvoidgenerate POS ambiguity info unambiguous permutation array

Function Arguments
nametypedescription
POSambiguityInfoUnambiguousPermutationArrayvector<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


Function LRPpreprocessorPOStaggerClass::determinePOSambiguityInfo()

Function Summary
namereturn typedescription
determinePOSambiguityInfobooldetermine POS ambiguity info

Function Arguments
nametypedescription
contextWordconstEffective 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


Function LRPpreprocessorPOStaggerClass::findWordInWordListAllTypesWithPOSambiguityInfo()

Function Summary
namereturn typedescription
findWordInWordListAllTypesWithPOSambiguityInfoboolfind word in word list all types with POS ambiguity info

Function Arguments
nametypedescription
wordconst string word
wordFound LRPpreprocessorMultiwordReductionWord** word found
POSambiguityInfoFound uint64_t* POS ambiguity info found

Function Reference List


Function LRPpreprocessorPOStaggerClass::generateANNexperienceFromPOSambiguityInfoPermutationStandalone()

Function Summary
namereturn typedescription
generateANNexperienceFromPOSambiguityInfoPermutationStandaloneboolgenerate ANN experience from POS ambiguity info permutation standalone

Function Arguments
nametypedescription
POSambiguityInfoPermutationconst vector<uint64_t>* POS ambiguity info permutation
outputNeuronExperienceValue uchar output neuron experience value
currentExperience ANNexperience* current experience

Function Reference List


Function LRPpreprocessorPOStaggerClass::setSentenceContentsWordsUnambiguousPOSindex()

Function Summary
namereturn typedescription
setSentenceContentsWordsUnambiguousPOSindexboolset sentence contents words unambiguous POS index

Function Arguments
nametypedescription
sentenceContentsvector<LRPpreprocessorPlainTextWord*>* sentence contents
POSambiguityInfoPermutationTemp const vector<uint64_t>* POS ambiguity info permutation temp

Function Reference List


File LRPpreprocessorPOStaggerDatabase Documentation

File Name: LRPpreprocessorPOStaggerDatabase.cpp/.hpp

File Description: LRP preprocessor POS tagger database

File Function List


File Diagram (functions hierarchy)


Function LRPpreprocessorPOStaggerDatabaseClass::initialisePOStaggerDatabase()

Function Summary
namereturn typedescription
initialisePOStaggerDatabasevoidinitialise POS tagger database

Function Arguments
nametypedescription
newLRPposTaggerDatabaseFolderNameconst string new LRP pos tagger database folder name

Function Reference List


Function LRPpreprocessorPOStaggerDatabaseClass::writeDatabaseNeuralNetwork()

Function Summary
namereturn typedescription
writeDatabaseNeuralNetworkboolwrite database neural network

Function Reference List


Function LRPpreprocessorPOStaggerDatabaseClass::externalANNgenerateBatchTrainData()

Function Summary
namereturn typedescription
externalANNgenerateBatchTrainDataboolexternal ANN generate batch train data

Function Arguments
nametypedescription
firstExperienceInListconst ANNexperience* first experience in list
batchIndex const int batch index

Function Reference List


Function LRPpreprocessorPOStaggerDatabaseClass::externalANNgenerateBatchFileName()

Function Summary
namereturn typedescription
externalANNgenerateBatchFileNamestringexternal ANN generate batch file name

Function Arguments
nametypedescription
fileNamePrependconst string file name prepend
batchIndex const int batch index

Function Reference List


Function LRPpreprocessorPOStaggerDatabaseClass::externalANNgenerateBatchTrainDataExecuteFeed()

Function Summary
namereturn typedescription
externalANNgenerateBatchTrainDataExecuteFeedboolexternal ANN generate batch train data execute feed

Function Reference List


Function LRPpreprocessorPOStaggerDatabaseClass::externalANNtrain()

Function Summary
namereturn typedescription
externalANNtrainboolexternal ANN train

Function Reference List


Function LRPpreprocessorPOStaggerDatabaseClass::externalANNtrainEpoch()

Function Summary
namereturn typedescription
externalANNtrainEpochboolexternal ANN train epoch

Function Reference List


Function LRPpreprocessorPOStaggerDatabaseClass::externalANNtrainEpochBatch()

Function Summary
namereturn typedescription
externalANNtrainEpochBatchboolexternal ANN train epoch batch

Function Reference List


Function LRPpreprocessorPOStaggerDatabaseClass::externalANNgenerateBatchDataExperiences()

Function Summary
namereturn typedescription
externalANNgenerateBatchDataExperiencesboolexternal ANN generate batch data experiences

Function Arguments
nametypedescription
firstExperienceInListconst ANNexperience* first experience in list
batchDataInput vector<string>* batch data input
batchDataOutput vector<string>* batch data output

Function Reference List


Function LRPpreprocessorPOStaggerDatabaseClass::externalANNgenerateBatchDataExperienceInput()

Function Summary
namereturn typedescription
externalANNgenerateBatchDataExperienceInputstringexternal ANN generate batch data experience input

Function Arguments
nametypedescription
currentExperienceInListconst ANNexperience* current experience in list

Function Reference List


Function LRPpreprocessorPOStaggerDatabaseClass::externalANNexecuteScript()

Function Summary
namereturn typedescription
externalANNexecuteScriptboolexternal ANN execute script

Function Arguments
nametypedescription
scriptNamestring script name

Function Reference List


Function LRPpreprocessorPOStaggerDatabaseClass::generateIntFormatString()

Function Summary
namereturn typedescription
generateIntFormatStringstringgenerate int format string

Function Arguments
nametypedescription
numberOfCharactersconst int number of characters

Function Reference List


Function LRPpreprocessorPOStaggerDatabaseClass::determinePOSambiguityInfoIsAmbiguous()

Function Summary
namereturn typedescription
determinePOSambiguityInfoIsAmbiguousbooldetermine POS ambiguity info is ambiguous

Function Arguments
nametypedescription
POSambiguityInfoconst 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


Function LRPpreprocessorPOStaggerDatabaseClass::externalANNgenerateExperienceInputStandalone()

Function Summary
namereturn typedescription
externalANNgenerateExperienceInputStandalonestringexternal ANN generate experience input standalone

Function Arguments
nametypedescription
currentExperienceInListconst ANNexperience* current experience in list

Function Reference List