Abstract class to be implemented as a machine learning yield model. More...

#include <FMTYieldModel.h>

Inheritance diagram for Core::FMTYieldModel:

Collaboration diagram for Core::FMTYieldModel:

Public Member Functions
virtual void	setModel (Models::FMTModel *p_modelPtr)
	Set the model linked to the yield model.

virtual	~FMTYieldModel ()
	Destructor for FMTYieldModel.

	FMTYieldModel ()
	Constructor for FMTYieldModel.

	FMTYieldModel (const FMTYieldModel &rhs)=default
	Copy constructor for FMTYieldModel.

FMTYieldModel &	operator= (const FMTYieldModel &rhs)=default
	Default copy assignment operator for FMTYieldModel.

const std::string &	getModelName () const
	Return the model name.

const std::vector< std::string > &	getModelYields () const
	Return the model yield names.

virtual std::unique_ptr< FMTYieldModel >	clone () const =0
	clone the yield model.

virtual const std::vector< double >	predict (const Core::FMTYieldRequest &request) const =0
	Predict the yield for a request.

virtual std::unique_ptr< FMTYieldModel >	preSolve (const FMTMaskFilter &filter, const std::vector< FMTTheme > &newthemes) const
	Return a presolved copy of the yield model, or the same model by default.

virtual std::unique_ptr< FMTYieldModel >	postSolve (const FMTMaskFilter &filter, const std::vector< FMTTheme > &basethemes) const
	Return a postsolved copy of the yield model, a clone by default.

virtual	operator std::string () const
	Return the string representation of the yield model.

virtual std::vector< std::vector< double > >	getPeriodicValues () const
	Try to turn the yield model into periodic constant values.

virtual void	clearRandomYieldsCache ()
	Clear the cache of all random yield models.

Public Member Functions inherited from Core::FMTObject
	FMTObject ()
	Default constructor for FMTObject.

virtual	~FMTObject ()
	Default virtual destructor for FMTObject.

	FMTObject (const std::unique_ptr< Exception::FMTExceptionHandler > exhandler)
	Construct a FMTObject passing in the exception handler of another FMTObject.

	FMTObject (const FMTObject &rhs)
	Copy constructor for FMTObject.

FMTObject &	operator= (const FMTObject &rhs)
	Copy assignment operator for FMTObject.

virtual void	passInLogger (const std::unique_ptr< Logging::FMTLogger > &logger)
	Pass in the logger of another FMTObject.

void	passInExceptionHandler (const std::unique_ptr< Exception::FMTExceptionHandler > &exhandler)
	Pass in the exception handler of another FMTObject.

void	redirectLogToFile (const std::string &location)
	Redirect the log to a specific file, appending to it.

virtual void	setDefaultLogger ()
	Create and set a default logger to the FMTObject.

virtual void	setQuietLogger ()
	Create and set a quiet logger to the FMTObject.

virtual void	setTaskLogger ()
	Create and set a task logger to the FMTObject.

virtual void	setDebugLogger ()
	Create and set a debug logger to the FMTObject.

void	setDefaultExceptionHandler ()
	Create and set a default exception handler to the FMTObject.

void	setQuietExceptionHandler ()
	Create and set a quiet exception handler to the FMTObject.

void	setDebugExceptionHandler ()
	Create and set a debug exception handler to the FMTObject.

void	setFreeExceptionHandler ()
	Create and set a free exception handler to the FMTObject.

void	disableNestedExceptions ()
	Disable the nested exception throw of the exception handler.

void	enableNestedExceptions ()
	Enable the nested exception throw of the exception handler.

void	setErrorsToWarnings (const std::vector< Exception::FMTexc > &errors)
	Set a list of errors to be cast to warnings on the exception handler.

void	setMaxWarningsBeforeSilenced (const size_t &maxwarningcount)
	Set the number of warnings raised before being silenced.

template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Protected Attributes
std::string	m_modelName

std::vector< std::string >	m_modelYields = {}

const std::string	m_JSON_PROP_MODEL_NAME = "modelFileName"

Models::FMTModel *	m_modelPtr =nullptr

Friends
class	boost::serialization::access

Additional Inherited Members
Static Public Member Functions inherited from Core::FMTObject
static Logging::FMTLogger *	getLogger ()
	get a pointer to the actual logger.

static Exception::FMTExceptionHandler *	getExceptionHandler ()
	get a pointer to the actual exception handler.

static std::string	getRuntimeLocation ()
	Return the location of the FMT shared library.

static unsigned long long	getAvailableMemory ()
	Return the available memory in bytes.

static void	setTerminateStack ()
	will write the stack in the log when terminate called and raise a function failed.

static void	setAbortStack ()
	will write the stack in the log when abort called with SIGABRT and raise a function failed.

Protected Member Functions inherited from Core::FMTObject
template<class Archive >
void	forceSave (Archive &ar, const unsigned int version) const
	Force the serialization to save useful information, which the default FMTObject serialization does not.

template<class Archive >
void	forceLoad (Archive &ar, const unsigned int version)
	Force the serialization to load useful information, which the default FMTObject serialization does not.

void	checkSignals () const
	Check if the user has sent a ctrl-c signal using boost::python to FMT.

void	setCplHandler ()
	Pass the FMT exception handler to the GDAL exception handler (GDAL only).

Static Protected Member Functions inherited from Core::FMTObject
static std::chrono::time_point< std::chrono::high_resolution_clock >	getClock ()
	Return a clock of the current time.

template<class chrono >
static double	getDuration (const std::chrono::time_point< std::chrono::high_resolution_clock > &startclock)
	Return the time elapsed since a start clock as a double.

static std::string	getDurationInSeconds (const std::chrono::time_point< std::chrono::high_resolution_clock > &startclock)
	Return the time elapsed since a start clock in seconds as a string.

static void	_logStack ()
	Log the stack trace...

static void	_terminate ()
	Raise an error with the boost stacktrace.

static void	_abort (int p_signal)
	Raise an error with the boost stacktrace on abort.

Static Protected Attributes inherited from Core::FMTObject
static std::unique_ptr< Exception::FMTExceptionHandler >	_exhandler
	A shared pointer to the exception handler.

static std::unique_ptr< Logging::FMTLogger >	_logger
	A shared pointer to the logger.

Detailed Description

Abstract class to be implemented as a machine learning yield model.

Constructor & Destructor Documentation

◆ ~FMTYieldModel()

virtual Core::FMTYieldModel::~FMTYieldModel ( )

virtual

Destructor for FMTYieldModel.

◆ FMTYieldModel() [1/2]

Core::FMTYieldModel::FMTYieldModel ( )

Constructor for FMTYieldModel.

◆ FMTYieldModel() [2/2]

Core::FMTYieldModel::FMTYieldModel ( const FMTYieldModel & rhs )

default

Copy constructor for FMTYieldModel.

Parameters

[in] rhs the FMTYieldModel to copy.

Member Function Documentation

◆ clearRandomYieldsCache()

virtual void Core::FMTYieldModel::clearRandomYieldsCache ( )

virtual

Clear the cache of all random yield models.

Reimplemented in Core::FMTYieldModelRandom.

◆ clone()

virtual std::unique_ptr< FMTYieldModel > Core::FMTYieldModel::clone ( ) const

pure virtual

clone the yield model.

Returns: a unique pointer to the cloned yield model.

Implemented in Core::FMTYieldModelDecisionTree, Core::FMTYieldModelNep, Core::FMTYieldModelPools, Core::FMTYieldModelRandom, Core::FMTYieldModelTsla, and Core::FMTYieldModelUnitCoverage.

◆ getModelName()

const std::string & Core::FMTYieldModel::getModelName ( ) const

Return the model name.

Returns: the model name.

◆ getModelYields()

const std::vector< std::string > & Core::FMTYieldModel::getModelYields ( ) const

Return the model yield names.

Returns: the model yield names.

◆ getPeriodicValues()

virtual std::vector< std::vector< double > > Core::FMTYieldModel::getPeriodicValues ( ) const

virtual

Try to turn the yield model into periodic constant values.

Returns: a vector where the first dimension is the yield id and the second is the periodic values, empty if not possible.

Reimplemented in Core::FMTYieldModelDecisionTree.

◆ operator std::string()

virtual Core::FMTYieldModel::operator std::string ( ) const

virtual

Return the string representation of the yield model.

Returns: the string representation.

Reimplemented in Core::FMTYieldModelTsla.

◆ operator=()

FMTYieldModel & Core::FMTYieldModel::operator= ( const FMTYieldModel & rhs )

default

Default copy assignment operator for FMTYieldModel.

Parameters

[in] rhs the FMTYieldModel to copy.

Returns: a reference to this FMTYieldModel.

◆ postSolve()

virtual std::unique_ptr< FMTYieldModel > Core::FMTYieldModel::postSolve	(	const FMTMaskFilter &	filter,
		const std::vector< FMTTheme > &	basethemes
	)		const

virtual

Return a postsolved copy of the yield model, a clone by default.

Parameters

[in]	filter	the mask filter.
[in]	basethemes	the original themes.

Returns: the postsolved yield model.

Reimplemented in Core::FMTYieldModelDecisionTree, Core::FMTYieldModelTsla, Core::FMTYieldModelRandom, and Core::FMTYieldModelUnitCoverage.

◆ predict()

virtual const std::vector< double > Core::FMTYieldModel::predict ( const Core::FMTYieldRequest & request ) const

pure virtual

Predict the yield for a request.

Parameters

[in] request the yield request.

Returns: the predicted yield values.

Implemented in Core::FMTYieldModelRandom, Core::FMTYieldModelUnitCoverage, Core::FMTYieldModelDecisionTree, Core::FMTYieldModelNn, and Core::FMTYieldModelTsla.

◆ preSolve()

virtual std::unique_ptr< FMTYieldModel > Core::FMTYieldModel::preSolve	(	const FMTMaskFilter &	filter,
		const std::vector< FMTTheme > &	newthemes
	)		const

virtual

Return a presolved copy of the yield model, or the same model by default.

Parameters

[in]	filter	the mask filter.
[in]	newthemes	the presolved themes.

Returns: the presolved yield model.

Reimplemented in Core::FMTYieldModelDecisionTree, Core::FMTYieldModelTsla, Core::FMTYieldModelRandom, and Core::FMTYieldModelUnitCoverage.

◆ setModel()

virtual void Core::FMTYieldModel::setModel ( Models::FMTModel * p_modelPtr )

virtual

Set the model linked to the yield model.

Parameters

[in] p_modelPtr the pointer to the model.

Reimplemented in Core::FMTYieldModelRandom.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access

friend

Member Data Documentation

◆ m_JSON_PROP_MODEL_NAME

const std::string Core::FMTYieldModel::m_JSON_PROP_MODEL_NAME = "modelFileName"

protected

◆ m_modelName

std::string Core::FMTYieldModel::m_modelName

protected

◆ m_modelPtr

Models::FMTModel* Core::FMTYieldModel::m_modelPtr =nullptr

protected

◆ m_modelYields

std::vector<std::string> Core::FMTYieldModel::m_modelYields = {}

protected

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

D:/FMT/Include/FMTYieldModel.h

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~FMTYieldModel()

◆ FMTYieldModel() [1/2]

◆ FMTYieldModel() [2/2]

Member Function Documentation

◆ clearRandomYieldsCache()

◆ clone()

◆ getModelName()

◆ getModelYields()

◆ getPeriodicValues()

◆ operator std::string()

◆ operator=()

◆ postSolve()

◆ predict()

◆ preSolve()

◆ setModel()

Friends And Related Function Documentation

◆ boost::serialization::access

Member Data Documentation

◆ m_JSON_PROP_MODEL_NAME

◆ m_modelName

◆ m_modelPtr

◆ m_modelYields