1/* Copyright (c) 2012 Massachusetts Institute of Technology
2 *
3 * Permission is hereby granted, free of charge, to any person obtaining a copy
4 * of this software and associated documentation files (the "Software"), to deal
5 * in the Software without restriction, including without limitation the rights
6 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7 * copies of the Software, and to permit persons to whom the Software is
8 * furnished to do so, subject to the following conditions:
9 *
10 * The above copyright notice and this permission notice shall be included in
11 * all copies or substantial portions of the Software.
12 *
13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19 * THE SOFTWARE.
20 */
21
22#ifndef __DSENT_MODEL_TRANSITION_INFO_H__
23#define __DSENT_MODEL_TRANSITION_INFO_H__
24
25#include "util/CommonType.h"
26
27namespace DSENT
28{
29    /**
30     * \brief This class contains the number of transitions and the frequency multiplier information
31     */
32    class TransitionInfo
33    {
34        public:
35            TransitionInfo();
36            TransitionInfo(double number_transitions_00_, double number_transitions_01_, double number_transitions_11_);
37            ~TransitionInfo();
38
39        public:
40            inline double getNumberTransitions00() const { return m_number_transitions_00_; }
41            inline double getNumberTransitions01() const { return m_number_transitions_01_; }
42            inline double getNumberTransitions11() const { return m_number_transitions_11_; }
43            inline double getFrequencyMultiplier() const { return m_frequency_multiplier_; }
44            inline double getProbability0() const { return m_probability_1_; }
45            inline double getProbability1() const { return m_probability_1_; }
46
47            inline void setNumberTransitions00(double value_) { m_number_transitions_00_ = value_; }
48            inline void setNumberTransitions01(double value_) { m_number_transitions_01_ = value_; }
49            inline void setNumberTransitions11(double value_) { m_number_transitions_11_ = value_; }
50            inline void setFrequencyMultiplier(double value_) { m_frequency_multiplier_ = value_; }
51
52            void update();
53            TransitionInfo scaleFrequencyMultiplier(double frequency_multiplier_) const;
54
55            void print(std::ostream& ost_) const;
56
57        private:
58            // m_number_transitions_xy_ defines number of transitions from x to y
59            double m_number_transitions_00_;
60            double m_number_transitions_01_;
61            double m_number_transitions_11_;
62            // The multiplier that defines the ratio of the transition frequency and the main core clock frequency
63            double m_frequency_multiplier_;
64            // Probability of being at state 0/1
65            double m_probability_0_;
66            double m_probability_1_;
67    }; // class TransitionInfo
68} // namespace DSENT
69
70#endif // __DSENT_MODEL_TRANSITION_INFO_H__
71
72