FMT 1.2.0
Forest management tools for forest planning
Loading...
Searching...
No Matches
FMTModelStats.h
Go to the documentation of this file.
1/*
2Copyright (c) 2019 Gouvernement du Québec
3
4SPDX-License-Identifier: LiLiQ-R-1.1
5License-Filename: LICENSES/EN/LiLiQ-R11unicode.txt
6*/
7
8#ifndef FMTmodelstats_Hm_included
9#define FMTmodelstats_Hm_included
10
11#include <boost/serialization/serialization.hpp>
12#include <boost/serialization/nvp.hpp>
13#include <string>
14#include "FMTException.h"
15
16namespace Models
17{
18 // DocString: FMTModelStats
24 {
25 friend class boost::serialization::access;
26 // DocString: FMTModelStats::serialize
33 template<class Archive>
34 void serialize(Archive& ar, const unsigned int version)
35 {
36 ar & BOOST_SERIALIZATION_NVP(themes);
37 ar & BOOST_SERIALIZATION_NVP(themesdata);
38 ar & BOOST_SERIALIZATION_NVP(actions);
39 ar & BOOST_SERIALIZATION_NVP(actionsdata);
40 ar & BOOST_SERIALIZATION_NVP(transitions);
41 ar & BOOST_SERIALIZATION_NVP(transitionsdata);
42 ar & BOOST_SERIALIZATION_NVP(yieldsdata);
43 ar & BOOST_SERIALIZATION_NVP(lifespansdata);
44 ar & BOOST_SERIALIZATION_NVP(outputs);
45 ar & BOOST_SERIALIZATION_NVP(outputsdata);
46 ar & BOOST_SERIALIZATION_NVP(constraints);
47 ar & BOOST_SERIALIZATION_NVP(constraintsdata);
48 }
49 public:
50 // DocString: FMTModelStats::themes
52 int themes;
53 // DocString: FMTModelStats::themesdata
56 // DocString: FMTModelStats::actions
59 // DocString: FMTModelStats::actionsdata
62 // DocString: FMTModelStats::transitions
65 // DocString: FMTModelStats::transitionsdata
68 // DocString: FMTModelStats::yieldsdata
71 // DocString: FMTModelStats::lifespansdata
74 // DocString: FMTModelStats::outputs
77 // DocString: FMTModelStats::outputsdata
80 // DocString: FMTModelStats::constraints
83 // DocString: FMTModelStats::constraintsdata
86 // DocString: FMTModelStats(const size_t,const size_t,const size_t, const size_t,const size_t,const size_t, const size_t, const size_t,const size_t, const size_t,const size_t,const size_t)
102 FMTModelStats(const size_t& lthemes,const size_t& lthemesdata, const size_t& lactions, const size_t& lactionsdata,
103 const size_t& ltransitions, const size_t& ltransitionsdata, const size_t& lyieldsdata,const size_t& llifespansdata,
104 const size_t& loutputs, const size_t& loutputsdata,const size_t& lconstraints, const size_t& lconstraintsdata);
105 // DocString: FMTModelStats()
109 FMTModelStats() = default;
110 // DocString: FMTModelStats(const FMTModelStats)
115 FMTModelStats(const FMTModelStats& rhs) = default;
116 // DocString: ~FMTModelStats()
120 ~FMTModelStats() = default;
121 // DocString: FMTModelStats::operator=
127 FMTModelStats& operator = (const FMTModelStats& rhs) = default;
128 // DocString: FMTModelStats::operator+=
134 FMTModelStats& operator += (const FMTModelStats& rhs);
135 // DocString: FMTModelStats::operator-=
141 FMTModelStats& operator -= (const FMTModelStats& rhs);
142 // DocString: FMTModelStats::operator+
148 FMTModelStats operator + (const FMTModelStats& rhs);
149 // DocString: FMTModelStats::operator-
155 FMTModelStats operator - (const FMTModelStats& rhs);
156 // DocString: FMTModelStats::operator==
162 bool operator == (const FMTModelStats& rhs) const;
163 // DocString: FMTModelStats::operator!=
169 bool operator != (const FMTModelStats& rhs) const;
170 // DocString: FMTModelStats::operator std::string()
175 operator std::string() const;
176
177 };
178}
179
180#endif
#define FMTEXPORT
Definition: FMTutility.h:125
Class reporting the statistics of a FMTModel, used with the preSolve and postsolve functions.
Definition: FMTModelStats.h:24
int actionsdata
The actions's data size.
Definition: FMTModelStats.h:61
FMTModelStats()=default
Default constructor for FMTModelStats.
int yieldsdata
The yields's data size.
Definition: FMTModelStats.h:70
int outputs
The number of outputs of the FMTModel.
Definition: FMTModelStats.h:76
int actions
The number of actions of the FMTModel.
Definition: FMTModelStats.h:58
int themes
The number of themes the FMTModel.
Definition: FMTModelStats.h:52
int transitionsdata
The transitions's data size.
Definition: FMTModelStats.h:67
int constraints
The number of constraints of the FMTModel.
Definition: FMTModelStats.h:82
int constraintsdata
The constraintsdata's data size.
Definition: FMTModelStats.h:85
int themesdata
The themes's data size.
Definition: FMTModelStats.h:55
~FMTModelStats()=default
Default destructor for FMTModelStats.
int lifespansdata
The lifespans's data size.
Definition: FMTModelStats.h:73
int transitions
The number of transitions of the FMTModel.
Definition: FMTModelStats.h:64
int outputsdata
The outputsdata's data size.
Definition: FMTModelStats.h:79
FMTModelStats(const FMTModelStats &rhs)=default
Copy constructor for FMTModelStats.
FMTModelStats(const size_t &lthemes, const size_t &lthemesdata, const size_t &lactions, const size_t &lactionsdata, const size_t &ltransitions, const size_t &ltransitionsdata, const size_t &lyieldsdata, const size_t &llifespansdata, const size_t &loutputs, const size_t &loutputsdata, const size_t &lconstraints, const size_t &lconstraintsdata)
Constructor for complete stats.
Namespace containing all enumerator and classes used to construct or manipulate the different type of...
Definition: FMTAreaParser.h:54