ext/dsent/model/TransitionInfo.h

/* Copyright (c) 2012 Massachusetts Institute of Technology
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef __DSENT_MODEL_TRANSITION_INFO_H__
#define __DSENT_MODEL_TRANSITION_INFO_H__

#include "util/CommonType.h"

namespace DSENT
{
    /**
     * \brief This class contains the number of transitions and the frequency multiplier information
     */
    class TransitionInfo
    {
        public:
            TransitionInfo();
            TransitionInfo(double number_transitions_00_, double number_transitions_01_, double number_transitions_11_);
            ~TransitionInfo();

        public:
            inline double getNumberTransitions00() const { return m_number_transitions_00_; }
            inline double getNumberTransitions01() const { return m_number_transitions_01_; }
            inline double getNumberTransitions11() const { return m_number_transitions_11_; }
            inline double getFrequencyMultiplier() const { return m_frequency_multiplier_; }
            inline double getProbability0() const { return m_probability_1_; }
            inline double getProbability1() const { return m_probability_1_; }

            inline void setNumberTransitions00(double value_) { m_number_transitions_00_ = value_; }
            inline void setNumberTransitions01(double value_) { m_number_transitions_01_ = value_; }
            inline void setNumberTransitions11(double value_) { m_number_transitions_11_ = value_; }
            inline void setFrequencyMultiplier(double value_) { m_frequency_multiplier_ = value_; }

            void update();
            TransitionInfo scaleFrequencyMultiplier(double frequency_multiplier_) const;

            void print(std::ostream& ost_) const;

        private:
            // m_number_transitions_xy_ defines number of transitions from x to y
            double m_number_transitions_00_;
            double m_number_transitions_01_;
            double m_number_transitions_11_;
            // The multiplier that defines the ratio of the transition frequency and the main core clock frequency
            double m_frequency_multiplier_;
            // Probability of being at state 0/1
            double m_probability_0_;
            double m_probability_1_;
    }; // class TransitionInfo
} // namespace DSENT

#endif // __DSENT_MODEL_TRANSITION_INFO_H__