Graph::FMTPredictor Class Reference

Predictor gathering the source and target ages, yields, distances and disturbances of a graph transition, used to build the predictor variables of a machine learning yield model. More...

#include <FMTPredictor.h>

Public Member Functions
	FMTPredictor ()
	Default constructor for FMTPredictor.
	~FMTPredictor ()=default
	Default destructor for FMTPredictor.
	FMTPredictor (const std::vector< Core::FMTAction > &actions, const std::vector< std::string > &yieldnames, const Core::FMTYields &yields, const FMTBaseVertexProperties &source, const FMTBaseVertexProperties &target, const std::vector< const FMTBaseEdgeProperties * > &edges, const std::vector< int > &gaps, bool withGCBMid=true)
	Construct a FMTPredictor from the source and target vertices of a graph transition and the edges between them.
	FMTPredictor (const FMTPredictor &rhs)
	Copy constructor for FMTPredictor.
FMTPredictor &	operator= (const FMTPredictor &rhs)
	Copy assignment operator for FMTPredictor.
bool	operator== (const FMTPredictor &rhs) const
	Comparison operator for FMTPredictor.
bool	operator< (const FMTPredictor &rhs) const
	Less than operator for FMTPredictor.
std::vector< double >	getPredictors () const
	Return the predictor values.
double	getDistance (size_t actId) const
	Return the distance to an action.
double	getDisturbance (size_t actId) const
	Return the disturbance of an action.
double	getSourceAge () const
	Return the age of the source vertex.
std::vector< double >	getSourceYields () const
	Return the yields of the source vertex.
double	getTargetAge () const
	Return the age of the target vertex.
std::vector< double >	getTargetYields () const
	Return the yields of the target vertex.
std::vector< std::string >	getPredictorNames (const std::vector< std::string > &yieldnames) const
	Return the names of the predictors.

Detailed Description

Predictor gathering the source and target ages, yields, distances and disturbances of a graph transition, used to build the predictor variables of a machine learning yield model.

Constructor & Destructor Documentation

FMTPredictor() [1/3]

Graph::FMTPredictor::FMTPredictor

(

)

Default constructor for FMTPredictor.

~FMTPredictor()

Graph::FMTPredictor::~FMTPredictor ( )

default

Default destructor for FMTPredictor.

FMTPredictor() [2/3]

Graph::FMTPredictor::FMTPredictor	(	const std::vector< Core::FMTAction > &	actions,
		const std::vector< std::string > &	yieldnames,
		const Core::FMTYields &	yields,
		const FMTBaseVertexProperties &	source,
		const FMTBaseVertexProperties &	target,
		const std::vector< const FMTBaseEdgeProperties * > &	edges,
		const std::vector< int > &	gaps,
		bool	withGCBMid = true
	)

Construct a FMTPredictor from the source and target vertices of a graph transition and the edges between them.

Parameters

[in]	actions	the model actions.
[in]	yieldnames	the yield names.
[in]	yields	the yields.
[in]	source	the source vertex.
[in]	target	the target vertex.
[in]	edges	the edges between the source and the target.
[in]	gaps	the period gaps.
[in]	withGCBMid	if true uses the GCBM id.

FMTPredictor() [3/3]

Graph::FMTPredictor::FMTPredictor

(

const FMTPredictor &

rhs

)

Copy constructor for FMTPredictor.

Parameters

[in]

rhs

the FMTPredictor to copy.

Member Function Documentation

getDistance()

double Graph::FMTPredictor::getDistance

(

size_t

actId

)

const

Return the distance to an action.

Parameters

[in]

actId

the action id.

Returns

the distance.

getDisturbance()

double Graph::FMTPredictor::getDisturbance

(

size_t

actId

)

const

Return the disturbance of an action.

Parameters

[in]

actId

the action id.

Returns

the disturbance.

getPredictorNames()

std::vector< std::string > Graph::FMTPredictor::getPredictorNames

(

const std::vector< std::string > &

yieldnames

)

const

Return the names of the predictors.

Parameters

[in]

yieldnames

the yield names.

Returns

the predictor names.

getPredictors()

std::vector< double > Graph::FMTPredictor::getPredictors

(

)

const

Return the predictor values.

Returns

the predictor values.

getSourceAge()

double Graph::FMTPredictor::getSourceAge

(

)

const

Return the age of the source vertex.

Returns

the source age.

getSourceYields()

std::vector< double > Graph::FMTPredictor::getSourceYields

(

)

const

Return the yields of the source vertex.

Returns

the source yields.

getTargetAge()

double Graph::FMTPredictor::getTargetAge

(

)

const

Return the age of the target vertex.

Returns

the target age.

getTargetYields()

std::vector< double > Graph::FMTPredictor::getTargetYields

(

)

const

Return the yields of the target vertex.

Returns

the target yields.

operator<()

bool Graph::FMTPredictor::operator<

(

const FMTPredictor &

rhs

)

const

Less than operator for FMTPredictor.

Parameters

[in]

rhs

the FMTPredictor to compare to.

Returns

true if this predictor is less than the other else false.

operator=()

FMTPredictor & Graph::FMTPredictor::operator=

(

const FMTPredictor &

rhs

)

Copy assignment operator for FMTPredictor.

Parameters

[in]

rhs

the FMTPredictor to copy.

Returns

a reference to this FMTPredictor.

operator==()

bool Graph::FMTPredictor::operator==

(

const FMTPredictor &

rhs

)

const

Comparison operator for FMTPredictor.

Parameters

[in]

rhs

the FMTPredictor to compare to.

Returns

true if both predictors are equal else false.

---

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

• D:/FMT/Include/FMTPredictor.h