src/base/temperature.hh

   1 /*
   2  * Copyright (c) 2021 Arm Limited
   3  * All rights reserved
   4  *
   5  * The license below extends only to copyright in the software and shall
   6  * not be construed as granting a license to any other intellectual
   7  * property including but not limited to intellectual property relating
   8  * to a hardware implementation of the functionality of the software
   9  * licensed hereunder.  You may use the software subject to the license
  10  * terms below provided that you ensure that this notice is replicated
  11  * unmodified and in its entirety in all distributions of the software,
  12  * modified or unmodified, in source code or in binary form.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions are
  16  * met: redistributions of source code must retain the above copyright
  17  * notice, this list of conditions and the following disclaimer;
  18  * redistributions in binary form must reproduce the above copyright
  19  * notice, this list of conditions and the following disclaimer in the
  20  * documentation and/or other materials provided with the distribution;
  21  * neither the name of the copyright holders nor the names of its
  22  * contributors may be used to endorse or promote products derived from
  23  * this software without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 #ifndef __BASE_TEMPERATURE_HH__
  39 #define __BASE_TEMPERATURE_HH__
  40
  41 #include <ostream>
  42
  43 /**
  44  * The class stores temperatures in Kelvin and provides helper methods
  45  * to convert to/from Celsius.
  46  */
  47 class Temperature
  48 {
  49
  50   private:
  51     /** Temperature in Kelvin */
  52     double value;
  53
  54   public:
  55     /** Explicit constructor assigning a value. */
  56     explicit constexpr Temperature(double _value=0.0)
  57         : value(_value)
  58     {
  59     }
  60
  61     static Temperature fromKelvin(double _value);
  62     static Temperature fromCelsius(double _value);
  63     static Temperature fromFahrenheit(double _value);
  64
  65     constexpr double toKelvin() const { return value; }
  66     constexpr double toCelsius() const { return value - 273.15; }
  67     double toFahrenheit() const;
  68
  69     constexpr bool
  70     operator>(const Temperature &rhs) const
  71     {
  72         return value > rhs.value;
  73     }
  74
  75     constexpr bool
  76     operator>=(const Temperature &rhs) const
  77     {
  78         return value >= rhs.value;
  79     }
  80
  81     constexpr bool
  82     operator<(const Temperature &rhs) const
  83     {
  84         return value < rhs.value;
  85     }
  86
  87     constexpr bool
  88     operator<=(const Temperature &rhs) const
  89     {
  90         return value <= rhs.value;
  91     }
  92
  93     constexpr bool
  94     operator==(const Temperature &rhs) const
  95     {
  96         return value == rhs.value;
  97     }
  98
  99     constexpr bool
 100     operator!=(const Temperature &rhs) const
 101     {
 102         return value != rhs.value;
 103     }
 104
 105     constexpr Temperature
 106     operator+(const Temperature &rhs) const
 107     {
 108         return Temperature(value + rhs.value);
 109     }
 110
 111     constexpr Temperature
 112     operator-(const Temperature &rhs) const
 113     {
 114         return Temperature(value - rhs.value);
 115     }
 116
 117     friend constexpr Temperature operator*(
 118         const Temperature &lhs, const double &rhs);
 119
 120     friend constexpr Temperature operator*(
 121         const double &lhs, const Temperature &rhs);
 122
 123     friend constexpr Temperature operator/(
 124         const Temperature &lhs, const double &rhs);
 125
 126     Temperature &
 127     operator+=(const Temperature &rhs)
 128     {
 129         value += rhs.value;
 130         return *this;
 131     }
 132
 133     Temperature &
 134     operator-=(const Temperature &rhs)
 135     {
 136         value -= rhs.value;
 137         return *this;
 138     }
 139
 140     Temperature &
 141     operator*=(const double &rhs)
 142     {
 143         value *= rhs;
 144         return *this;
 145     }
 146
 147     Temperature &
 148     operator/=(const double &rhs)
 149     {
 150         value /= rhs;
 151         return *this;
 152     }
 153
 154     friend std::ostream &operator<<(std::ostream &out, const Temperature &t);
 155 };
 156
 157 constexpr Temperature
 158 operator*(const Temperature &lhs, const double &rhs)
 159 {
 160     return Temperature(lhs.value * rhs);
 161 }
 162
 163 constexpr Temperature
 164 operator*(const double &lhs, const Temperature &rhs)
 165 {
 166     return Temperature(lhs * rhs.value);
 167 }
 168
 169 constexpr Temperature
 170 operator/(const Temperature &lhs, const double &rhs)
 171 {
 172     return Temperature(lhs.value / rhs);
 173 }
 174
 175
 176 #endif // __BASE_TEMPERATURE_HH__