This is the class used to calculate the likelihood scores based on population errors arising from incorrect migration. More...

#include <migrationpenalty.h>

Inheritance diagram for MigrationPenalty:

Collaboration diagram for MigrationPenalty:

Public Member Functions
	MigrationPenalty (CommentStream &infile, double weight, const char *name)
	This is the default MigrationPenalty constructor. More...

virtual	~MigrationPenalty ()
	This is the default MigrationPenalty destructor. More...

virtual void	addLikelihood (const TimeClass *const TimeInfo)
	This function will calculate the likelihood score for the current model. More...

void	setFleetsAndStocks (FleetPtrVector &Fleets, StockPtrVector &Stocks)
	This will select the fleets and stocks required to calculate the MigrationPenalty likelihood score. More...

virtual void	Reset (const Keeper *const keeper)
	This function will reset the MigrationPenalty likelihood information. More...

virtual void	printSummary (ofstream &outfile)
	This function will print summary information from the MigrationPenalty likelihood calculation. More...

virtual void	Print (ofstream &outfile) const
	This function will print the summary MigrationPenalty likelihood information. More...

Public Member Functions inherited from Likelihood
	Likelihood (LikelihoodType T, double w, const char *givenname)
	This is the default Likelihood constructor. More...

virtual	~Likelihood ()
	This is the default Likelihood destructor. More...

virtual void	addLikelihoodKeeper (const TimeClass const TimeInfo, Keeper const keeper)
	This function will calculate the likelihood score for the current model after adjusting the parameters. More...

virtual void	Reset (const TimeClass *const TimeInfo)
	This function will reset the likelihood information. More...

virtual void	printLikelihood (ofstream &outfile, const TimeClass *const TimeInfo)
	This function will print information from each likelihood calculation. More...

double	getLikelihood () const
	This will return the weighted likelihood score for the likelihood component. More...

LikelihoodType	getType () const
	This will return the type of likelihood class. More...

double	getUnweightedLikelihood () const
	This will return the unweighted likelihood score for the likelihood component. More...

double	getWeight () const
	This will return the weight applied to the likelihood component. More...

Public Member Functions inherited from HasName
	HasName ()
	This is the default HasName constructor. More...

virtual	~HasName ()
	This is the default HasName destructor. More...

	HasName (const char *givenname)
	This is the HasName constructor for a specified name. More...

const char *	getName () const
	This will return a null terminated text string containing the name of the object. More...

Additional Inherited Members
Protected Attributes inherited from Likelihood
double	likelihood
	This stores the calculated score for the likelihood component. More...

double	weight
	This stores the weight to be applied to the likelihood component. More...

Detailed Description

This is the class used to calculate the likelihood scores based on population errors arising from incorrect migration.

This class calculates a penalty that is applied if there are insufficient fish of a particular stock on a particular area, due to changes in the migration of the stock. This can lead to values for the migration matrices that are meaningless. This can quickly lead to a model that is very wrong, and so this gets a high penalty. A 'reasonable' model will have a zero likelihood score from this component.

Constructor & Destructor Documentation

◆ MigrationPenalty()

MigrationPenalty::MigrationPenalty	(	CommentStream &	infile,
		double	weight,
		const char *	name
	)

This is the default MigrationPenalty constructor.

Parameters

infile	is the CommentStream to read the likelihood parameters from
weight	is the weight for the likelihood component
name	is the name for the likelihood component

◆ ~MigrationPenalty()

MigrationPenalty::~MigrationPenalty ( )

virtual

This is the default MigrationPenalty destructor.

Member Function Documentation

◆ addLikelihood()

void MigrationPenalty::addLikelihood ( const TimeClass *const TimeInfo )

virtual

This function will calculate the likelihood score for the current model.

Parameters

TimeInfo is the TimeClass for the current model

Implements Likelihood.

◆ Print()

void MigrationPenalty::Print ( ofstream & outfile ) const

virtual

This function will print the summary MigrationPenalty likelihood information.

Parameters

outfile is the ofstream that all the model information gets sent to

Note: This function is not used for this likelihood component

Implements Likelihood.

◆ printSummary()

void MigrationPenalty::printSummary ( ofstream & outfile )

virtual

This function will print summary information from the MigrationPenalty likelihood calculation.

Parameters

outfile is the ofstream that all the model likelihood information gets sent to

Reimplemented from Likelihood.

◆ Reset()

void MigrationPenalty::Reset ( const Keeper *const keeper )

virtual

This function will reset the MigrationPenalty likelihood information.

Parameters

keeper is the Keeper for the current model

Reimplemented from Likelihood.

◆ setFleetsAndStocks()

void MigrationPenalty::setFleetsAndStocks	(	FleetPtrVector &	Fleets,
		StockPtrVector &	Stocks
	)

virtual

This will select the fleets and stocks required to calculate the MigrationPenalty likelihood score.

Parameters

Fleets	is the FleetPtrVector of all the available fleets
Stocks	is the StockPtrVector of all the available stocks

Reimplemented from Likelihood.

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

src/include/migrationpenalty.h
src/migrationpenalty.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MigrationPenalty()

◆ ~MigrationPenalty()

Member Function Documentation

◆ addLikelihood()

◆ Print()

◆ printSummary()

◆ Reset()

◆ setFleetsAndStocks()