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 ANNmain Documentation

File Name: ANNmain.cpp/.hpp

File Description: ANN main

File Function List


File Diagram (functions hierarchy)


Function main()

Function Summary
namereturn typedescription
mainintmain

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

Function Reference List


Function ANNmainClass::mainUI()

Function Summary
namereturn typedescription
mainUIboolmain UI

Function Reference List


Function ANNmainClass::loadNetworkFromXML()

Function Summary
namereturn typedescription
loadNetworkFromXMLboolload network from XML

Function Reference List


Function ANNmainClass::loadExperienceDataFile()

Function Summary
namereturn typedescription
loadExperienceDataFileboolload experience data file

Function Reference List


Function ANNmainClass::createNetwork()

Function Summary
namereturn typedescription
createNetworkboolcreate network

Function Reference List


Function ANNmainClass::trainNetwork()

Function Summary
namereturn typedescription
trainNetworkbooltrain network

Function Arguments
nametypedescription
advancedTrainingconst bool advanced training

Function Reference List


Function ANNmainClass::outputNetworkToXML()

Function Summary
namereturn typedescription
outputNetworkToXMLbooloutput network to XML

Function Reference List


Function ANNmainClass::outputNetworkAsVectorGraphics()

Function Summary
namereturn typedescription
outputNetworkAsVectorGraphicsbooloutput network as vector graphics

Function Reference List


File ANNformation Documentation

File Name: ANNformation.cpp/.hpp

File Description: ANN formation

File Function List


File Diagram (functions hierarchy)


Function ANNformationClass::formNeuralNetworkInputLayer()

Function Summary
namereturn typedescription
formNeuralNetworkInputLayervoidform neural network input layer

Function Arguments
nametypedescription
firstInputNeuronInNetworkANNneuron* first input neuron in network
numberOfInputNeurons const int number of input neurons

Function Reference List


Function ANNformationClass::formNeuralNetWithOptimisedProperties()

Function Summary
namereturn typedescription
formNeuralNetWithOptimisedPropertiesANNneuron*form neural net with optimised properties

Function Arguments
nametypedescription
firstInputNeuronInNetworkANNneuron* first input neuron in network
numberOfInputNeurons const int64_t number of input neurons
numberOfOutputNeurons int64_t number of output neurons
numberOfLayers const int64_t number of layers

Function Reference List


Function ANNformationClass::formNeuralNet()

Function Summary
namereturn typedescription
formNeuralNetANNneuron*form neural net

Function Arguments
nametypedescription
firstInputNeuronANNneuron* first input neuron
numberOfInputNeurons const int64_t number of input neurons
numberOfOutputNeurons int64_t number of output neurons
numberOfLayers const int64_t number of layers
layerDivergenceType const int layer divergence type
meanLayerDivergenceFactor const double mean layer divergence factor
probabilityANNneuronConnectionWithPreviousLayerNeuron const double probability ANN neuron connection with previous layer neuron
probabilityANNneuronConnectionWithAllPreviousLayersNeurons const double probability ANN neuron connection with all previous layers neurons

Function Reference List


Function ANNformationClass::formAdvancedNeuralNetwork()

Function Summary
namereturn typedescription
formAdvancedNeuralNetworkANNneuron*form advanced neural network

Function Arguments
nametypedescription
firstInputNeuronANNneuron* first input neuron
numberOfInputNeurons const int64_t number of input neurons
numberOfOutputNeurons int64_t number of output neurons
useSubnetDependentNumberOfLayers const bool use subnet dependent number of layers
probabilityOfSubnetCreation const double probability of subnet creation
maxNumberOfRecursiveSubnets const int64_t max number of recursive subnets
numberOfLayers const int64_t number of layers
layerDivergenceType const int layer divergence type
meanLayerDivergenceFactor const double mean layer divergence factor
probabilityANNneuronConnectionWithPreviousLayerNeuron const double probability ANN neuron connection with previous layer neuron
probabilityANNneuronConnectionWithAllPreviousLayersNeurons const double probability ANN neuron connection with all previous layers neurons

Function Reference List


Function ANNformationClass::formNonDistinctLayeredNeuralNetwork()

Function Summary
namereturn typedescription
formNonDistinctLayeredNeuralNetworkANNneuron*form non distinct layered neural network

Function Arguments
nametypedescription
firstInputNeuronInNetworkANNneuron* first input neuron in network
numberOfInputNeurons const int64_t number of input neurons
numberOfOutputNeurons int64_t number of output neurons
numberOfLayers const int64_t number of layers
probabilityOfSubnetCreation const double probability of subnet creation
maxNumberOfRecursiveSubnets const int64_t max number of recursive subnets
useSubnetDependentNumberOfLayers const bool use subnet dependent number of layers
subnetNumberOfLayersModifier const double subnet number of layers modifier
layerDivergenceType const int layer divergence type
meanLayerDivergenceFactor const double mean layer divergence factor
probabilityANNneuronConnectionWithPreviousLayerNeuron const double probability ANN neuron connection with previous layer neuron
probabilityANNneuronConnectionWithAllPreviousLayersNeurons const double probability ANN neuron connection with all previous layers neurons

Function Reference List


Function ANNformationClass::createInputLayerInNeuralNetwork()

Function Summary
namereturn typedescription
createInputLayerInNeuralNetworkvoidcreate input layer in neural network

Function Arguments
nametypedescription
firstInputNeuronInNetworkANNneuron* first input neuron in network
numberOfInputNeurons const int64_t number of input neurons

Function Reference List


Function ANNformationClass::createInputLayerInNeuralNetwork2D()

Function Summary
namereturn typedescription
createInputLayerInNeuralNetwork2Dvoidcreate input layer in neural network 2D

Function Arguments
nametypedescription
firstInputNeuronInNetworkANNneuron* first input neuron in network
numberOfInputNeurons const int64_t number of input neurons

Function Reference List


Function ANNformationClass::fillNonDistinctHiddenLayer()

Function Summary
namereturn typedescription
fillNonDistinctHiddenLayerANNneuron*fill non distinct hidden layer

Function Arguments
nametypedescription
firstNeuronInCurrentLayerANNneuron* first neuron in current layer
numberOfInputNeurons const int64_t number of input neurons
numberOfOutputNeurons int64_t number of output neurons
numberOfNeuronsInCurrentLayer const int64_t number of neurons in current layer
currentNumberOfLayers const int64_t current number of layers
numberOfLayers const int64_t number of layers
probabilityOfSubnetCreation const double probability of subnet creation
maxNumberOfRecursiveSubnets const int64_t max number of recursive subnets
currentNumberOfRecursiveSubnets const int64_t current number of recursive subnets
useSubnetDependentNumberOfLayers const bool use subnet dependent number of layers
subnetNumberOfLayersModifier const double subnet number of layers modifier
layerDivergenceType const int layer divergence type
meanLayerDivergenceFactor const double mean layer divergence factor
probabilityANNneuronConnectionWithPreviousLayerNeuron const double probability ANN neuron connection with previous layer neuron
firstInputNeuronInSubnet ANNneuron* first input neuron in subnet
probabilityANNneuronConnectionWithAllPreviousLayersNeurons const double probability ANN neuron connection with all previous layers neurons
onlyLinkWithPreviousAndFirstLayer const bool only link with previous and first layer

Function Reference List


Function ANNformationClass::createNewFrontLayer()

Function Summary
namereturn typedescription
createNewFrontLayervoidcreate new front layer

Function Arguments
nametypedescription
firstNeuronInCurrentLayerANNneuron* first neuron in current layer
firstNeuronInNewFrontLayer ANNneuron* first neuron in new front layer
numberOfNeuronsInNewFrontLayer const int64_t number of neurons in new front layer
currentNumberOfLayers const int64_t current number of layers
numberOfLayers const int64_t number of layers

Function Reference List


Function ANNformationClass::linkNewFrontLayerWithPreviousLayers()

Function Summary
namereturn typedescription
linkNewFrontLayerWithPreviousLayersvoidlink new front layer with previous layers

Function Arguments
nametypedescription
firstNeuronInCurrentLayerANNneuron* first neuron in current layer
firstNeuronInNewFrontLayer ANNneuron* first neuron in new front layer
probabilityANNneuronConnectionWithPreviousLayerNeuron const double probability ANN neuron connection with previous layer neuron
firstInputNeuronInSubnet ANNneuron* first input neuron in subnet
probabilityANNneuronConnectionWithAllPreviousLayersNeurons const double probability ANN neuron connection with all previous layers neurons
numberOfInputNeurons const int64_t number of input neurons
numberOfOutputNeurons const int64_t number of output neurons
currentNumberOfLayers const int64_t current number of layers
onlyLinkWithPreviousAndFirstLayer const bool only link with previous and first layer

Function Reference List


Function ANNformationClass::linkNewFrontLayerWithPreviousLayers2D()

Function Summary
namereturn typedescription
linkNewFrontLayerWithPreviousLayers2Dvoidlink new front layer with previous layers 2D

Function Arguments
nametypedescription
firstNeuronInCurrentLayerANNneuron* first neuron in current layer
firstNeuronInNewFrontLayer ANNneuron* first neuron in new front layer
probabilityANNneuronConnectionWithPreviousLayerNeuron const double probability ANN neuron connection with previous layer neuron
firstInputNeuronInSubnet ANNneuron* first input neuron in subnet
probabilityANNneuronConnectionWithAllPreviousLayersNeurons const double probability ANN neuron connection with all previous layers neurons
numberOfInputNeurons const int64_t number of input neurons
numberOfOutputNeurons const int64_t number of output neurons
currentNumberOfLayers const int64_t current number of layers
numberOfLayers const int64_t number of layers
numberOfNeuronsInCurrentLayer const int64_t number of neurons in current layer
numberOfNeuronsInNewFrontLayer const int64_t number of neurons in new front layer
layerDivergenceType const int layer divergence type
onlyLinkWithPreviousAndFirstLayer const bool only link with previous and first layer

Function Reference List


Function ANNformationClass::calcNumberOfLayersInSubnet()

Function Summary
namereturn typedescription
calcNumberOfLayersInSubnetint64_tcalc number of layers in subnet

Function Arguments
nametypedescription
numberOfInputNeuronsconst int64_t number of input neurons
numberOfOutputNeurons const int64_t number of output neurons
currentNumberOfRecursiveSubnets const int64_t current number of recursive subnets
maxNumberOfRecursiveSubnets const int64_t max number of recursive subnets
useSubnetDependentNumberOfLayers const bool use subnet dependent number of layers
subnetNumberOfLayersModifier const double subnet number of layers modifier

Function Reference List
N/A


Function ANNformationClass::advancedDivergenceFactor()

Function Summary
namereturn typedescription
advancedDivergenceFactordoubleadvanced divergence factor

Function Arguments
nametypedescription
currentNumberOfLayersFromNearestEndPointconst int64_t current number of layers from nearest end point
numberOfLayers const int64_t number of layers

Function Reference List
N/A


Function ANNformationClass::calculateNumberOfNeuronsInNewFrontLayer()

Function Summary
namereturn typedescription
calculateNumberOfNeuronsInNewFrontLayerint64_tcalculate number of neurons in new front layer

Function Arguments
nametypedescription
numberOfInputNeuronsconst int64_t number of input neurons
numberOfOutputNeurons int64_t number of output neurons
numberOfNeuronsInCurrentLayer const int64_t number of neurons in current layer
currentNumberOfLayers const int64_t current number of layers
numberOfLayers const int64_t number of layers
meanLayerDivergenceFactor const double mean layer divergence factor
layerDivergenceType const int layer divergence type

Function Reference List


Function ANNformationClass::calculateDistanceBetween2Points()

Function Summary
namereturn typedescription
calculateDistanceBetween2Pointsdoublecalculate distance between 2P oints

Function Arguments
nametypedescription
xPositionOfUnit1const double xPosition of unit 1
xPositionOfUnit2 const double xPosition of unit 2
yPositionOfUnit1 const double yPosition of unit 1
yPositionOfUnit2 const double yPosition of unit 2

Function Reference List
N/A


Function ANNformationClass::addSideConnectionsForLayer()

Function Summary
namereturn typedescription
addSideConnectionsForLayervoidadd side connections for layer

Function Arguments
nametypedescription
firstNeuronInLayerANNneuron* first neuron in layer

Function Reference List


Function ANNformationClass::addSideConnectionsForLayer2D()

Function Summary
namereturn typedescription
addSideConnectionsForLayer2Dvoidadd side connections for layer 2D

Function Arguments
nametypedescription
firstNeuronInLayerANNneuron* first neuron in layer
layerDivergenceType const int layer divergence type
currentNumberOfLayers const int64_t current number of layers
numberOfLayers const int64_t number of layers

Function Reference List


Function ANNformationClass::addSideConnectionIfNotAlreadyAdded()

Function Summary
namereturn typedescription
addSideConnectionIfNotAlreadyAddedvoidadd side connection if not already added

Function Arguments
nametypedescription
currentNeuronL1ANNneuron* current neuron L1
currentNeuronL2 ANNneuron* current neuron L2

Function Reference List
N/A


Function ANNformationClass::countNumberOfLayersInSubnet()

Function Summary
namereturn typedescription
countNumberOfLayersInSubnetintcount number of layers in subnet

Function Arguments
nametypedescription
firstInputNeuronInSubnetANNneuron* first input neuron in subnet

Function Reference List
N/A


File ANNneuronClass Documentation

File Name: ANNneuronClass.cpp/.hpp

File Description: ANN neuron class

File Function List


File Diagram (functions hierarchy)


Class ANNneuron

Class Data
nametypedescription
idint64_tid
orderIDint64_torder ID
layerIDint64_tlayer ID
subnetIDint64_tsubnet ID
biasdoublebias
storedBiasdoublestored bias
outputdoubleoutput
classTargetdoubleclass target
errordoubleerror
backNeuronMatchTempboolback neuron match temp
memoryTraceint64_tmemory trace
intermediaryNeuronCreatedThisRoundboolintermediary neuron created this round
neuronTypeInputboolneuron type input
neuronTypeTopLevelCategoryboolneuron type top level category
neuronTypeIntermediaryboolneuron type intermediary
topLevelCategoryAlreadyExistsDeleteThisNewCopybooltop level category already exists delete this new copy
printedboolprinted
printedXMLboolprinted XML
spatialCoordinatesSet2Dboolspatial coordinates set 2D
spatialCoordinatesSet3Dboolspatial coordinates set 3D
xPosRelint64_txPos rel
yPosRelint64_tyPos rel
zPosRelint64_tzPos rel
spatialCoordinatesSetClassificationboolspatial coordinates set classification
xPosRelFracdoublexPos rel frac
yPosRelFracdoubleyPos rel frac
zPosRelFracdoublezPos rel frac
nextNeuronANNneuron*next neuron
hasFrontLayerboolhas front layer
hasBackLayerboolhas back layer
firstNeuronInFrontLayerANNneuron*first neuron in front layer
firstNeuronInBackLayerANNneuron*first neuron in back layer
frontANNneuronConnectionListvector<ANNneuronConnection*>front ANN neuron connection list
backANNneuronConnectionListvector<ANNneuronConnection*>back ANN neuron connection list
sideANNneuronConnectionListvector<ANNneuronConnection*>side ANN neuron connection list
isSubnetboolis subnet
firstNeuronInBackLayerOfSubnetANNneuron*first neuron in back layer of subnet
firstNeuronInFrontLayerOfSubnetANNneuron*first neuron in front layer of subnet
isInputSubnetboolis input subnet
isOutputSubnetboolis output subnet
GIAisConceptEntityboolGIA is concept entity
GIAentityNamestringGIA entity name
GIAactiveForSubnetIdentificationboolGIA active for subnet identification
GIAalreadyParsedboolGIA already parsed
GIAactivationAgeint64_tGIA activation age
GIAconceptIndexBitIDintGIA concept index bit ID
GIAconceptIndexTypeintGIA concept index type
GIAconceptIndexintGIA concept index
SANIneuronNamestringSANI neuron name
SANIneuronStrengthdoubleSANI neuron strength
SANIactivationLevelintSANI activation level
SANIgeneratedForLastSentenceboolSANI generated for last sentence

Class ANNtranslatorVariablesClass

Class Data
nametypedescription
firstInputNeuronInNetworkANNneuron*first input neuron in network
firstOutputNeuronInNetworkANNneuron*first output neuron in network

Function ANNneuronClassClass::fillInNeuronIDProperties()

Function Summary
namereturn typedescription
fillInNeuronIDPropertiesvoidfill in neuron IDP roperties

Function Arguments
nametypedescription
neuronToUpdateANNneuron* neuron to update
IDinit int64_t ID init
orderIDinit int64_t order ID init
layerIDinit int64_t layer ID init
subnetIDinit int64_t subnet ID init

Function Reference List
N/A


Function ANNneuronClassClass::averageNeuronKeyProperties()

Function Summary
namereturn typedescription
averageNeuronKeyPropertiesvoidaverage neuron key properties

Function Arguments
nametypedescription
neuronToUpdateANNneuron* neuron to update
neuronToCopy ANNneuron* neuron to copy

Function Reference List
N/A


File ANNalgorithmBackpropagation Documentation

File Name: ANNalgorithmBackpropagation.cpp/.hpp

File Description: ANN algorithm backpropagation

File Function List


File Diagram (functions hierarchy)


Function ANNalgorithmBackpropagationClass::trainNeuralNetworkBackpropagationSimple()

Function Summary
namereturn typedescription
trainNeuralNetworkBackpropagationSimplevoidtrain neural network backpropagation simple

Function Arguments
nametypedescription
firstInputNeuronANNneuron* first input neuron
firstOutputNeuron ANNneuron* first output neuron
numberOfInputNeurons const int number of input neurons
numberOfOutputNeurons const int number of output neurons
numEpochs const int num epochs
firstExperienceInDataSet ANNexperience* first experience in data set
numberOfExperiences const int64_t number of experiences

Function Reference List


Function ANNalgorithmBackpropagationClass::trainNeuralNetworkBackpropagationSimpleNoReset()

Function Summary
namereturn typedescription
trainNeuralNetworkBackpropagationSimpleNoResetvoidtrain neural network backpropagation simple no reset

Function Arguments
nametypedescription
firstInputNeuronANNneuron* first input neuron
firstOutputNeuron ANNneuron* first output neuron
numberOfInputNeurons const int number of input neurons
numberOfOutputNeurons const int number of output neurons
numEpochs const int num epochs
firstExperienceInDataSet ANNexperience* first experience in data set
numberOfExperiences const int64_t number of experiences

Function Reference List


Function ANNalgorithmBackpropagationClass::trainNeuralNetworkBackpropagation()

Function Summary
namereturn typedescription
trainNeuralNetworkBackpropagationvoidtrain neural network backpropagation

Function Arguments
nametypedescription
firstInputNeuronANNneuron* first input neuron
firstOutputNeuron ANNneuron* first output neuron
numberOfInputNeurons const int number of input neurons
numberOfOutputNeurons const int number of output neurons
maxFolds const int max folds
firstExperienceInDataSet ANNexperience* first experience in data set
numberOfExperiences const int64_t number of experiences
maxEpochs const int max epochs

Function Reference List


Function ANNalgorithmBackpropagationClass::storeNeuralNetworkBiasAndWeights()

Function Summary
namereturn typedescription
storeNeuralNetworkBiasAndWeightsvoidstore neural network bias and weights

Function Arguments
nametypedescription
neuronBeingAccessedANNneuron* neuron being accessed

Function Reference List


Function ANNalgorithmBackpropagationClass::restoreNeuralNetworkWithStoredBiasAndWeights()

Function Summary
namereturn typedescription
restoreNeuralNetworkWithStoredBiasAndWeightsvoidrestore neural network with stored bias and weights

Function Arguments
nametypedescription
neuronBeingAccessedANNneuron* neuron being accessed

Function Reference List


Function ANNalgorithmBackpropagationClass::resetNeuralNetworkWithRandomBiasAndWeights()

Function Summary
namereturn typedescription
resetNeuralNetworkWithRandomBiasAndWeightsvoidreset neural network with random bias and weights

Function Arguments
nametypedescription
neuronBeingAccessedANNneuron* neuron being accessed

Function Reference List


Function ANNalgorithmBackpropagationClass::resetInputsAndClassTargets()

Function Summary
namereturn typedescription
resetInputsAndClassTargetsvoidreset inputs and class targets

Function Arguments
nametypedescription
firstInputNeuronANNneuron* first input neuron
firstOutputNeuron ANNneuron* first output neuron
numberOfInputNeurons const int64_t number of input neurons
numberOfOutputNeurons const int64_t number of output neurons
currentExperienceInDataSet ANNexperience* current experience in data set

Function Reference List
N/A


Function ANNalgorithmBackpropagationClass::calculateStandardDeviation()

Function Summary
namereturn typedescription
calculateStandardDeviationfloatcalculate standard deviation

Function Arguments
nametypedescription
arrayconst float* array
length const int length
average const float average

Function Reference List
N/A


File ANNexperienceClass Documentation

File Name: ANNexperienceClass.cpp/.hpp

File Description: ANN experience class

File Function List


File Diagram (functions hierarchy)


Class ANNexperienceInput

Class Data
nametypedescription
inputValuedoubleinput value
nextANNexperienceInput*next

Class ANNexperience

Class Data
nametypedescription
classTargetValueint64_tclass target value
predictionErrordoubleprediction error
firstExperienceInputANNexperienceInput*first experience input
nextANNexperience*next

Function ANNexperienceClassClass::findExperience()

Function Summary
namereturn typedescription
findExperienceANNexperience*find experience

Function Arguments
nametypedescription
firstExperienceInDataSetANNexperience* first experience in data set
experienceNumToFind const int64_t experience num to find

Function Reference List
N/A


Function ANNexperienceClassClass::addExperiencesToOFStream()

Function Summary
namereturn typedescription
addExperiencesToOFStreamvoidadd experiences to OFS tream

Function Arguments
nametypedescription
experienceDataSetOfStreamObjectofstream* experience data set of stream object
firstExperienceInList const ANNexperience* first experience in list

Function Reference List


Function ANNexperienceClassClass::addExperienceToOFStream()

Function Summary
namereturn typedescription
addExperienceToOFStreamvoidadd experience to OFS tream

Function Arguments
nametypedescription
experienceDataSetOfStreamObjectofstream* experience data set of stream object
experience const ANNexperience* experience

Function Reference List


File SHAREDvars Documentation

File Name: SHAREDvars.cpp/.hpp

File Description: SHARED vars

File Function List


File Diagram (functions hierarchy)


Function SHAREDvarsClass::compareDoubles()

Function Summary
namereturn typedescription
compareDoublesboolcompare doubles

Function Arguments
nametypedescription
aconst double a
b const double b

Function Reference List
N/A


Function SHAREDvarsClass::minInt()

Function Summary
namereturn typedescription
minIntintmin int

Function Arguments
nametypedescription
aint a
b const int b

Function Reference List
N/A


Function SHAREDvarsClass::absDouble()

Function Summary
namereturn typedescription
absDoubledoubleabs double

Function Arguments
nametypedescription
valconst double val

Function Reference List
N/A


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::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::convertUnsignedIntToString()

Function Summary
namereturn typedescription
convertUnsignedIntToStringstringconvert unsigned int to string

Function Arguments
nametypedescription
numberconst int number

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::convertStringToDouble()

Function Summary
namereturn typedescription
convertStringToDoubledoubleconvert string to double

Function Arguments
nametypedescription
numberconst string number

Function Reference List
N/A


Function SHAREDvarsClass::writeStringToFile()

Function Summary
namereturn typedescription
writeStringToFilevoidwrite string to file

Function Arguments
nametypedescription
fileNameconst string file name
s string* s

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


File ANNalgorithmBackpropagationUpdate Documentation

File Name: ANNalgorithmBackpropagationUpdate.cpp/.hpp

File Description: ANN algorithm backpropagation update

File Function List


File Diagram (functions hierarchy)


Function ANNalgorithmBackpropagationUpdateClass::ANNbackPropogationPass()

Function Summary
namereturn typedescription
ANNbackPropogationPassdoubleANN back propogation pass

Function Arguments
nametypedescription
firstInputNeuronInNetworkANNneuron* first input neuron in network
firstOutputNeuronInNetwork ANNneuron* first output neuron in network

Function Reference List


Function ANNalgorithmBackpropagationUpdateClass::calculateErrorOfBackPropPass()

Function Summary
namereturn typedescription
calculateErrorOfBackPropPassdoublecalculate error of back prop pass

Function Arguments
nametypedescription
firstOutputNeuronInNetworkconst ANNneuron* first output neuron in network

Function Reference List
N/A


Function ANNalgorithmBackpropagationUpdateClass::backPropogationForwardPassStep()

Function Summary
namereturn typedescription
backPropogationForwardPassStepvoidback propogation forward pass step

Function Arguments
nametypedescription
neuronBeingAccessedANNneuron* neuron being accessed

Function Reference List


Function ANNalgorithmBackpropagationUpdateClass::backpropagationAdjustOutputValueOfANeuronBasedOnBackNeurons()

Function Summary
namereturn typedescription
backpropagationAdjustOutputValueOfANeuronBasedOnBackNeuronsvoidbackpropagation adjust output value of AN euron based on back neurons

Function Arguments
nametypedescription
neuronBeingAccessedANNneuron* neuron being accessed

Function Reference List


Function ANNalgorithmBackpropagationUpdateClass::calculateOValue()

Function Summary
namereturn typedescription
calculateOValuefloatcalculate OV alue

Function Arguments
nametypedescription
netValuefloat net value

Function Reference List
N/A


Function ANNalgorithmBackpropagationUpdateClass::backPropogationBackwardPassStep()

Function Summary
namereturn typedescription
backPropogationBackwardPassStepvoidback propogation backward pass step

Function Arguments
nametypedescription
neuronBeingAccessedANNneuron* neuron being accessed
isOutputLayer const int is output layer
isSubnet const bool is subnet

Function Reference List


Function ANNalgorithmBackpropagationUpdateClass::calculateOutputErrorOfOutputNeuron()

Function Summary
namereturn typedescription
calculateOutputErrorOfOutputNeuronvoidcalculate output error of output neuron

Function Arguments
nametypedescription
neuronBeingAccessedANNneuron* neuron being accessed

Function Reference List
N/A


Function ANNalgorithmBackpropagationUpdateClass::calculateOutputErrorOfNonoutputNeuron()

Function Summary
namereturn typedescription
calculateOutputErrorOfNonoutputNeuronvoidcalculate output error of nonoutput neuron

Function Arguments
nametypedescription
neuronBeingAccessedANNneuron* neuron being accessed

Function Reference List
N/A


Function ANNalgorithmBackpropagationUpdateClass::calculateNewBackConnectionWeightsOfNeuron()

Function Summary
namereturn typedescription
calculateNewBackConnectionWeightsOfNeuronvoidcalculate new back connection weights of neuron

Function Arguments
nametypedescription
neuronBeingAccessedANNneuron* neuron being accessed

Function Reference List
N/A


Function ANNalgorithmBackpropagationUpdateClass::calculateNewBiasOfNeuron()

Function Summary
namereturn typedescription
calculateNewBiasOfNeuronvoidcalculate new bias of neuron

Function Arguments
nametypedescription
neuronBeingAccessedANNneuron* neuron being accessed

Function Reference List
N/A


Function ANNalgorithmBackpropagationUpdateClass::copyNeuronContainerListToANNneuronConnectionContainerList()

Function Summary
namereturn typedescription
copyNeuronContainerListToANNneuronConnectionContainerListvoidcopy neuron container list to ANN neuron connection container list

Function Arguments
nametypedescription
ANNneuronConnectionListToUpdatevector<ANNneuronConnection*>* ANN neuron connection list to update
firstNeuronInListToCopy ANNneuron* first neuron in list to copy
frontOrBack const bool front or back

Function Reference List


Function ANNalgorithmBackpropagationUpdateClass::copyANNneuronConnectionContainerListToNeuronContainerList()

Function Summary
namereturn typedescription
copyANNneuronConnectionContainerListToNeuronContainerListvoidcopy ANN neuron connection container list to neuron container list

Function Arguments
nametypedescription
firstNeuronInListToUpdateANNneuron* first neuron in list to update
ANNneuronConnectionListToCopy vector<ANNneuronConnection*>* ANN neuron connection list to copy
frontOrBack const bool front or back

Function Reference List


File ANNalgorithmBreakawayNetwork Documentation

File Name: ANNalgorithmBreakawayNetwork.cpp/.hpp

File Description: ANN algorithm breakaway network

File Function List


File Diagram (functions hierarchy)


Function ANNalgorithmBreakawayNetworkClass::trainNeuralNetworkBreakaway()

Function Summary
namereturn typedescription
trainNeuralNetworkBreakawaybooltrain neural network breakaway

Function Arguments
nametypedescription
firstInputNeuronInNetworkANNneuron* first input neuron in network
firstOutputNeuronInNetwork ANNneuron** first output neuron in network
numberOfInputNeurons const int number of input neurons
numberOfOutputNeurons const int number of output neurons
simple const bool simple
numEpochs const int num epochs
maxFolds const int max folds
maxEpochs const int max epochs
firstExperienceInDataSet ANNexperience* first experience in data set
numberOfExperiences const int64_t number of experiences
sizeOfSupernet const int size of supernet
numberOfLayersOriginal int number of layers original

Function Reference List


File ANNalgorithmMemoryNetwork Documentation

File Name: ANNalgorithmMemoryNetwork.cpp/.hpp

File Description: ANN algorithm memory network

File Function List


File Diagram (functions hierarchy)


Function ANNalgorithmMemoryNetworkClass::trainNeuralNetworkMemorySimple()

Function Summary
namereturn typedescription
trainNeuralNetworkMemorySimplevoidtrain neural network memory simple

Function Arguments
nametypedescription
firstInputNeuronANNneuron* first input neuron
firstOutputNeuron const ANNneuron* first output neuron
numberOfInputNeurons const int64_t number of input neurons
numberOfOutputNeurons const int64_t number of output neurons
firstExperienceInDataSet ANNexperience* first experience in data set
numberOfExperiences const int64_t number of experiences

Function Reference List


Function ANNalgorithmMemoryNetworkClass::trainNeuralNetworkMemory()

Function Summary
namereturn typedescription
trainNeuralNetworkMemoryvoidtrain neural network memory

Function Arguments
nametypedescription
firstInputNeuronANNneuron* first input neuron
firstOutputNeuron const ANNneuron* first output neuron
numberOfInputNeurons const int64_t number of input neurons
numberOfOutputNeurons const int64_t number of output neurons
maxFolds const int max folds
firstExperienceInDataSet ANNexperience* first experience in data set
numberOfExperiences const int64_t number of experiences

Function Reference List


Function ANNalgorithmMemoryNetworkClass::storeNeuralNetworkMemoryTrace()

Function Summary
namereturn typedescription
storeNeuralNetworkMemoryTracevoidstore neural network memory trace

Function Arguments
nametypedescription
neuronBeingAccessedANNneuron* neuron being accessed

Function Reference List


Function ANNalgorithmMemoryNetworkClass::restoreNeuralNetworkWithStoredMemoryTrace()

Function Summary
namereturn typedescription
restoreNeuralNetworkWithStoredMemoryTracevoidrestore neural network with stored memory trace

Function Arguments
nametypedescription
neuronBeingAccessedANNneuron* neuron being accessed

Function Reference List


Function ANNalgorithmMemoryNetworkClass::resetNeuralNetworkWithRandomBiasAndWeightsAndEraseMemoryTrace()

Function Summary
namereturn typedescription
resetNeuralNetworkWithRandomBiasAndWeightsAndEraseMemoryTracevoidreset neural network with random bias and weights and erase memory trace

Function Arguments
nametypedescription
neuronBeingAccessedANNneuron* neuron being accessed

Function Reference List


Function ANNalgorithmMemoryNetworkClass::resetInputs()

Function Summary
namereturn typedescription
resetInputsvoidreset inputs

Function Arguments
nametypedescription
firstInputNeuronANNneuron* first input neuron
numberOfInputNeurons const int64_t number of input neurons
currentExperienceInDataSet ANNexperience* current experience in data set

Function Reference List
N/A


File ANNalgorithmMemoryNetworkUpdate Documentation

File Name: ANNalgorithmMemoryNetworkUpdate.cpp/.hpp

File Description: ANN algorithm memory network update

File Function List


File Diagram (functions hierarchy)


Function ANNalgorithmMemoryNetworkUpdateClass::ANNclassificationAndMemoryPass()

Function Summary
namereturn typedescription
ANNclassificationAndMemoryPassdoubleANN classification and memory pass

Function Arguments
nametypedescription
firstInputNeuronInNetworkANNneuron* first input neuron in network
firstOutputNeuronInNetwork const ANNneuron* first output neuron in network
trainingClassificationResult string* training classification result
trainingMemoryResult double* training memory result

Function Reference List


Function ANNalgorithmMemoryNetworkUpdateClass::calculateBinaryOutputCode()

Function Summary
namereturn typedescription
calculateBinaryOutputCodevoidcalculate binary output code

Function Arguments
nametypedescription
firstOutputNeuronInNetworkconst ANNneuron* first output neuron in network
trainingClassificationResult string* training classification result

Function Reference List


Function ANNalgorithmMemoryNetworkUpdateClass::isNeuronOutputFire()

Function Summary
namereturn typedescription
isNeuronOutputFireboolis neuron output fire

Function Arguments
nametypedescription
currentNeuronconst ANNneuron* current neuron

Function Reference List
N/A


Function ANNalgorithmMemoryNetworkUpdateClass::memoryTraceForwardPassStep()

Function Summary
namereturn typedescription
memoryTraceForwardPassStepvoidmemory trace forward pass step

Function Arguments
nametypedescription
neuronBeingAccessedANNneuron* neuron being accessed
trainingMemoryResult double* training memory result

Function Reference List


Function ANNalgorithmMemoryNetworkUpdateClass::readAndUpdateMemoryTrace()

Function Summary
namereturn typedescription
readAndUpdateMemoryTracevoidread and update memory trace

Function Arguments
nametypedescription
currentNeuronInLayerANNneuron* current neuron in layer
trainingMemoryResult double* training memory result

Function Reference List


Function ANNalgorithmMemoryNetworkUpdateClass::updateMemoryTraceBasedOnSimultaneouslyFiredNeuronsIeAssocation()

Function Summary
namereturn typedescription
updateMemoryTraceBasedOnSimultaneouslyFiredNeuronsIeAssocationvoidupdate memory trace based on simultaneously fired neurons ie assocation

Function Arguments
nametypedescription
currentANNneuronConnectionSideANNneuronConnection* current ANN neuron connection side

Function Reference List
N/A


Function ANNalgorithmMemoryNetworkUpdateClass::incrementMemoryTraceTallyBasedOnSimultaneouslyFiredNeuronsIeAssocation()

Function Summary
namereturn typedescription
incrementMemoryTraceTallyBasedOnSimultaneouslyFiredNeuronsIeAssocationvoidincrement memory trace tally based on simultaneously fired neurons ie assocation

Function Arguments
nametypedescription
trainingMemoryResultdouble* training memory result

Function Reference List
N/A


File ANNalgorithmClassificationNetwork Documentation

File Name: ANNalgorithmClassificationNetwork.cpp/.hpp

File Description: ANN algorithm classification network

File Function List


File Diagram (functions hierarchy)


Function ANNalgorithmClassificationNetworkClass::trainNeuralNetworkClassificationSimple()

Function Summary
namereturn typedescription
trainNeuralNetworkClassificationSimplevoidtrain neural network classification simple

Function Arguments
nametypedescription
firstInputNeuronANNneuron* first input neuron
firstOutputNeuron ANNneuron** first output neuron
numberOfInputNeurons int64_t number of input neurons
numberOfOutputNeurons int64_t* number of output neurons
firstExperienceInDataSet ANNexperience* first experience in data set
numberOfExperiences int64_t number of experiences

Function Reference List


Function ANNalgorithmClassificationNetworkClass::resetIntermediaryNeuronCreatedThisRoundFlag()

Function Summary
namereturn typedescription
resetIntermediaryNeuronCreatedThisRoundFlagvoidreset intermediary neuron created this round flag

Function Arguments
nametypedescription
categoryNeuronANNneuron* category neuron

Function Reference List


Function ANNalgorithmClassificationNetworkClass::resetBackNeuronMatchTemp()

Function Summary
namereturn typedescription
resetBackNeuronMatchTempvoidreset back neuron match temp

Function Arguments
nametypedescription
categoryNeuronANNneuron* category neuron

Function Reference List


Function ANNalgorithmClassificationNetworkClass::pruneNetorkBasedOnRarelyUsedNeurons()

Function Summary
namereturn typedescription
pruneNetorkBasedOnRarelyUsedNeuronsvoidprune netork based on rarely used neurons

Function Arguments
nametypedescription
categoryNeuronANNneuron* category neuron
firstOutputNeuron ANNneuron** first output neuron

Function Reference List


Function ANNalgorithmClassificationNetworkClass::deleteNeuron()

Function Summary
namereturn typedescription
deleteNeuronvoiddelete neuron

Function Arguments
nametypedescription
frontNeuronANNneuron* front neuron
categoryNeuron ANNneuron* category neuron
firstOutputNeuron ANNneuron** first output neuron

Function Reference List


Function ANNalgorithmClassificationNetworkClass::mergeSimilarNeurons()

Function Summary
namereturn typedescription
mergeSimilarNeuronsvoidmerge similar neurons

Function Arguments
nametypedescription
categoryNeuronANNneuron* category neuron
firstOutputNeuron ANNneuron** first output neuron

Function Reference List


Function ANNalgorithmClassificationNetworkClass::cullRedundantNeurons()

Function Summary
namereturn typedescription
cullRedundantNeuronsboolcull redundant neurons

Function Arguments
nametypedescription
categoryNeuronANNneuron* category neuron
parentNeuron ANNneuron* parent neuron
firstOutputNeuron ANNneuron** first output neuron

Function Reference List


Function ANNalgorithmClassificationNetworkClass::findCategoriesForExperienceWrapper()

Function Summary
namereturn typedescription
findCategoriesForExperienceWrappervoidfind categories for experience wrapper

Function Arguments
nametypedescription
categoryNeuronANNneuron* category neuron
inputValuesCategoryFound vector<bool>* input values category found
experienceClassificationneuronTypeTopLevelCategory ANNneuron** experience classificationneuron type top level category
createIntermediaryNeuronsStage int create intermediary neurons stage

Function Reference List


Function ANNalgorithmClassificationNetworkClass::findCategoriesForExperience()

Function Summary
namereturn typedescription
findCategoriesForExperienceboolfind categories for experience

Function Arguments
nametypedescription
categoryNeuronANNneuron* category neuron
inputValuesCategoryFound vector<bool>* input values category found
level int level

Function Reference List


Function ANNalgorithmClassificationNetworkClass::connectNeurons()

Function Summary
namereturn typedescription
connectNeuronsANNneuronConnection*connect neurons

Function Arguments
nametypedescription
childNeuronANNneuron* child neuron
parentNeuron ANNneuron* parent neuron

Function Reference List


Function ANNalgorithmClassificationNetworkClass::updateConnectionIdealValuesParent()

Function Summary
namereturn typedescription
updateConnectionIdealValuesParentvoidupdate connection ideal values parent

Function Arguments
nametypedescription
categoryNeuronANNneuron* category neuron
updateIdealValues bool update ideal values

Function Reference List


Function ANNalgorithmClassificationNetworkClass::updateConnectionIdealValuesChildren()

Function Summary
namereturn typedescription
updateConnectionIdealValuesChildrenvoidupdate connection ideal values children

Function Arguments
nametypedescription
categoryNeuronANNneuron* category neuron
updateIdealValues bool update ideal values

Function Reference List


Function ANNalgorithmClassificationNetworkClass::updateConnectionIdealValue()

Function Summary
namereturn typedescription
updateConnectionIdealValuevoidupdate connection ideal value

Function Arguments
nametypedescription
connectionANNneuronConnection* connection

Function Reference List


Function ANNalgorithmClassificationNetworkClass::updateConnectionIdealValueNoUpdating()

Function Summary
namereturn typedescription
updateConnectionIdealValueNoUpdatingvoidupdate connection ideal value no updating

Function Arguments
nametypedescription
connectionANNneuronConnection* connection

Function Reference List


Function ANNalgorithmClassificationNetworkClass::calculateIdealOutputValue()

Function Summary
namereturn typedescription
calculateIdealOutputValuedoublecalculate ideal output value

Function Arguments
nametypedescription
categoryNeuronANNneuron* category neuron

Function Reference List


Function ANNalgorithmClassificationNetworkClass::calculateOutput()

Function Summary
namereturn typedescription
calculateOutputdoublecalculate output

Function Arguments
nametypedescription
totalOutputdouble total output
numberOfCategoryInputValues double number of category input values

Function Reference List
N/A


Function ANNalgorithmClassificationNetworkClass::calculateDiff()

Function Summary
namereturn typedescription
calculateDiffdoublecalculate diff

Function Arguments
nametypedescription
idealValuedouble ideal value
value double value

Function Reference List
N/A


Function ANNalgorithmClassificationNetworkClass::calculateSum()

Function Summary
namereturn typedescription
calculateSumdoublecalculate sum

Function Arguments
nametypedescription
valuedouble value

Function Reference List
N/A


Function ANNalgorithmClassificationNetworkClass::findInputs()

Function Summary
namereturn typedescription
findInputsvoidfind inputs

Function Arguments
nametypedescription
categoryNeuronANNneuron* category neuron
inputFound vector<bool>* input found
level int level

Function Reference List


File ANNdisplay Documentation

File Name: ANNdisplay.cpp/.hpp

File Description: ANN display

File Function List


File Diagram (functions hierarchy)


Function ANNdisplayClass::outputNeuralNetworkToVectorGraphicsAndRaytrace()

Function Summary
namereturn typedescription
outputNeuralNetworkToVectorGraphicsAndRaytracevoidoutput neural network to vector graphics and raytrace

Function Arguments
nametypedescription
firstInputNeuronInNetworkANNneuron* first input neuron in network
addSprites const bool add sprites
allowRaytrace const bool allow raytrace
displayInOpenGL const bool display in open GL
useOutputLDRFile const bool use output LDRF ile
useOutputSVGFile const bool use output SVGF ile
useOutputPPMFile const bool use output PPMF ile
outputLDRFileName const string output LDRF ile name
outputSVGFileName const string output SVGF ile name
outputPPMFileName const string output PPMF ile name
outputPPMFileNameRaytraced const string output PPMF ile name raytraced
outputTALFileName const string output TALF ile name
width const int width
height const int height

Function Reference List


Function ANNdisplayClass::outputNeuralNetworkToVectorGraphicsAndRaytrace()

Function Summary
namereturn typedescription
outputNeuralNetworkToVectorGraphicsAndRaytracevoidoutput neural network to vector graphics and raytrace

Function Arguments
nametypedescription
firstInputNeuronInNetworkANNneuron* first input neuron in network
addSprites const bool add sprites
allowRaytrace const bool allow raytrace
displayInOpenGL const bool display in open GL
useOutputLDRFile const bool use output LDRF ile
useOutputSVGFile const bool use output SVGF ile
useOutputPPMFile const bool use output PPMF ile
outputLDRFileName const string output LDRF ile name
outputSVGFileName const string output SVGF ile name
outputPPMFileName const string output PPMF ile name
outputPPMFileNameRaytraced const string output PPMF ile name raytraced
outputTALFileName const string output TALF ile name
width const int width
height const int height
widthSVG const int width SVG
heightSVG const int height SVG

Function Reference List


File ANNxmlConversion Documentation

File Name: ANNxmlConversion.cpp/.hpp

File Description: ANN xml conversion

File Function List


File Diagram (functions hierarchy)


Function ANNxmlConversionClass::writeNetXMLfile()

Function Summary
namereturn typedescription
writeNetXMLfileboolwrite net XML file

Function Arguments
nametypedescription
xmlFileNamestring xml file name
firstInputNeuronInNetwork ANNneuron* first input neuron in network

Function Reference List


Function ANNxmlConversionClass::generateXMLtagListBasedUponSubnet()

Function Summary
namereturn typedescription
generateXMLtagListBasedUponSubnetboolgenerate XML tag list based upon subnet

Function Arguments
nametypedescription
firstTagInSubnetXMLparserTag* first tag in subnet
firstNeuronInSubnet ANNneuron* first neuron in subnet

Function Reference List


Function ANNxmlConversionClass::generateXMLtagListBasedUponLayer()

Function Summary
namereturn typedescription
generateXMLtagListBasedUponLayerboolgenerate XML tag list based upon layer

Function Arguments
nametypedescription
firstTagInSubnetXMLparserTag* first tag in subnet
firstNeuronInLayer ANNneuron* first neuron in layer

Function Reference List


Function ANNxmlConversionClass::resetPrintedXMLbasedUponLayer()

Function Summary
namereturn typedescription
resetPrintedXMLbasedUponLayerboolreset printed XML based upon layer

Function Arguments
nametypedescription
firstNeuronInLayerANNneuron* first neuron in layer

Function Reference List


Function ANNxmlConversionClass::readNetXMLfileAndRecordFormationVariables()

Function Summary
namereturn typedescription
readNetXMLfileAndRecordFormationVariablesANNneuron*read net XML file and record formation variables

Function Arguments
nametypedescription
xmlFileNamestring xml file name
firstInputNeuronInNetwork ANNneuron* first input neuron in network
numberOfInputNeurons int64_t* number of input neurons
numberOfOutputNeurons int64_t* number of output neurons
numberOfLayers int64_t* number of layers

Function Reference List


Function ANNxmlConversionClass::readNetXMLfile()

Function Summary
namereturn typedescription
readNetXMLfileboolread net XML file

Function Arguments
nametypedescription
xmlFileNamestring xml file name
firstInputNeuronInNetwork ANNneuron* first input neuron in network

Function Reference List


Function ANNxmlConversionClass::parseNetTag()

Function Summary
namereturn typedescription
parseNetTagboolparse net tag

Function Arguments
nametypedescription
firstTagInNetworkXMLparserTag* first tag in network
currentNeuron ANNneuron* current neuron

Function Reference List


Function ANNxmlConversionClass::parseSubnetTag()

Function Summary
namereturn typedescription
parseSubnetTagboolparse subnet tag

Function Arguments
nametypedescription
firstTagInSubnetXMLparserTag* first tag in subnet
firstNeuronInSubnet ANNneuron* first neuron in subnet
layerIDcounter int64_t layer ID counter
wrongAndNotUsedIDcounter int64_t* wrong and not used ID counter
subnetIDcounter int64_t subnet ID counter

Function Reference List


Function ANNxmlConversionClass::parseLayerTag()

Function Summary
namereturn typedescription
parseLayerTagboolparse layer tag

Function Arguments
nametypedescription
firstTagInLayerXMLparserTag* first tag in layer
firstNeuronInLayer ANNneuron* first neuron in layer
layerIDcounter int64_t layer ID counter
orderIDcounter int64_t order ID counter
wrongAndNotUsedIDcounter int64_t* wrong and not used ID counter
subnetIDcounter int64_t subnet ID counter

Function Reference List


Function ANNxmlConversionClass::parseNeuronContainerTag()

Function Summary
namereturn typedescription
parseNeuronContainerTagboolparse neuron container tag

Function Arguments
nametypedescription
firstTagInNeuronContainerXMLparserTag* first tag in neuron container
currentNeuron ANNneuron* current neuron
layerIDcounter int64_t layer ID counter
orderIDcounter int64_t order ID counter
wrongAndNotUsedIDcounter int64_t* wrong and not used ID counter
subnetIDcounter int64_t subnet ID counter

Function Reference List


Function ANNxmlConversionClass::parseNeuronTag()

Function Summary
namereturn typedescription
parseNeuronTagboolparse neuron tag

Function Arguments
nametypedescription
currentTagXMLparserTag* current tag
currentNeuron ANNneuron* current neuron
layerIDcounter int64_t layer ID counter
orderIDcounter int64_t order ID counter
wrongAndNotUsedIDcounter int64_t* wrong and not used ID counter
subnetIDcounter int64_t subnet ID counter

Function Reference List


Function ANNxmlConversionClass::parseForwardANNneuronConnectionsListTag()

Function Summary
namereturn typedescription
parseForwardANNneuronConnectionsListTagboolparse forward ANN neuron connections list tag

Function Arguments
nametypedescription
firstTagInForwardANNneuronConnectionsListXMLparserTag* first tag in forward ANN neuron connections list
currentNeuron ANNneuron* current neuron

Function Reference List


Function ANNxmlConversionClass::parseForwardANNneuronConnectionTag()

Function Summary
namereturn typedescription
parseForwardANNneuronConnectionTagboolparse forward ANN neuron connection tag

Function Arguments
nametypedescription
currentTagXMLparserTag* current tag
currentANNneuronConnection ANNneuronConnection* current ANN neuron connection

Function Reference List


Function ANNxmlConversionClass::linkLayerXNeuronsBasedUponFrontANNneuronConnectionListNeuronIDs()

Function Summary
namereturn typedescription
linkLayerXNeuronsBasedUponFrontANNneuronConnectionListNeuronIDsboollink layer XN eurons based upon front ANN neuron connection list neuron ID s

Function Arguments
nametypedescription
firstNeuronInLayerANNneuron* first neuron in layer
firstInputNeuronInNetwork ANNneuron* first input neuron in network
hasBackLayer bool has back layer
firstNeuronInBackLayer ANNneuron* first neuron in back layer

Function Reference List


Function ANNxmlConversionClass::findNeuron()

Function Summary
namereturn typedescription
findNeuronANNneuron*find neuron

Function Arguments
nametypedescription
firstNeuronInLayerANNneuron* first neuron in layer
neuronIDtoFind int64_t neuron ID to find
result bool* result

Function Reference List


Function ANNxmlConversionClass::recordOutputNeuronAndNumInputAndOutputNeuronsInNetwork()

Function Summary
namereturn typedescription
recordOutputNeuronAndNumInputAndOutputNeuronsInNetworkANNneuron*record output neuron and num input and output neurons in network

Function Arguments
nametypedescription
firstInputNeuronInNetworkANNneuron* first input neuron in network
numberOfInputNeurons int64_t* number of input neurons
numberOfOutputNeurons int64_t* number of output neurons
numberOfLayers int64_t* number of layers

Function Reference List
N/A


Function ANNxmlConversionClass::clearTag()

Function Summary
namereturn typedescription
clearTagvoidclear tag

Function Arguments
nametypedescription
tagXMLparserTag* tag

Function Reference List
N/A


File XMLparserClass Documentation

File Name: XMLparserClass.cpp/.hpp

File Description: XML parser class

File Function List


File Diagram (functions hierarchy)


Class XMLparserAttribute

Class Data
nametypedescription
namestringname
valuestringvalue
charCountintchar count
lineCountintline count
nextAttributeXMLparserAttribute*next attribute

Class XMLparserTag

Class Data
nametypedescription
namestringname
valuestringvalue
nextTagXMLparserTag*next tag
firstLowerLevelTagXMLparserTag*first lower level tag
charCountintchar count
lineCountintline count
firstAttributeXMLparserAttribute*first attribute
currentAttributeXMLparserAttribute*current attribute

Function XMLparserClassClass::parseTagDownALevel()

Function Summary
namereturn typedescription
parseTagDownALevelXMLparserTag*parse tag down AL evel

Function Arguments
nametypedescription
currentTagXMLparserTag* current tag
sectionTagName const string section tag name
result bool* result

Function Reference List
N/A


Function XMLparserClassClass::readXMLfile()

Function Summary
namereturn typedescription
readXMLfileboolread XML file

Function Arguments
nametypedescription
xmlFileNameconst string xml file name
firstTagInXMLfile XMLparserTag* first tag in XML file

Function Reference List


Function XMLparserClassClass::parseTagOpen()

Function Summary
namereturn typedescription
parseTagOpenboolparse tag open

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer int tree layer

Function Reference List


Function XMLparserClassClass::parseTagName()

Function Summary
namereturn typedescription
parseTagNameboolparse tag name

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer int tree layer

Function Reference List


Function XMLparserClassClass::parseTagAttributeName()

Function Summary
namereturn typedescription
parseTagAttributeNameboolparse tag attribute name

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer int tree layer

Function Reference List


Function XMLparserClassClass::parseTagAttributeValue()

Function Summary
namereturn typedescription
parseTagAttributeValueboolparse tag attribute value

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer const int tree layer

Function Reference List


Function XMLparserClassClass::parseTagValueAssumingExistenceOfSubtagsAndClose()

Function Summary
namereturn typedescription
parseTagValueAssumingExistenceOfSubtagsAndCloseboolparse tag value assuming existence of subtags and close

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
treeLayer int tree layer

Function Reference List


Function XMLparserClassClass::parseTagComment()

Function Summary
namereturn typedescription
parseTagCommentboolparse tag comment

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
type const char type

Function Reference List


Function XMLparserClassClass::processTagClose()

Function Summary
namereturn typedescription
processTagCloseboolprocess tag close

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag** current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer int tree layer
endTagFound const bool end tag found
parsingAttributeName const bool parsing attribute name
tagName const string tag name

Function Reference List


Function XMLparserClassClass::createNewTag()

Function Summary
namereturn typedescription
createNewTagXMLparserTag*create new tag

Function Arguments
nametypedescription
currentTagXMLparserTag* current tag

Function Reference List
N/A


Function XMLparserClassClass::isBlankChar()

Function Summary
namereturn typedescription
isBlankCharboolis blank char

Function Arguments
nametypedescription
parseFileObjectconst ifstream* parse file object
c const char c

Function Reference List
N/A


Function XMLparserClassClass::isBlankCharTabOrNewLine()

Function Summary
namereturn typedescription
isBlankCharTabOrNewLineboolis blank char tab or new line

Function Arguments
nametypedescription
parseFileObjectconst ifstream* parse file object
c const char c

Function Reference List
N/A


Function XMLparserClassClass::throwGenericXMLParseError()

Function Summary
namereturn typedescription
throwGenericXMLParseErrorvoidthrow generic XMLP arse error

Function Reference List
N/A


Function XMLparserClassClass::createNewAttribute()

Function Summary
namereturn typedescription
createNewAttributeXMLparserAttribute*create new attribute

Function Arguments
nametypedescription
currentAttributeXMLparserAttribute* current attribute

Function Reference List
N/A


Function XMLparserClassClass::writeXMLHeader()

Function Summary
namereturn typedescription
writeXMLHeadervoidwrite XMLH eader

Function Arguments
nametypedescription
writeFileStringstring* write file string

Function Reference List
N/A


Function XMLparserClassClass::writeXMLfile()

Function Summary
namereturn typedescription
writeXMLfileboolwrite XML file

Function Arguments
nametypedescription
xmlFileNameconst string xml file name
firstTagInXMLfile const XMLparserTag* first tag in XML file

Function Reference List


Function XMLparserClassClass::addTagLayerToFileObject()

Function Summary
namereturn typedescription
addTagLayerToFileObjectbooladd tag layer to file object

Function Arguments
nametypedescription
firstTagInCurrentLayerconst XMLparserTag* first tag in current layer
writeFileString string* write file string
treeLayer const int tree layer

Function Reference List


Function XMLparserClassClass::incrementLineAndAddTabsToFileObject()

Function Summary
namereturn typedescription
incrementLineAndAddTabsToFileObjectvoidincrement line and add tabs to file object

Function Arguments
nametypedescription
writeFileStringstring* write file string
treeLayer const int tree layer

Function Reference List
N/A


Function XMLparserClassClass::addTabsToFileObject()

Function Summary
namereturn typedescription
addTabsToFileObjectvoidadd tabs to file object

Function Arguments
nametypedescription
writeFileStringstring* write file string
treeLayer const int tree layer

Function Reference List
N/A


File ANNdraw Documentation

File Name: ANNdraw.cpp/.hpp

File Description: ANN draw

File Function List


File Diagram (functions hierarchy)


Function ANNdrawClass::fillInANNSpriteExternVariables()

Function Summary
namereturn typedescription
fillInANNSpriteExternVariablesvoidfill in ANNS prite extern variables

Function Reference List


Function ANNdrawClass::ANNcreateNeuralNetworkReferenceLists()

Function Summary
namereturn typedescription
ANNcreateNeuralNetworkReferenceListsboolANN create neural network reference lists

Function Arguments
nametypedescription
sceneFileNamestring scene file name
initialReference LDreference* initial reference
firstNeuronInNetwork ANNneuron* first neuron in network
addSprites bool add sprites
numSpritesAdded int* num sprites added
writeSVG bool write SVG
currentTagSVG XMLparserTag** current tag SVG
writeLDR bool write LDR

Function Reference List


Function ANNdrawClass::ANNcreateNeuralNetworkSceneFilesFromReferenceLists()

Function Summary
namereturn typedescription
ANNcreateNeuralNetworkSceneFilesFromReferenceListsboolANN create neural network scene files from reference lists

Function Arguments
nametypedescription
sceneFileNamestring scene file name
addSprites bool add sprites
initialReference LDreference* initial reference
numSpritesAdded int num sprites added

Function Reference List


Function ANNdrawClass::ANNsearchNeuralNetworkAndCreateReferences()

Function Summary
namereturn typedescription
ANNsearchNeuralNetworkAndCreateReferencesLDreference*ANN search neural network and create references

Function Arguments
nametypedescription
firstNeuronInLayerANNneuron* first neuron in layer
currentListReference LDreference* current list reference
eyeCoords vec* eye coords
numSpritesAdded int* num sprites added
sceneFileName string scene file name
isSubnet bool is subnet
positionOfSubnetNeuron vec* position of subnet neuron
addSprites bool add sprites
writeSVG bool write SVG
currentTagSVG XMLparserTag** current tag SVG
writeLDR bool write LDR

Function Reference List


Function ANNdrawClass::ANNsearchNeuralNetworkAndCreateReferencesReset()

Function Summary
namereturn typedescription
ANNsearchNeuralNetworkAndCreateReferencesResetvoidANN search neural network and create references reset

Function Arguments
nametypedescription
firstNeuronInLayerANNneuron* first neuron in layer

Function Reference List


Function ANNdrawClass::ANNfillNeuronDisplayReference()

Function Summary
namereturn typedescription
ANNfillNeuronDisplayReferenceboolANN fill neuron display reference

Function Arguments
nametypedescription
currentNeuronDispayReferenceLDreference* current neuron dispay reference
neuron ANNneuron* neuron
hasSubnetNeuron bool has subnet neuron
positionOfsubnetNeuron vec* position ofsubnet neuron
writeSVG bool write SVG
currentTagSVG XMLparserTag** current tag SVG

Function Reference List


Function ANNdrawClass::ANNfillANNneuronConnectionDisplayReference()

Function Summary
namereturn typedescription
ANNfillANNneuronConnectionDisplayReferenceboolANN fill ANN neuron connection display reference

Function Arguments
nametypedescription
currentNeuronDispayReferenceLDreference* current neuron dispay reference
backNeuronReference LDreference* back neuron reference
forwardNeuronReference LDreference* forward neuron reference
ANNneuronConnection ANNneuronConnection* ANN neuron connection
writeSVG bool write SVG
currentTagSVG XMLparserTag** current tag SVG

Function Reference List


Function ANNdrawClass::ANNdetermineSpriteInfoForNeuronAndAddSpriteToSpriteRefList()

Function Summary
namereturn typedescription
ANNdetermineSpriteInfoForNeuronAndAddSpriteToSpriteRefListboolANN determine sprite info for neuron and add sprite to sprite ref list

Function Arguments
nametypedescription
neuronANNneuron* neuron
currentListReference LDreference** current list reference
eyeCoords vec* eye coords
numSpritesAdded int* num sprites added
sceneFileName string scene file name
neuronReferenceRelativePosition vec* neuron reference relative position
writeSVG bool write SVG
currentTagSVG XMLparserTag** current tag SVG
writeLDR bool write LDR

Function Reference List


Function ANNdrawClass::ANNdetermineSpriteInfoForANNneuronConnectionAndAddSpriteToSpriteRefList()

Function Summary
namereturn typedescription
ANNdetermineSpriteInfoForANNneuronConnectionAndAddSpriteToSpriteRefListboolANN determine sprite info for ANN neuron connection and add sprite to sprite ref list

Function Arguments
nametypedescription
ANNneuronConnectionANNneuronConnection* ANN neuron connection
currentListReference LDreference** current list reference
eyeCoords vec* eye coords
numSpritesAdded int* num sprites added
sceneFileName string scene file name
backNeuronReferenceRelativePosition vec* back neuron reference relative position
forwardNeuronReferenceRelativePosition vec* forward neuron reference relative position
writeSVG bool write SVG
currentTagSVG XMLparserTag** current tag SVG
writeLDR bool write LDR

Function Reference List


Function ANNdrawClass::ANNaddSpriteToSpriteReferenceList()

Function Summary
namereturn typedescription
ANNaddSpriteToSpriteReferenceListboolANN add sprite to sprite reference list

Function Arguments
nametypedescription
spriteSceneCoordsvec* sprite scene coords
eyeCoords vec* eye coords
currentListReference LDreference** current list reference
spriteReferenceFileName string sprite reference file name
spriteDefaultColour int sprite default colour
spriteScaleFactor double sprite scale factor

Function Reference List


Function ANNdrawClass::writeSpriteTextToSVG()

Function Summary
namereturn typedescription
writeSpriteTextToSVGvoidwrite sprite text to SVG

Function Arguments
nametypedescription
spriteTextStringstring* sprite text string
writeSVG bool write SVG
currentTagSVG XMLparserTag** current tag SVG
referencePosition vec* reference position

Function Reference List


Function ANNdrawClass::ANNgenerateTextualNeuronSpriteInfoString()

Function Summary
namereturn typedescription
ANNgenerateTextualNeuronSpriteInfoStringvoidANN generate textual neuron sprite info string

Function Arguments
nametypedescription
neuronANNneuron* neuron
spriteTextString string* sprite text string
spriteColourArray[] int sprite colour array []

Function Reference List


Function ANNdrawClass::ANNgenerateTextualANNneuronConnectionSpriteInfoString()

Function Summary
namereturn typedescription
ANNgenerateTextualANNneuronConnectionSpriteInfoStringvoidANN generate textual ANN neuron connection sprite info string

Function Arguments
nametypedescription
ANNneuronConnectionANNneuronConnection* ANN neuron connection
spriteTextString string* sprite text string
spriteColourArray[] int sprite colour array []

Function Reference List


Function ANNdrawClass::convertDoubleToRainbow()

Function Summary
namereturn typedescription
convertDoubleToRainbowcolourconvert double to rainbow

Function Arguments
nametypedescription
colourDoubleconst double colour double
doubleMaxValue const double double max value

Function Reference List


Function ANNdrawClass::convertDoubleToRainbow()

Function Summary
namereturn typedescription
convertDoubleToRainbowcolourconvert double to rainbow

Function Arguments
nametypedescription
fconst double f

Function Reference List
N/A


File LDreferenceClass Documentation

File Name: LDreferenceClass.cpp/.hpp

File Description: LD reference class

File Function List


File Diagram (functions hierarchy)


Class LDreference

Class Data
nametypedescription
relativePositionvecrelative position
absolutePositionvecabsolute position
deformationMatrixmatdeformation matrix
absoluteDeformationMatrixmatabsolute deformation matrix
colouruint32_tcolour
namestringname
nextLDreference*next
vertex1relativePositionvecvertex 1relative position
vertex2relativePositionvecvertex 2relative position
vertex3relativePositionvecvertex 3relative position
vertex4relativePositionvecvertex 4relative position
vertex1absolutePositionvecvertex 1absolute position
vertex2absolutePositionvecvertex 2absolute position
vertex3absolutePositionvecvertex 3absolute position
vertex4absolutePositionvecvertex 4absolute position
relativeColourStringstringrelative colour string
isTopLevelboolis top level
intermediatePositionvecintermediate position
intermediateDeformationMatrixmatintermediate deformation matrix
vertex1intermediatePositionvecvertex 1intermediate position
vertex2intermediatePositionvecvertex 2intermediate position
vertex3intermediatePositionvecvertex 3intermediate position
vertex4intermediatePositionvecvertex 4intermediate position
partAdditionalboolpart additional
partModifiedboolpart modified
partDeletedboolpart deleted
vertex1absolutePositionBackupvecvertex 1absolute position backup
vertex2absolutePositionBackupvecvertex 2absolute position backup
vertex3absolutePositionBackupvecvertex 3absolute position backup
vertex4absolutePositionBackupvecvertex 4absolute position backup
referenceEnabledMethod2DODboolreference enabled method 2DOD
typeinttype
absoluteColouruint32_tabsolute colour
isSubModelReferenceboolis sub model reference
subModelDetailsModelDetails*sub model details
firstReferenceWithinSubModelLDreference*first reference within sub model

Function LDreferenceClassClass::convertLdrawColourToDatFileRGB()

Function Summary
namereturn typedescription
convertLdrawColourToDatFileRGBvoidconvert ldraw colour to dat file RGB

Function Arguments
nametypedescription
dataFileColourconst int data file colour
col colour* col

Function Reference List
N/A


File LDsprite Documentation

File Name: LDsprite.cpp/.hpp

File Description: LD sprite

File Function List


File Diagram (functions hierarchy)


Function LDspriteClass::fillInLDspriteExternVariables()

Function Summary
namereturn typedescription
fillInLDspriteExternVariablesvoidfill in LD sprite extern variables

Function Reference List
N/A


Function LDspriteClass::LDcreateSpriteReferenceName()

Function Summary
namereturn typedescription
LDcreateSpriteReferenceNamestringLD create sprite reference name

Function Arguments
nametypedescription
spriteIndexconst int sprite index
sceneFileName string scene file name

Function Reference List


Function LDspriteClass::LDaddTextualSpriteInfoStringToReferenceList()

Function Summary
namereturn typedescription
LDaddTextualSpriteInfoStringToReferenceListLDreference*LD add textual sprite info string to reference list

Function Arguments
nametypedescription
unitReferenceLDreference* unit reference
spriteTextString string sprite text string
spriteColourArray[] int sprite colour array []
spriteSubmodelInitialReference LDreference* sprite submodel initial reference
spriteNumberOfLines const int sprite number of lines
numSpritesAdded int* num sprites added
addIndividualSprites const bool add individual sprites

Function Reference List


Function LDspriteClass::LDspriteSubmodelFillTextualReference()

Function Summary
namereturn typedescription
LDspriteSubmodelFillTextualReferencevoidLD sprite submodel fill textual reference

Function Arguments
nametypedescription
spriteSubmodelCurrentReferenceLDreference* sprite submodel current reference
spriteParagraphCurrentPosition vec* sprite paragraph current position
characterToWrite const char character to write
spriteColour int sprite colour
scale double scale

Function Reference List


File LDreferenceManipulation Documentation

File Name: LDreferenceManipulation.cpp/.hpp

File Description: LD reference manipulation

File Function List


File Diagram (functions hierarchy)


Function LDreferenceManipulationClass::copyReferences()

Function Summary
namereturn typedescription
copyReferencesvoidcopy references

Function Arguments
nametypedescription
referenceNewLDreference* reference new
referenceToCopy LDreference* reference to copy
type const int type

Function Reference List


Function LDreferenceManipulationClass::convertPositionCoordinatesToString()

Function Summary
namereturn typedescription
convertPositionCoordinatesToStringstringconvert position coordinates to string

Function Arguments
nametypedescription
spriteSceneCoordsconst vec* sprite scene coords

Function Reference List


Function LDreferenceManipulationClass::writeReferencesToFile()

Function Summary
namereturn typedescription
writeReferencesToFileboolwrite references to file

Function Arguments
nametypedescription
fileNameconst string file name
firstReference LDreference* first reference

Function Reference List


Function LDreferenceManipulationClass::addReferenceToFileObject()

Function Summary
namereturn typedescription
addReferenceToFileObjectbooladd reference to file object

Function Arguments
nametypedescription
writeFileObjectofstream* write file object
currentReference LDreference* current reference

Function Reference List


Function LDreferenceManipulationClass::convertRotationMatrixToString()

Function Summary
namereturn typedescription
convertRotationMatrixToStringstringconvert rotation matrix to string

Function Arguments
nametypedescription
rotationMatrixconst mat* rotation matrix

Function Reference List


Function LDreferenceManipulationClass::write2DreferenceListCollapsedTo1DtoFile()

Function Summary
namereturn typedescription
write2DreferenceListCollapsedTo1DtoFileboolwrite 2D reference list collapsed to 1D to file

Function Arguments
nametypedescription
fileNameconst string file name
firstReference LDreference* first reference

Function Reference List


Function LDreferenceManipulationClass::write2DreferencesLayerToFileObject()

Function Summary
namereturn typedescription
write2DreferencesLayerToFileObjectboolwrite 2D references layer to file object

Function Arguments
nametypedescription
writeFileObjectofstream* write file object
firstReferenceInLayer LDreference* first reference in layer

Function Reference List


File SHAREDvector Documentation

File Name: SHAREDvector.cpp/.hpp

File Description: SHARED vector

File Function List


File Diagram (functions hierarchy)


Function SHAREDvectorClass::calculateRotationVectorFromDeformationMatrix()

Function Summary
namereturn typedescription
calculateRotationVectorFromDeformationMatrixvoidcalculate rotation vector from deformation matrix

Function Arguments
nametypedescription
deformationMatrixmat* deformation matrix
rotationVector vec* rotation vector

Function Reference List
N/A


Function SHAREDvectorClass::subtractVectorsRT()

Function Summary
namereturn typedescription
subtractVectorsRTvoidsubtract vectors RT

Function Arguments
nametypedescription
vect1const vec* vect 1
vect2 const vec* vect 2
vect vec* vect

Function Reference List
N/A


Function SHAREDvectorClass::addVectorsRT()

Function Summary
namereturn typedescription
addVectorsRTvoidadd vectors RT

Function Arguments
nametypedescription
vect1const vec* vect 1
vect2 const vec* vect 2
vect vec* vect

Function Reference List
N/A


Function SHAREDvectorClass::multiplyVectorByScalarRT()

Function Summary
namereturn typedescription
multiplyVectorByScalarRTvoidmultiply vector by scalar RT

Function Arguments
nametypedescription
vect1const vec* vect 1
multiplyer const double multiplyer
vect vec* vect

Function Reference List
N/A


Function SHAREDvectorClass::copyVectorRT()

Function Summary
namereturn typedescription
copyVectorRTvoidcopy vector RT

Function Arguments
nametypedescription
vecNewvec* vec new
vecToCopy const vec* vec to copy

Function Reference List
N/A


Function SHAREDvectorClass::normaliseVector()

Function Summary
namereturn typedescription
normaliseVectorvoidnormalise vector

Function Arguments
nametypedescription
vect1vec* vect 1

Function Reference List


Function SHAREDvectorClass::negativeVector()

Function Summary
namereturn typedescription
negativeVectorvoidnegative vector

Function Arguments
nametypedescription
vect1vec* vect 1
vect vec* vect

Function Reference List
N/A


Function SHAREDvectorClass::dotProduct()

Function Summary
namereturn typedescription
dotProductdoubledot product

Function Arguments
nametypedescription
vect1const vec* vect 1
vect2 const vec* vect 2

Function Reference List
N/A


Function SHAREDvectorClass::crossProduct()

Function Summary
namereturn typedescription
crossProductvoidcross product

Function Arguments
nametypedescription
vect1vec* vect 1
vect2 vec* vect 2
vect vec* vect

Function Reference List
N/A


Function SHAREDvectorClass::makeMatrix()

Function Summary
namereturn typedescription
makeMatrixvoidmake matrix

Function Arguments
nametypedescription
vect1vec* vect 1
vect2 vec* vect 2
vect3 vec* vect 3
matx mat* matx

Function Reference List
N/A


Function SHAREDvectorClass::multMatrixByVector()

Function Summary
namereturn typedescription
multMatrixByVectorvoidmult matrix by vector

Function Arguments
nametypedescription
matxmat* matx
vect1 vec* vect 1
vect vec* vect

Function Reference List
N/A


Function SHAREDvectorClass::createVector()

Function Summary
namereturn typedescription
createVectorvoidcreate vector

Function Arguments
nametypedescription
vecvec* vec

Function Reference List
N/A


Function SHAREDvectorClass::findMagnitudeOfVector()

Function Summary
namereturn typedescription
findMagnitudeOfVectordoublefind magnitude of vector

Function Arguments
nametypedescription
vect1const vec* vect 1

Function Reference List
N/A


Function SHAREDvectorClass::copyVectors()

Function Summary
namereturn typedescription
copyVectorsvoidcopy vectors

Function Arguments
nametypedescription
vecNewvec* vec new
vecToCopy const vec* vec to copy

Function Reference List
N/A


Function SHAREDvectorClass::copyMatricies()

Function Summary
namereturn typedescription
copyMatriciesvoidcopy matricies

Function Arguments
nametypedescription
matNewmat* mat new
matToCopy const mat* mat to copy

Function Reference List


Function SHAREDvectorClass::multiplyMatricies()

Function Summary
namereturn typedescription
multiplyMatriciesvoidmultiply matricies

Function Arguments
nametypedescription
matNewmat* mat new
mat1 mat* mat 1
mat2 mat* mat 2

Function Reference List
N/A


Function SHAREDvectorClass::addVectors()

Function Summary
namereturn typedescription
addVectorsvoidadd vectors

Function Arguments
nametypedescription
vecNewvec* vec new
a vec* a
b vec* b

Function Reference List
N/A


Function SHAREDvectorClass::createIdentityMatrix()

Function Summary
namereturn typedescription
createIdentityMatrixvoidcreate identity matrix

Function Arguments
nametypedescription
matrixmat* matrix

Function Reference List
N/A


Function SHAREDvectorClass::copyMatrixTwoIntoMatrixOne()

Function Summary
namereturn typedescription
copyMatrixTwoIntoMatrixOnevoidcopy matrix two into matrix one

Function Arguments
nametypedescription
mat1mat* mat 1
mat2 mat* mat 2

Function Reference List
N/A


Function SHAREDvectorClass::scaleMatrix()

Function Summary
namereturn typedescription
scaleMatrixvoidscale matrix

Function Arguments
nametypedescription
matrixmat* matrix
scaleFactor double scale factor

Function Reference List
N/A


Function SHAREDvectorClass::find2DintersectionPoint()

Function Summary
namereturn typedescription
find2DintersectionPointvoidfind 2D intersection point

Function Arguments
nametypedescription
axdouble ax
ay double ay
bx double bx
by double by
cx const double cx
cy const double cy
dx const double dx
dy const double dy
intersectionX double* intersection X
intersectionY double* intersection Y
interceptionFound bool* interception found
interceptionPointFound bool* interception point found

Function Reference List


Function SHAREDvectorClass::calcDistanceBetweenTwoPoints2D()

Function Summary
namereturn typedescription
calcDistanceBetweenTwoPoints2Ddoublecalc distance between two points 2D

Function Arguments
nametypedescription
x1const double x1
y1 const double y1
x2 const double x2
y2 const double y2

Function Reference List
N/A


Function SHAREDvectorClass::solve2DlineEquationWithTwoPoints()

Function Summary
namereturn typedescription
solve2DlineEquationWithTwoPointsboolsolve 2D line equation with two points

Function Arguments
nametypedescription
x1double x1
y1 double y1
x2 const double x2
y2 const double y2
m double* m
i double* i

Function Reference List
N/A


Function SHAREDvectorClass::find2DintersectionPointOfTwoLines()

Function Summary
namereturn typedescription
find2DintersectionPointOfTwoLinesboolfind 2D intersection point of two lines

Function Arguments
nametypedescription
m1double m1
i1 double i1
m2 const double m2
i2 const double i2
xIntersection double* xIntersection
yIntersection double* yIntersection

Function Reference List
N/A


Function SHAREDvectorClass::twoPointsAreTheSame2D()

Function Summary
namereturn typedescription
twoPointsAreTheSame2Dbooltwo points are the same 2D

Function Arguments
nametypedescription
x1const double x1
y1 const double y1
x2 const double x2
y2 const double y2

Function Reference List


Function SHAREDvectorClass::determineIfPointLiesOnAKnownLine2D()

Function Summary
namereturn typedescription
determineIfPointLiesOnAKnownLine2Dbooldetermine if point lies on AK nown line 2D

Function Arguments
nametypedescription
m1const double m1
i1 const double i1
x3 const double x3
y3 const double y3

Function Reference List


Function SHAREDvectorClass::compareDoublesRelaxed()

Function Summary
namereturn typedescription
compareDoublesRelaxedboolcompare doubles relaxed

Function Arguments
nametypedescription
aconst double a
b const double b

Function Reference List
N/A


Function SHAREDvectorClass::determineIfPointLiesOnAKnownLine2Drelaxed()

Function Summary
namereturn typedescription
determineIfPointLiesOnAKnownLine2Drelaxedbooldetermine if point lies on AK nown line 2D relaxed

Function Arguments
nametypedescription
m1const double m1
i1 const double i1
x3 const double x3
y3 const double y3

Function Reference List


Function SHAREDvectorClass::twoPointsAreTheSame2Drelaxed()

Function Summary
namereturn typedescription
twoPointsAreTheSame2Drelaxedbooltwo points are the same 2D relaxed

Function Arguments
nametypedescription
x1const double x1
y1 const double y1
x2 const double x2
y2 const double y2

Function Reference List


File XMLrulesClass Documentation

File Name: XMLrulesClass.cpp/.hpp

File Description: XML rules class

File Function List


File Diagram (functions hierarchy)


Class XMLrulesClass

Class Data
nametypedescription
namestringname
stringValuestringstring value
fractionalValuedoublefractional value
attribute4intattribute 4
attribute5intattribute 5
attribute6intattribute 6
attribute7intattribute 7
attribute8intattribute 8
nextXMLrulesClass*next

Function XMLrulesClassClass::parseANNrulesXMLfile()

Function Summary
namereturn typedescription
parseANNrulesXMLfileboolparse ANN rules XML file

Function Reference List


Function XMLrulesClassClass::parseANNrulesTag()

Function Summary
namereturn typedescription
parseANNrulesTagboolparse ANN rules tag

Function Arguments
nametypedescription
currentTagXMLparserTag* current tag

Function Reference List


Function XMLrulesClassClass::addRulesClassObjectsBasedOnSectionTag()

Function Summary
namereturn typedescription
addRulesClassObjectsBasedOnSectionTagbooladd rules class objects based on section tag

Function Arguments
nametypedescription
currentTagXMLparserTag* current tag
sectionTagName const string section tag name
firstReferenceToObjectClass XMLrulesClass* first reference to object class
tagName const string tag name
numberOfAttributes const int number of attributes
attributeName1 const string attribute name 1
attributeName2 const string attribute name 2
attributeName3 const string attribute name 3
attributeName4 const string attribute name 4
attributeName5 const string attribute name 5
attributeName6 const string attribute name 6
attributeName7 const string attribute name 7
attributeName8 const string attribute name 8

Function Reference List


Function XMLrulesClassClass::addRulesClassObjectBasedOnTag()

Function Summary
namereturn typedescription
addRulesClassObjectBasedOnTagbooladd rules class object based on tag

Function Arguments
nametypedescription
currentTagXMLparserTag* current tag
currentReferenceToObjectClass XMLrulesClass* current reference to object class
tagName const string tag name
numberOfAttributes const int number of attributes
attributeName1 const string attribute name 1
attributeName2 const string attribute name 2
attributeName3 const string attribute name 3
attributeName4 const string attribute name 4
attributeName5 const string attribute name 5
attributeName6 const string attribute name 6
attributeName7 const string attribute name 7
attributeName8 const string attribute name 8

Function Reference List


File LDsvg Documentation

File Name: LDsvg.cpp/.hpp

File Description: LD svg

File Function List


File Diagram (functions hierarchy)


Function LDsvgClass::writeSVGfile()

Function Summary
namereturn typedescription
writeSVGfileboolwrite SVG file

Function Arguments
nametypedescription
writeFileStringstring* write file string
firstTagInXMLfile const XMLparserTag* first tag in XML file
viewBoxMinX const int view box min X
viewBoxMaxX const int view box max X
viewBoxMinY const int view box min Y
viewBoxMaxY const int view box max Y

Function Reference List


Function LDsvgClass::writeSVGheader()

Function Summary
namereturn typedescription
writeSVGheadervoidwrite SVG header

Function Arguments
nametypedescription
writeFileStringstring* write file string
viewBoxMinX const int view box min X
viewBoxMaxX const int view box max X
viewBoxMinY const int view box min Y
viewBoxMaxY const int view box max Y

Function Reference List


Function LDsvgClass::writeSVGfooter()

Function Summary
namereturn typedescription
writeSVGfootervoidwrite SVG footer

Function Arguments
nametypedescription
writeFileStringstring* write file string

Function Reference List
N/A


Function LDsvgClass::writeSVGbox3()

Function Summary
namereturn typedescription
writeSVGbox3voidwrite SVG box 3

Function Arguments
nametypedescription
currentTagXMLparserTag** current tag
pos const vec* pos
width const double width
height const double height
colourrgb const colour colourrgb
boxOutlineWidth const double box outline width
useEllipse const bool use ellipse
transparent bool transparent
fillOpacity const double fill opacity

Function Reference List


Function LDsvgClass::writeSVGline()

Function Summary
namereturn typedescription
writeSVGlinevoidwrite SVG line

Function Arguments
nametypedescription
currentTagXMLparserTag** current tag
pos1 const vec* pos 1
pos2 const vec* pos 2
colourrgb const colour colourrgb

Function Reference List


Function LDsvgClass::writeSVGtext()

Function Summary
namereturn typedescription
writeSVGtextvoidwrite SVG text

Function Arguments
nametypedescription
currentTagXMLparserTag** current tag
text const string text
pos const vec* pos
fontSize const int font size
col const int col

Function Reference List


Function LDsvgClass::writeSVGtext()

Function Summary
namereturn typedescription
writeSVGtextvoidwrite SVG text

Function Arguments
nametypedescription
currentTagXMLparserTag** current tag
text const string text
pos const vec* pos
fontSize const int font size
col const int col
svgTinySpec bool svg tiny spec

Function Reference List


File LDparser Documentation

File Name: LDparser.cpp/.hpp

File Description: LD parser

File Function List


File Diagram (functions hierarchy)


Function LDparserClass::parseFile()

Function Summary
namereturn typedescription
parseFileboolparse file

Function Arguments
nametypedescription
parseFileNamestring parse file name
initialReference LDreference* initial reference
parentReference LDreference* parent reference
recurseIntoPartsDir const bool recurse into parts dir

Function Reference List


Function LDparserClass::calcModXPosBasedUponRotate()

Function Summary
namereturn typedescription
calcModXPosBasedUponRotatedoublecalc mod XP os based upon rotate

Function Arguments
nametypedescription
childRelativePositionconst vec* child relative position
parentReferenceDeformationMatrix const mat* parent reference deformation matrix

Function Reference List
N/A


Function LDparserClass::calcModYPosBasedUponRotate()

Function Summary
namereturn typedescription
calcModYPosBasedUponRotatedoublecalc mod YP os based upon rotate

Function Arguments
nametypedescription
childRelativePositionconst vec* child relative position
parentReferenceDeformationMatrix const mat* parent reference deformation matrix

Function Reference List
N/A


Function LDparserClass::calcModZPosBasedUponRotate()

Function Summary
namereturn typedescription
calcModZPosBasedUponRotatedoublecalc mod ZP os based upon rotate

Function Arguments
nametypedescription
childRelativePositionconst vec* child relative position
parentReferenceDeformationMatrix const mat* parent reference deformation matrix

Function Reference List
N/A


Function LDparserClass::removeWhiteSpaceFromString()

Function Summary
namereturn typedescription
removeWhiteSpaceFromStringstringremove white space from string

Function Arguments
nametypedescription
sconst string s

Function Reference List
N/A


File LDopengl Documentation

File Name: LDopengl.cpp/.hpp

File Description: LD opengl

File Function List


File Diagram (functions hierarchy)


Function LDopenglClass::initiateOpenGL()

Function Summary
namereturn typedescription
initiateOpenGLboolinitiate open GL

Function Arguments
nametypedescription
widthconst int width
height const int height
windowPositionX const int window position X
windowPositionY const int window position Y
confidentialWarnings const bool confidential warnings

Function Reference List
N/A


Function LDopenglClass::exitOpenGL()

Function Summary
namereturn typedescription
exitOpenGLboolexit open GL

Function Reference List
N/A


Function LDopenglClass::setViewPort3Dortho()

Function Summary
namereturn typedescription
setViewPort3Dorthovoidset view port 3D ortho

Function Arguments
nametypedescription
leftconst double left
right const double right
bottom const double bottom
top const double top
back const double back
forward const double forward

Function Reference List
N/A


Function LDopenglClass::drawPrimitivesReferenceListToOpenGLandCreateRGBmapBasic()

Function Summary
namereturn typedescription
drawPrimitivesReferenceListToOpenGLandCreateRGBmapBasicvoiddraw primitives reference list to open GL and create RGB map basic

Function Arguments
nametypedescription
firstReferenceInPrimitivesReferenceListconst LDreference* first reference in primitives reference list
width int width
height const int height
rgbMap uchar* rgb map

Function Reference List


Function LDopenglClass::writeScreenToRGBMap()

Function Summary
namereturn typedescription
writeScreenToRGBMapvoidwrite screen to RGBM ap

Function Arguments
nametypedescription
widthint width
height const int height
rgbMap uchar* rgb map

Function Reference List
N/A


File RTscene Documentation

File Name: RTscene.cpp/.hpp

File Description: RT scene

File Function List


File Diagram (functions hierarchy)


Class RTlightingInfo

Class Data
nametypedescription
lsRTlightSourcels
nextLightRTlightingInfo*next light

Function RTsceneClass::rayTraceScene()

Function Summary
namereturn typedescription
rayTraceSceneintray trace scene

Function Arguments
nametypedescription
talFileNameconst string tal file name
imageFileName string image file name
outputImageFiles const int output image files
setRGBAndDepthAndNormalAndPointMaps const int set RGBA nd depth and normal and point maps
rgbMap uchar* rgb map
depthMap double* depth map
normalMap double* normal map
pointMap double* point map

Function Reference List


Function RTsceneClass::rayTraceSceneWithoutParse()

Function Summary
namereturn typedescription
rayTraceSceneWithoutParseintray trace scene without parse

Function Arguments
nametypedescription
viRTviewInfo* vi
si RTsceneInfo* si
li const RTlightingInfo* li
imageFileName string image file name
outputImageFiles const int output image files
setRGBAndDepthAndNormalAndPointMaps const int set RGBA nd depth and normal and point maps
rgbMap uchar* rgb map
depthMap double* depth map
normalMap double* normal map
pointMap double* point map

Function Reference List


Function RTsceneClass::parseTalFileInitialiseParser()

Function Summary
namereturn typedescription
parseTalFileInitialiseParservoidparse tal file initialise parser

Function Arguments
nametypedescription
talFileNameconst string tal file name

Function Reference List


Function RTsceneClass::parseTalFileGetViewInfo()

Function Summary
namereturn typedescription
parseTalFileGetViewInfoRTviewInfo*parse tal file get view info

Function Arguments
nametypedescription
viRTviewInfo* vi

Function Reference List


Function RTsceneClass::parseTalFileGetLightInfo()

Function Summary
namereturn typedescription
parseTalFileGetLightInfoRTlightingInfo*parse tal file get light info

Function Arguments
nametypedescription
liRTlightingInfo* li

Function Reference List


Function RTsceneClass::parseTalFileGetSceneInfo()

Function Summary
namereturn typedescription
parseTalFileGetSceneInfoRTsceneInfo*parse tal file get scene info

Function Arguments
nametypedescription
siRTsceneInfo* si

Function Reference List


Function RTsceneClass::createImage()

Function Summary
namereturn typedescription
createImagevoidcreate image

Function Arguments
nametypedescription
setRGBAndDepthAndNormalAndPointMapsconst int set RGBA nd depth and normal and point maps
rgbMap uchar* rgb map
depthMap double* depth map
normalMap double* normal map
pointMap double* point map
vi RTviewInfo* vi
si RTsceneInfo* si
li const RTlightingInfo* li

Function Reference List


Function RTsceneClass::calculateTransparencyColour()

Function Summary
namereturn typedescription
calculateTransparencyColourvoidcalculate transparency colour

Function Arguments
nametypedescription
viconst RTviewInfo* vi
si const RTsceneInfo* si
li const RTlightingInfo* li
rgb colour* rgb

Function Reference List
N/A


Function RTsceneClass::calculateUVNScalars()

Function Summary
namereturn typedescription
calculateUVNScalarsvoidcalculate UVNS calars

Function Arguments
nametypedescription
viconst RTviewInfo* vi
uvn vec* uvn
x const int x
y const int y

Function Reference List
N/A


Function RTsceneClass::calculateAmbientDiffuseSpecular()

Function Summary
namereturn typedescription
calculateAmbientDiffuseSpecularvoidcalculate ambient diffuse specular

Function Arguments
nametypedescription
viRTviewInfo* vi
si const RTsceneInfo* si
li const RTlightingInfo* li
rgb colour* rgb
tAtSurface double* tAt surface
nAtSurface vec* nAt surface
pointAtSurface vec* point at surface

Function Reference List


Function RTsceneClass::calculateBasicColour()

Function Summary
namereturn typedescription
calculateBasicColourvoidcalculate basic colour

Function Arguments
nametypedescription
viconst RTviewInfo* vi
si const RTsceneInfo* si
li const RTlightingInfo* li
rgb colour* rgb
tAtSurface double* tAt surface
nAtSurface vec* nAt surface
pointAtSurface vec* point at surface

Function Reference List


Function RTsceneClass::stripExtension()

Function Summary
namereturn typedescription
stripExtensionboolstrip extension

Function Arguments
nametypedescription
filenameWithExtensionstring filename with extension
filenameWithoutExtension string* filename without extension

Function Reference List
N/A


Function RTsceneClass::addExtension()

Function Summary
namereturn typedescription
addExtensionbooladd extension

Function Arguments
nametypedescription
filenameWithoutExtensionstring filename without extension
extension string extension
filenameWithExtension string* filename with extension

Function Reference List
N/A


File RTraytracer Documentation

File Name: RTraytracer.cpp/.hpp

File Description: RT raytracer

File Function List


File Diagram (functions hierarchy)


Class RTsceneInfo

Class Data
nametypedescription
standardMatrixadvancedMatstandard matrix
reverseMatrixadvancedMatreverse matrix
piRTpieceInfopi
diRTdimensionsInfodi
tOutdoubletOut
nvecn
nextSceneRTsceneInfo*next scene

Function RTraytracerClass::rayTrace()

Function Summary
namereturn typedescription
rayTracevoidray trace

Function Arguments
nametypedescription
viconst RTviewInfo* vi
si RTsceneInfo* si
tildaMat mat* tilda mat
uvn vec* uvn

Function Reference List


Function RTraytracerClass::calculateCylinder()

Function Summary
namereturn typedescription
calculateCylindervoidcalculate cylinder

Function Arguments
nametypedescription
p0vec* p0
p1 vec* p1
tInOut double* tIn out
norm vec* norm
finalReverseMatrix advancedMat* final reverse matrix
relevantFinalReverseMatrix advancedMat* relevant final reverse matrix

Function Reference List


Function RTraytracerClass::calculateCube()

Function Summary
namereturn typedescription
calculateCubevoidcalculate cube

Function Arguments
nametypedescription
p0vec* p0
p1 vec* p1
tInOut double* tIn out
norm vec* norm
finalReverseMatrix advancedMat* final reverse matrix
relevantFinalReverseMatrix advancedMat* relevant final reverse matrix

Function Reference List


Function RTraytracerClass::calculateSphere()

Function Summary
namereturn typedescription
calculateSpherevoidcalculate sphere

Function Arguments
nametypedescription
p0vec* p0
p1 vec* p1
tInOut double* tIn out
norm vec* norm
finalReverseMatrix advancedMat* final reverse matrix
relevantFinalReverseMatrix advancedMat* relevant final reverse matrix

Function Reference List


Function RTraytracerClass::calculatePrimQuad()

Function Summary
namereturn typedescription
calculatePrimQuadvoidcalculate prim quad

Function Arguments
nametypedescription
p0vec* p0
p1 vec* p1
tInOut double* tIn out
pi const RTpieceInfo* pi
norm vec* norm
finalReverseMatrix advancedMat* final reverse matrix
relevantFinalReverseMatrix advancedMat* relevant final reverse matrix

Function Reference List


Function RTraytracerClass::calculatePrimTri()

Function Summary
namereturn typedescription
calculatePrimTrivoidcalculate prim tri

Function Arguments
nametypedescription
p0vec* p0
p1 vec* p1
tInOut double* tIn out
pi const RTpieceInfo* pi
norm vec* norm
finalReverseMatrix advancedMat* final reverse matrix
relevantFinalReverseMatrix advancedMat* relevant final reverse matrix

Function Reference List


Function RTraytracerClass::calculatePrimLine()

Function Summary
namereturn typedescription
calculatePrimLinevoidcalculate prim line

Function Arguments
nametypedescription
p0vec* p0
p1 vec* p1
tInOut double* tIn out
pi const RTpieceInfo* pi
norm const vec* norm
finalReverseMatrix advancedMat* final reverse matrix
relevantFinalReverseMatrix advancedMat* relevant final reverse matrix

Function Reference List


Function RTraytracerClass::drawPoint()

Function Summary
namereturn typedescription
drawPointvoiddraw point

Function Arguments
nametypedescription
siRTsceneInfo* si
reverseMatrix advancedMat* reverse matrix
tInDash double tIn dash
tOutDash double tOut dash
p0Dash vec* p0D ash
p1Dash vec* p1D ash
norm vec* norm

Function Reference List


Function RTraytracerClass::drawPointNoLighting()

Function Summary
namereturn typedescription
drawPointNoLightingvoiddraw point no lighting

Function Arguments
nametypedescription
siRTsceneInfo* si
reverseMatrix const advancedMat* reverse matrix
tIn double tIn
tOut double tOut
p0 const vec* p0
p1 const vec* p1
norm const vec* norm

Function Reference List
N/A


File RTparser Documentation

File Name: RTparser.cpp/.hpp

File Description: RT parser

File Function List


File Diagram (functions hierarchy)


Class RTlightSource

Class Data
nametypedescription
typelightTypetype
posvecpos
colcolourcol

Class RTpieceInfo

Class Data
nametypedescription
typepieceTypetype
colcolourcol
posvecpos
xrotdoublexrot
yrotdoubleyrot
zrotdoublezrot
vertex1Positionvecvertex 1P osition
vertex2Positionvecvertex 2P osition
vertex3Positionvecvertex 3P osition
vertex4Positionvecvertex 4P osition

Class RTdimensionsInfo

Class Data
nametypedescription
widthdoublewidth
lengthdoublelength
heightdoubleheight
translucentinttranslucent
transparencyinttransparency
is_invisibleintis _invisible

Class RTdecalInfo

Class Data
nametypedescription
widthdoublewidth
lengthdoublelength
filenamechar*filename
haveTransparentinthave transparent
transparentcolourcolourtransparentcolour

Class RTunknownInfo

Class Data
nametypedescription
commandStringchar*command string
param_countintparam _count
*paramschar**params

Function RTparserClass::initParser()

Function Summary
namereturn typedescription
initParservoidinit parser

Function Arguments
nametypedescription
fFILE* f

Function Reference List
N/A


Function RTparserClass::readViewport()

Function Summary
namereturn typedescription
readViewportintread viewport

Function Reference List
N/A


Function RTparserClass::get_view_info()

Function Summary
namereturn typedescription
get_view_infoRTviewInfo*get _view _info

Function Reference List
N/A


Function RTparserClass::nextLightSource()

Function Summary
namereturn typedescription
nextLightSourceintnext light source

Function Reference List
N/A


Function RTparserClass::get_light_info()

Function Summary
namereturn typedescription
get_light_infoRTlightSource*get _light _info

Function Reference List
N/A


Function RTparserClass::nextSceneCommand()

Function Summary
namereturn typedescription
nextSceneCommandintnext scene command

Function Reference List
N/A


Function RTparserClass::getPieceInfo()

Function Summary
namereturn typedescription
getPieceInfoRTpieceInfo*get piece info

Function Reference List
N/A


Function RTparserClass::getDimensionsInfo()

Function Summary
namereturn typedescription
getDimensionsInfoRTdimensionsInfo*get dimensions info

Function Reference List
N/A


Function RTparserClass::exitParser()

Function Summary
namereturn typedescription
exitParservoidexit parser

Function Reference List
N/A


File RToperations Documentation

File Name: RToperations.cpp/.hpp

File Description: RT operations

File Function List


File Diagram (functions hierarchy)


Function RToperationsClass::makeAdvancedMatrix()

Function Summary
namereturn typedescription
makeAdvancedMatrixvoidmake advanced matrix

Function Arguments
nametypedescription
matxAdvadvancedMat* matx adv
matx mat* matx
type int type

Function Reference List
N/A


Function RToperationsClass::multAdvancedMatrix()

Function Summary
namereturn typedescription
multAdvancedMatrixvoidmult advanced matrix

Function Arguments
nametypedescription
matxAdv1advancedMat* matx adv 1
matxAdv2 advancedMat* matx adv 2
matxAdv advancedMat* matx adv

Function Reference List
N/A


Function RToperationsClass::createIdentityMatrixAdvanced()

Function Summary
namereturn typedescription
createIdentityMatrixAdvancedvoidcreate identity matrix advanced

Function Arguments
nametypedescription
matxadvancedMat* matx

Function Reference List
N/A


Function RToperationsClass::createInverseTranslationMatrix()

Function Summary
namereturn typedescription
createInverseTranslationMatrixvoidcreate inverse translation matrix

Function Arguments
nametypedescription
xposdouble xpos
ypos double ypos
zpos double zpos
matx advancedMat* matx

Function Reference List


Function RToperationsClass::createTranslationMatrix()

Function Summary
namereturn typedescription
createTranslationMatrixvoidcreate translation matrix

Function Arguments
nametypedescription
xposdouble xpos
ypos double ypos
zpos double zpos
matx advancedMat* matx

Function Reference List


Function RToperationsClass::createScaleMatrix()

Function Summary
namereturn typedescription
createScaleMatrixvoidcreate scale matrix

Function Arguments
nametypedescription
widthdouble width
length double length
height double height
matx advancedMat* matx

Function Reference List


Function RToperationsClass::createInverseScaleMatrix()

Function Summary
namereturn typedescription
createInverseScaleMatrixvoidcreate inverse scale matrix

Function Arguments
nametypedescription
widthconst double width
length const double length
height const double height
matx advancedMat* matx

Function Reference List


Function RToperationsClass::createRotationxMatrix()

Function Summary
namereturn typedescription
createRotationxMatrixvoidcreate rotationx matrix

Function Arguments
nametypedescription
rotationdouble rotation
matx advancedMat* matx

Function Reference List


Function RToperationsClass::createInverseRotationxMatrix()

Function Summary
namereturn typedescription
createInverseRotationxMatrixvoidcreate inverse rotationx matrix

Function Arguments
nametypedescription
rotationdouble rotation
matx advancedMat* matx

Function Reference List


Function RToperationsClass::createRotationyMatrix()

Function Summary
namereturn typedescription
createRotationyMatrixvoidcreate rotationy matrix

Function Arguments
nametypedescription
rotationdouble rotation
matx advancedMat* matx

Function Reference List


Function RToperationsClass::createInverseRotationyMatrix()

Function Summary
namereturn typedescription
createInverseRotationyMatrixvoidcreate inverse rotationy matrix

Function Arguments
nametypedescription
rotationdouble rotation
matx advancedMat* matx

Function Reference List


Function RToperationsClass::createRotationzMatrix()

Function Summary
namereturn typedescription
createRotationzMatrixvoidcreate rotationz matrix

Function Arguments
nametypedescription
rotationdouble rotation
matx advancedMat* matx

Function Reference List


Function RToperationsClass::createInverseRotationzMatrix()

Function Summary
namereturn typedescription
createInverseRotationzMatrixvoidcreate inverse rotationz matrix

Function Arguments
nametypedescription
rotationdouble rotation
matx advancedMat* matx

Function Reference List


Function RToperationsClass::invertAdvancedMatrix()

Function Summary
namereturn typedescription
invertAdvancedMatrixvoidinvert advanced matrix

Function Arguments
nametypedescription
matxadvancedMat* matx

Function Reference List


Function RToperationsClass::transposeAdvancedMatrix()

Function Summary
namereturn typedescription
transposeAdvancedMatrixvoidtranspose advanced matrix

Function Arguments
nametypedescription
matxadvancedMat* matx

Function Reference List
N/A


Function RToperationsClass::multAdvancedMatrixByVector()

Function Summary
namereturn typedescription
multAdvancedMatrixByVectorvoidmult advanced matrix by vector

Function Arguments
nametypedescription
vecAdv1advancedVec* vec adv 1
matxAdv1 advancedMat* matx adv 1
vecAdv advancedVec* vec adv

Function Reference List
N/A


Function RToperationsClass::toRadians()

Function Summary
namereturn typedescription
toRadiansdoubleto radians

Function Arguments
nametypedescription
degreesconst double degrees

Function Reference List
N/A


Function RToperationsClass::toAdvancedVector()

Function Summary
namereturn typedescription
toAdvancedVectorvoidto advanced vector

Function Arguments
nametypedescription
vecvec* vec
type int type
vecAdv advancedVec* vec adv

Function Reference List
N/A


Function RToperationsClass::fromAdvancedVector()

Function Summary
namereturn typedescription
fromAdvancedVectorvoidfrom advanced vector

Function Arguments
nametypedescription
vecAdvadvancedVec* vec adv
vec vec* vec

Function Reference List
N/A


Function RToperationsClass::createAdvancedVector()

Function Summary
namereturn typedescription
createAdvancedVectorvoidcreate advanced vector

Function Arguments
nametypedescription
vecadvancedVec* vec

Function Reference List
N/A


Function RToperationsClass::findSmallestValue()

Function Summary
namereturn typedescription
findSmallestValuedoublefind smallest value

Function Arguments
nametypedescription
val1const double val 1
val2 const double val 2
val3 double val 3

Function Reference List
N/A


Function RToperationsClass::findGreatestValue()

Function Summary
namereturn typedescription
findGreatestValuedoublefind greatest value

Function Arguments
nametypedescription
val1const double val 1
val2 const double val 2
val3 double val 3

Function Reference List
N/A


Function RToperationsClass::findIntersectLineWithTri()

Function Summary
namereturn typedescription
findIntersectLineWithTriintfind intersect line with tri

Function Arguments
nametypedescription
pt1const vec* pt 1
pt2 const vec* pt 2
pt3 const vec* pt 3
linept1 vec* linept 1
linept2 vec* linept 2
pt_int vec* pt _int
norm vec* norm
t double* t

Function Reference List


Function RToperationsClass::checkSameClockDir()

Function Summary
namereturn typedescription
checkSameClockDirintcheck same clock dir

Function Arguments
nametypedescription
pt1const vec* pt 1
pt2 const vec* pt 2
pt3 const vec* pt 3
norm const vec* norm

Function Reference List
N/A


Function RToperationsClass::findIntersectLineWithLine()

Function Summary
namereturn typedescription
findIntersectLineWithLineintfind intersect line with line

Function Arguments
nametypedescription
linept1const vec* linept 1
linept2 const vec* linept 2
povpt1 vec* povpt 1
povpt2 vec* povpt 2
pt_int vec* pt _int
norm const vec* norm
t double* t

Function Reference List


Function RToperationsClass::findIntersectLineWithLine2D()

Function Summary
namereturn typedescription
findIntersectLineWithLine2Dboolfind intersect line with line 2D

Function Arguments
nametypedescription
povpt1const vec* povpt 1
povpt2 const vec* povpt 2
linept1 const vec* linept 1
linept2 const vec* linept 2
pt_int vec* pt _int

Function Reference List


Function RToperationsClass::findIntersectLineWithQuad()

Function Summary
namereturn typedescription
findIntersectLineWithQuadintfind intersect line with quad

Function Arguments
nametypedescription
pt1const vec* pt 1
pt2 const vec* pt 2
pt3 const vec* pt 3
pt4 const vec* pt 4
linept1 vec* linept 1
linept2 vec* linept 2
pt_int vec* pt _int
norm vec* norm
t double* t

Function Reference List


Function RToperationsClass::findPositionOfSmallestValueWhichHits()

Function Summary
namereturn typedescription
findPositionOfSmallestValueWhichHitsintfind position of smallest value which hits

Function Arguments
nametypedescription
arrayconst double* array
hitsArray const int* hits array
size const int size

Function Reference List
N/A


Function RToperationsClass::findPositionOfGreatestValueWhichHits()

Function Summary
namereturn typedescription
findPositionOfGreatestValueWhichHitsintfind position of greatest value which hits

Function Arguments
nametypedescription
arrayconst double* array
hitsArray const int* hits array
size const int size

Function Reference List
N/A


File RTpixelMaps Documentation

File Name: RTpixelMaps.cpp/.hpp

File Description: RT pixel maps

File Function List


File Diagram (functions hierarchy)


Function RTpixelMapsClass::getRGBMapValues()

Function Summary
namereturn typedescription
getRGBMapValuesvoidget RGBM ap values

Function Arguments
nametypedescription
xint x
y int y
imageWidth int image width
rgbMap uchar* rgb map
col colour* col

Function Reference List
N/A


Function RTpixelMapsClass::setRGBMapValues()

Function Summary
namereturn typedescription
setRGBMapValuesvoidset RGBM ap values

Function Arguments
nametypedescription
xconst int x
y const int y
imageWidth const int image width
col colour* col
rgbMap uchar* rgb map

Function Reference List
N/A


Function RTpixelMapsClass::setNormalMapValue()

Function Summary
namereturn typedescription
setNormalMapValuevoidset normal map value

Function Arguments
nametypedescription
xconst int x
y const int y
imageWidth const int image width
normalVal vec* normal val
normalMap double* normal map

Function Reference List


Function RTpixelMapsClass::getNormalMapValue()

Function Summary
namereturn typedescription
getNormalMapValuevoidget normal map value

Function Arguments
nametypedescription
xint x
y int y
imageWidth int image width
normalMap double* normal map
normalVal vec* normal val

Function Reference List


Function RTpixelMapsClass::setPointMapValue()

Function Summary
namereturn typedescription
setPointMapValuevoidset point map value

Function Arguments
nametypedescription
xconst int x
y const int y
imageWidth const int image width
pointVal vec* point val
pointMap double* point map

Function Reference List


Function RTpixelMapsClass::setVectorMapValue()

Function Summary
namereturn typedescription
setVectorMapValuevoidset vector map value

Function Arguments
nametypedescription
xconst int x
y const int y
imageWidth const int image width
vectorVal vec* vector val
vectorMap double* vector map

Function Reference List
N/A


Function RTpixelMapsClass::getVectorMapValue()

Function Summary
namereturn typedescription
getVectorMapValuevoidget vector map value

Function Arguments
nametypedescription
xint x
y int y
imageWidth int image width
vectorMap double* vector map
vectorVal vec* vector val

Function Reference List
N/A


Function RTpixelMapsClass::setLumOrContrastOrDepthMapValue()

Function Summary
namereturn typedescription
setLumOrContrastOrDepthMapValuevoidset lum or contrast or depth map value

Function Arguments
nametypedescription
xconst int x
y const int y
imageWidth const int image width
contrastVal double contrast val
contrastMap double* contrast map

Function Reference List
N/A


Function RTpixelMapsClass::getLumOrContrastOrDepthMapValue()

Function Summary
namereturn typedescription
getLumOrContrastOrDepthMapValuedoubleget lum or contrast or depth map value

Function Arguments
nametypedescription
xconst int x
y const int y
imageWidth const int image width
contrastMap const double* contrast map

Function Reference List
N/A


Function RTpixelMapsClass::generatePixmapFromRGBmap()

Function Summary
namereturn typedescription
generatePixmapFromRGBmapvoidgenerate pixmap from RGB map

Function Arguments
nametypedescription
imageFileNameconst string image file name
imageWidth int image width
imageHeight const int image height
rgbMap uchar* rgb map

Function Reference List


Function RTpixelMapsClass::writeImage()

Function Summary
namereturn typedescription
writeImagevoidwrite image

Function Arguments
nametypedescription
imageFileNameconst string image file name
pm pixmap* pm

Function Reference List


Function RTpixelMapsClass::fillInRTRulesExternVariables()

Function Summary
namereturn typedescription
fillInRTRulesExternVariablesvoidfill in RTR ules extern variables

Function Reference List
N/A


File RTppm Documentation

File Name: RTppm.cpp/.hpp

File Description: RT ppm

File Function List


File Diagram (functions hierarchy)


Function RTppmClass::placepointPPM()

Function Summary
namereturn typedescription
placepointPPMvoidplacepoint PPM

Function Arguments
nametypedescription
pmpixmap* pm
x const int x
y const int y
r int r
g int g
b int b

Function Reference List
N/A


Function RTppmClass::newPixmap()

Function Summary
namereturn typedescription
newPixmappixmap*new pixmap

Function Arguments
nametypedescription
wideconst int wide
high const int high

Function Reference List
N/A


Function RTppmClass::writePPM()

Function Summary
namereturn typedescription
writePPMvoidwrite PPM

Function Arguments
nametypedescription
fnameconst string fname
pm const pixmap* pm

Function Reference List
N/A


Function RTppmClass::freePixmap()

Function Summary
namereturn typedescription
freePixmapvoidfree pixmap

Function Arguments
nametypedescription
pmpixmap* pm

Function Reference List
N/A


File RTreferenceManipulation Documentation

File Name: RTreferenceManipulation.cpp/.hpp

File Description: RT reference manipulation

File Function List


File Diagram (functions hierarchy)


Function RTreferenceManipulationClass::write2DReferenceListCollapsedTo1DToFileRayTraceFormat()

Function Summary
namereturn typedescription
write2DReferenceListCollapsedTo1DToFileRayTraceFormatboolwrite 2DR eference list collapsed to 1DT o file ray trace format

Function Arguments
nametypedescription
fileNamestring file name
firstReference LDreference* first reference
useCustomViewInfo const bool use custom view info
vi const RTviewInfo* vi
useCustomLightSource const bool use custom light source
lightSourcePosition const vec* light source position
lightSourceColour const string light source colour

Function Reference List


Function RTreferenceManipulationClass::writeRayTraceFormatHeaderInfo()

Function Summary
namereturn typedescription
writeRayTraceFormatHeaderInfoboolwrite ray trace format header info

Function Arguments
nametypedescription
writeFileObjectofstream* write file object
useCustomViewInfo const bool use custom view info
vi const RTviewInfo* vi
useCustomLightSource const bool use custom light source
lightSourcePosition const vec* light source position
lightSourceColour const string light source colour

Function Reference List


Function RTreferenceManipulationClass::write2DReferencesLayerToFileObjectRayTraceFormat()

Function Summary
namereturn typedescription
write2DReferencesLayerToFileObjectRayTraceFormatboolwrite 2DR eferences layer to file object ray trace format

Function Arguments
nametypedescription
writeFileObjectofstream* write file object
firstReferenceInLayer LDreference* first reference in layer

Function Reference List


Function RTreferenceManipulationClass::addReferenceToFileObjectRayTraceFormat()

Function Summary
namereturn typedescription
addReferenceToFileObjectRayTraceFormatbooladd reference to file object ray trace format

Function Arguments
nametypedescription
writeFileObjectofstream* write file object
currentReference LDreference* current reference

Function Reference List


File ANNparser Documentation

File Name: ANNparser.cpp/.hpp

File Description: ANN parser

File Function List


File Diagram (functions hierarchy)


Function ANNparserClass::ANNparseDataFile()

Function Summary
namereturn typedescription
ANNparseDataFilevoidANN parse data file

Function Arguments
nametypedescription
nameOfExperiencesDataSetFilestring name of experiences data set file

Function Reference List