This is the class used to calculate a likelihood score based on the biomass of stocks caught by fleets. More...

#include <migrationproportion.h>

Inheritance diagram for MigrationProportion:

Collaboration diagram for MigrationProportion:

Public Member Functions
	MigrationProportion (CommentStream &infile, const AreaClass const Area, const TimeClass const TimeInfo, double weight, const char *name)
	This is the MigrationProportion constructor. More...

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

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

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

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

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

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

virtual void	printSummary (ofstream &outfile)
	This function will print summary information from each MigrationProportion likelihood calculation. 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...

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 a likelihood score based on the biomass of stocks caught by fleets.

This class calculates a likelihood score based on the difference between the biomass caught according to the model and the biomass caught by fleets, according to the landings data. This should lead to a zero likelihood score for a fleet that has been declared as a TotalPredator, since catch for that fleet should exactly match the landings data. However, for a fleet that has been declared as a LinearPredator, or a NumberPredator, the model will be calculating the catch based on model parameters and so will probably lead to a difference between the modelled landings biomass and actual landed catch.

Constructor & Destructor Documentation

◆ MigrationProportion()

MigrationProportion::MigrationProportion	(	CommentStream &	infile,
		const AreaClass *const	Area,
		const TimeClass *const	TimeInfo,
		double	weight,
		const char *	name
	)

This is the MigrationProportion constructor.

Parameters

infile	is the CommentStream to read the CatchDistribution data from
Area	is the AreaClass for the current model
TimeInfo	is the TimeClass for the current model
weight	is the weight for the likelihood component
name	is the name for the likelihood component

◆ ~MigrationProportion()

MigrationProportion::~MigrationProportion ( )

virtual

This is the default MigrationProportion destructor.

Member Function Documentation

◆ addLikelihood()

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

virtual

This function will calculate the likelihood score for the MigrationProportion component.

Parameters

TimeInfo is the TimeClass for the current model

Implements Likelihood.

◆ Print()

void MigrationProportion::Print ( ofstream & outfile ) const

virtual

This function will print the summary MigrationProportion likelihood information.

Parameters

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

Implements Likelihood.

◆ printLikelihood()

void MigrationProportion::printLikelihood	(	ofstream &	outfile,
		const TimeClass *const	TimeInfo
	)

virtual

This function will print information from each MigrationProportion calculation.

Parameters

outfile	is the ofstream that all the model likelihood information gets sent to
TimeInfo	is the TimeClass for the current model

Reimplemented from Likelihood.

◆ printSummary()

void MigrationProportion::printSummary ( ofstream & outfile )

virtual

This function will print summary information from each MigrationProportion likelihood calculation.

Parameters

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

Reimplemented from Likelihood.

◆ Reset()

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

virtual

This function will reset the MigrationProportion likelihood information.

Parameters

keeper is the Keeper for the current model

Reimplemented from Likelihood.

◆ setFleetsAndStocks()

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

virtual

This will select the fleets and stocks required to calculate the MigrationProportion 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/migrationproportion.h
src/migrationproportion.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MigrationProportion()

◆ ~MigrationProportion()

Member Function Documentation

◆ addLikelihood()

◆ Print()

◆ printLikelihood()

◆ printSummary()

◆ Reset()

◆ setFleetsAndStocks()