grail::EvaluationDebugData Class Reference

The EvaluationDebugData class - debug data describing singular evaluator. More...

#include <EvaluationDebugData.h>

Public Member Functions
	EvaluationDebugData (EvaluatorType evaluatorType, float score, std::size_t nodeIndex)
	EvaluationDebugData - constructor used when dumping debug data. More...
void	AddChildNode (std::size_t childNodeIndex)
	AddChildNode - add node as leaf/child to this data node. More...
EvaluatorType	GetEvaluatorType () const
	GetEvaluatorType - provides type of the evalutor described by this debug data. More...
float	GetScore () const
	GetScore - provides output of the evaluator descibed by this debug data. More...
std::size_t	GetNodeIndex () const
	GetNodeIndex - provides this nodes position in debug tree. More...
const std::vector< std::size_t > &	GetChildNodes () const
	GetChildNodes - provides indexes of all nodes attached to this node as children. More...
const std::string &	GetMetadata () const
	GetMetadata - provides a metadata string. More...
void	SetMetadata (const std::string &newMetadata)

Friends
struct	YAML::convert< EvaluationDebugData >

Detailed Description

The EvaluationDebugData class - debug data describing singular evaluator.

Constructor & Destructor Documentation

EvaluationDebugData()

grail::EvaluationDebugData::EvaluationDebugData	(	EvaluatorType	evaluatorType,
		float	score,
		std::size_t	nodeIndex
	)

EvaluationDebugData - constructor used when dumping debug data.

Parameters

evaluatorType	- type of evaluator which this data describes
score	- evaluator output
nodeIndex	- arbitrary node index, identifying data's position in debug tree

Member Function Documentation

AddChildNode()

void grail::EvaluationDebugData::AddChildNode

(

std::size_t

childNodeIndex

)

AddChildNode - add node as leaf/child to this data node.

Parameters

childNodeIndex

- node index of newly attached child

GetChildNodes()

const std::vector< std::size_t > & grail::EvaluationDebugData::GetChildNodes

(

)

const

GetChildNodes - provides indexes of all nodes attached to this node as children.

Returns

vector of indexes of all child nodes

GetEvaluatorType()

EvaluatorType grail::EvaluationDebugData::GetEvaluatorType

(

)

const

GetEvaluatorType - provides type of the evalutor described by this debug data.

Returns

evaluator type

GetMetadata()

const std::string & grail::EvaluationDebugData::GetMetadata

(

)

const

GetMetadata - provides a metadata string.

Returns

a string description of the evaluator's metadata

GetNodeIndex()

std::size_t grail::EvaluationDebugData::GetNodeIndex

(

)

const

GetNodeIndex - provides this nodes position in debug tree.

Returns

node index indetifying position in debug tree

GetScore()

float grail::EvaluationDebugData::GetScore

(

)

const

GetScore - provides output of the evaluator descibed by this debug data.

Returns

score - evaluator output

---

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

• GrailData/DebugInfo/EvaluationDebugData.h
• GrailData/DebugInfo/EvaluationDebugData.cpp