Log In | Get Help   
Home My Page Projects Code Snippets Project Openings Mareframe
Summary Activity Forums Tracker Lists Tasks Docs Surveys News SCM Files
[mareframe] Annotation of /trunk/gadget/popratio.h
[mareframe] / trunk / gadget / popratio.h Repository:
ViewVC logotype

Annotation of /trunk/gadget/popratio.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1 - (view) (download)

1 : agomez 1 #ifndef popratio_h
2 :     #define popratio_h
3 :    
4 :     #include "gadget.h"
5 :    
6 :     /**
7 :     * \class PopRatio
8 :     * \brief This is the class used to store information about the number of tagged fish in a population cell of a stock and ratio of the fish from that population cell that are tagged
9 :     */
10 :     class PopRatio {
11 :     public:
12 :     /**
13 :     * \brief This is the PopRatio constructor
14 :     */
15 :     PopRatio() { N = NULL; R = 0.0; };
16 :     /**
17 :     * \brief This is the PopRatio destructor
18 :     */
19 :     ~PopRatio() {};
20 :     /**
21 :     * \brief This is the number of tagged fish in the population cell
22 :     */
23 :     double* N;
24 :     /**
25 :     * \brief This is the ratio of tagged fish in the population cell
26 :     */
27 :     double R;
28 :     /**
29 :     * \brief This operator will subtract a number from the PopRatio
30 :     * \param a is the number to subtract
31 :     */
32 :     void operator -= (double a) { *N -= a; R = 0.0; };
33 :     /**
34 :     * \brief This operator will increase the PopRatio by a multiplicative constant
35 :     * \param a is the multiplicative constant
36 :     */
37 :     void operator *= (double a) { *N *= a; R = 0.0; };
38 :     /**
39 :     * \brief This operator will set the PopRatio equal to an existing PopRatio
40 :     * \param a is the PopRatio to copy
41 :     */
42 :     PopRatio& operator = (const PopRatio& a);
43 :     /**
44 :     * \brief This operator will add an existing PopRatio to the current PopRatio
45 :     * \param a is the PopRatio to add
46 :     */
47 :     PopRatio& operator += (const PopRatio& a);
48 :     };
49 :    
50 :     #endif

root@forge.cesga.es
ViewVC Help
Powered by ViewVC 1.0.0  

Powered By FusionForge