Gadget
predatoraggregator.h
Go to the documentation of this file.
1 #ifndef predatoraggregator_h
2 #define predatoraggregator_h
3 
4 #include "agebandmatrix.h"
5 #include "doublematrixptrvector.h"
6 #include "intmatrix.h"
7 #include "predatorptrvector.h"
8 #include "preyptrvector.h"
9 #include "charptrvector.h"
10 
15 class PredatorAggregator {
16 public:
25  PredatorAggregator(const PredatorPtrVector& predators, const PreyPtrVector& preys,
26  const IntMatrix& Areas, const LengthGroupDivision* const predLgrpDiv,
27  const LengthGroupDivision* const preyLgrpDiv);
36  PredatorAggregator(const PredatorPtrVector& predators, const PreyPtrVector& preys,
37  const IntMatrix& Areas, const IntMatrix& predAges,
38  const LengthGroupDivision* const preyLgrpDiv);
42  ~PredatorAggregator();
47  void Print(ofstream &outfile) const;
51  void Reset();
55  void Sum();
59  void NumberSum();
64  const DoubleMatrixPtrVector& getSum() const { return total; };
65 protected:
69  PredatorPtrVector predators;
73  PreyPtrVector preys;
78  IntMatrix predConv;
83  IntMatrix preyConv;
87  IntMatrix areas;
92  IntMatrix doeseat;
96  DoubleMatrixPtrVector total;
100  const DoubleMatrix* dptr;
104  const AgeBandMatrix* alk;
108  int usepredages;
109 };
110 
111 #endif
AgeBandMatrix
This class implements a vector of PopInfoIndexVector values, indexed from minage not 0.
Definition: agebandmatrix.h:15
DoubleMatrixPtrVector
This class implements a dynamic vector of DoubleMatrix values.
Definition: doublematrixptrvector.h:10
DoubleMatrix
This class implements a dynamic vector of DoubleVector values.
Definition: doublematrix.h:11
IntMatrix
This class implements a dynamic vector of IntVector values.
Definition: intmatrix.h:10
LengthGroupDivision
This is the class used to store information about the length groups of the modelled stock population.
Definition: lengthgroup.h:10
PredatorAggregator
This is the class used to aggregate predation information.
Definition: predatoraggregator.h:15
PredatorAggregator::predators
PredatorPtrVector predators
This is the PredatorPtrVector of the predators that will be aggregated.
Definition: predatoraggregator.h:64
PredatorAggregator::Reset
void Reset()
This function will reset the predation data.
Definition: predatoraggregator.cc:101
PredatorAggregator::doeseat
IntMatrix doeseat
This is the IntMatrix used to store predation information.
Definition: predatoraggregator.h:92
PredatorAggregator::getSum
const DoubleMatrixPtrVector & getSum() const
This will return the DoubleMatrixPtrVector containing the aggregated predation information.
Definition: predatoraggregator.h:64
PredatorAggregator::preyConv
IntMatrix preyConv
This is the IntMatrix used to convert length group information for preys.
Definition: predatoraggregator.h:83
PredatorAggregator::areas
IntMatrix areas
This is the IntMatrix used to store area information.
Definition: predatoraggregator.h:87
PredatorAggregator::alk
const AgeBandMatrix * alk
This is the AgeBandMatrix used to temporarily store information when aggregating the predation.
Definition: predatoraggregator.h:104
PredatorAggregator::PredatorAggregator
PredatorAggregator(const PredatorPtrVector &predators, const PreyPtrVector &preys, const IntMatrix &Areas, const LengthGroupDivision *const predLgrpDiv, const LengthGroupDivision *const preyLgrpDiv)
This is the PredatorAggregator constructor for length based predators.
Definition: predatoraggregator.cc:11
PredatorAggregator::~PredatorAggregator
~PredatorAggregator()
This is the default PredatorAggregator destructor.
Definition: predatoraggregator.cc:81
PredatorAggregator::dptr
const DoubleMatrix * dptr
This is the DoubleMatrix used to temporarily store information when aggregating the predation.
Definition: predatoraggregator.h:100
PredatorAggregator::usepredages
int usepredages
This is the flag used to denote whether the predators are specified using age groups or length groups...
Definition: predatoraggregator.h:108
PredatorAggregator::total
DoubleMatrixPtrVector total
This is the DoubleMatrixPtrVector used to store the aggregated predation information.
Definition: predatoraggregator.h:96
PredatorAggregator::NumberSum
void NumberSum()
This function will aggregate the predation number data.
Definition: predatoraggregator.cc:176
PredatorAggregator::Sum
void Sum()
This function will aggregate the predation biomass data.
Definition: predatoraggregator.cc:107
PredatorAggregator::Print
void Print(ofstream &outfile) const
This will print the aggregator information to the ofstream specified.
Definition: predatoraggregator.cc:87
PredatorAggregator::predConv
IntMatrix predConv
This is the IntMatrix used to convert length group information for predators.
Definition: predatoraggregator.h:78
PredatorAggregator::preys
PreyPtrVector preys
This is the PreyPtrVector of the preys that will be aggregated.
Definition: predatoraggregator.h:73
PredatorPtrVector
This class implements a dynamic vector of Predator values.
Definition: predatorptrvector.h:10
PreyPtrVector
This class implements a dynamic vector of Prey values.
Definition: preyptrvector.h:10
Generated by doxygen 1.9.1