base, python: Add a Temperature type and associated param
Add a class to represent a temperature. The class stores temperatures in Kelvin and provides helper methods to convert to/from Celsius. The corresponding param type automatically converts from Kelvin, Celsius, and Fahrenheit to the underlying C++ type. Change-Id: I5783cc4f4fecbea5aba9821dfc71bfa77c3f75a9 Signed-off-by: Andreas Sandberg <andreas.sandberg@arm.com> Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/39218 Maintainer: Jason Lowe-Power <power.jg@gmail.com> Reviewed-by: Daniel Carvalho <odanrc@yahoo.com.br> Reviewed-by: Gabe Black <gabe.black@gmail.com> Tested-by: kokoro <noreply+kokoro@google.com>
This commit is contained in:
Andreas Sandberg
@@ -72,6 +72,8 @@ Source('str.cc')
|
||||
GTest('str.test', 'str.test.cc', 'str.cc')
|
||||
Source('time.cc')
|
||||
Source('version.cc')
|
||||
Source('temperature.cc')
|
||||
GTest('temperature.test', 'temperature.test.cc', 'temperature.cc')
|
||||
Source('trace.cc')
|
||||
GTest('trie.test', 'trie.test.cc')
|
||||
Source('types.cc')
|
||||
|
||||
69
src/base/temperature.cc
Normal file
69
src/base/temperature.cc
Normal file
@@ -0,0 +1,69 @@
|
||||
/*
|
||||
* Copyright (c) 2021 Arm Limited
|
||||
* All rights reserved
|
||||
*
|
||||
* The license below extends only to copyright in the software and shall
|
||||
* not be construed as granting a license to any other intellectual
|
||||
* property including but not limited to intellectual property relating
|
||||
* to a hardware implementation of the functionality of the software
|
||||
* licensed hereunder. You may use the software subject to the license
|
||||
* terms below provided that you ensure that this notice is replicated
|
||||
* unmodified and in its entirety in all distributions of the software,
|
||||
* modified or unmodified, in source code or in binary form.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions are
|
||||
* met: redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer;
|
||||
* redistributions in binary form must reproduce the above copyright
|
||||
* notice, this list of conditions and the following disclaimer in the
|
||||
* documentation and/or other materials provided with the distribution;
|
||||
* neither the name of the copyright holders nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from
|
||||
* this software without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
|
||||
#include "base/temperature.hh"
|
||||
|
||||
Temperature
|
||||
Temperature::fromKelvin(double _value)
|
||||
{
|
||||
return Temperature(_value);
|
||||
}
|
||||
|
||||
Temperature
|
||||
Temperature::fromCelsius(double _value)
|
||||
{
|
||||
return Temperature(273.15 + _value);
|
||||
}
|
||||
|
||||
Temperature
|
||||
Temperature::fromFahrenheit(double _value)
|
||||
{
|
||||
return Temperature((_value + 459.67) / 1.8);
|
||||
}
|
||||
|
||||
double
|
||||
Temperature::toFahrenheit() const
|
||||
{
|
||||
return value * 1.8 - 459.67;
|
||||
}
|
||||
|
||||
std::ostream &
|
||||
operator<<(std::ostream &out, const Temperature &temp)
|
||||
{
|
||||
out << temp.value << "K";
|
||||
return out;
|
||||
}
|
||||
176
src/base/temperature.hh
Normal file
176
src/base/temperature.hh
Normal file
@@ -0,0 +1,176 @@
|
||||
/*
|
||||
* Copyright (c) 2021 Arm Limited
|
||||
* All rights reserved
|
||||
*
|
||||
* The license below extends only to copyright in the software and shall
|
||||
* not be construed as granting a license to any other intellectual
|
||||
* property including but not limited to intellectual property relating
|
||||
* to a hardware implementation of the functionality of the software
|
||||
* licensed hereunder. You may use the software subject to the license
|
||||
* terms below provided that you ensure that this notice is replicated
|
||||
* unmodified and in its entirety in all distributions of the software,
|
||||
* modified or unmodified, in source code or in binary form.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions are
|
||||
* met: redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer;
|
||||
* redistributions in binary form must reproduce the above copyright
|
||||
* notice, this list of conditions and the following disclaimer in the
|
||||
* documentation and/or other materials provided with the distribution;
|
||||
* neither the name of the copyright holders nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from
|
||||
* this software without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
|
||||
#ifndef __BASE_TEMPERATURE_HH__
|
||||
#define __BASE_TEMPERATURE_HH__
|
||||
|
||||
#include <ostream>
|
||||
|
||||
/**
|
||||
* The class stores temperatures in Kelvin and provides helper methods
|
||||
* to convert to/from Celsius.
|
||||
*/
|
||||
class Temperature
|
||||
{
|
||||
|
||||
private:
|
||||
/** Temperature in Kelvin */
|
||||
double value;
|
||||
|
||||
public:
|
||||
/** Explicit constructor assigning a value. */
|
||||
explicit constexpr Temperature(double _value=0.0)
|
||||
: value(_value)
|
||||
{
|
||||
}
|
||||
|
||||
static Temperature fromKelvin(double _value);
|
||||
static Temperature fromCelsius(double _value);
|
||||
static Temperature fromFahrenheit(double _value);
|
||||
|
||||
constexpr double toKelvin() const { return value; }
|
||||
constexpr double toCelsius() const { return value - 273.15; }
|
||||
double toFahrenheit() const;
|
||||
|
||||
constexpr bool
|
||||
operator>(const Temperature &rhs) const
|
||||
{
|
||||
return value > rhs.value;
|
||||
}
|
||||
|
||||
constexpr bool
|
||||
operator>=(const Temperature &rhs) const
|
||||
{
|
||||
return value >= rhs.value;
|
||||
}
|
||||
|
||||
constexpr bool
|
||||
operator<(const Temperature &rhs) const
|
||||
{
|
||||
return value < rhs.value;
|
||||
}
|
||||
|
||||
constexpr bool
|
||||
operator<=(const Temperature &rhs) const
|
||||
{
|
||||
return value <= rhs.value;
|
||||
}
|
||||
|
||||
constexpr bool
|
||||
operator==(const Temperature &rhs) const
|
||||
{
|
||||
return value == rhs.value;
|
||||
}
|
||||
|
||||
constexpr bool
|
||||
operator!=(const Temperature &rhs) const
|
||||
{
|
||||
return value != rhs.value;
|
||||
}
|
||||
|
||||
constexpr Temperature
|
||||
operator+(const Temperature &rhs) const
|
||||
{
|
||||
return Temperature(value + rhs.value);
|
||||
}
|
||||
|
||||
constexpr Temperature
|
||||
operator-(const Temperature &rhs) const
|
||||
{
|
||||
return Temperature(value - rhs.value);
|
||||
}
|
||||
|
||||
friend constexpr Temperature operator*(
|
||||
const Temperature &lhs, const double &rhs);
|
||||
|
||||
friend constexpr Temperature operator*(
|
||||
const double &lhs, const Temperature &rhs);
|
||||
|
||||
friend constexpr Temperature operator/(
|
||||
const Temperature &lhs, const double &rhs);
|
||||
|
||||
Temperature &
|
||||
operator+=(const Temperature &rhs)
|
||||
{
|
||||
value += rhs.value;
|
||||
return *this;
|
||||
}
|
||||
|
||||
Temperature &
|
||||
operator-=(const Temperature &rhs)
|
||||
{
|
||||
value -= rhs.value;
|
||||
return *this;
|
||||
}
|
||||
|
||||
Temperature &
|
||||
operator*=(const double &rhs)
|
||||
{
|
||||
value *= rhs;
|
||||
return *this;
|
||||
}
|
||||
|
||||
Temperature &
|
||||
operator/=(const double &rhs)
|
||||
{
|
||||
value /= rhs;
|
||||
return *this;
|
||||
}
|
||||
|
||||
friend std::ostream &operator<<(std::ostream &out, const Temperature &t);
|
||||
};
|
||||
|
||||
constexpr Temperature
|
||||
operator*(const Temperature &lhs, const double &rhs)
|
||||
{
|
||||
return Temperature(lhs.value * rhs);
|
||||
}
|
||||
|
||||
constexpr Temperature
|
||||
operator*(const double &lhs, const Temperature &rhs)
|
||||
{
|
||||
return Temperature(lhs * rhs.value);
|
||||
}
|
||||
|
||||
constexpr Temperature
|
||||
operator/(const Temperature &lhs, const double &rhs)
|
||||
{
|
||||
return Temperature(lhs.value / rhs);
|
||||
}
|
||||
|
||||
|
||||
#endif // __BASE_TEMPERATURE_HH__
|
||||
123
src/base/temperature.test.cc
Normal file
123
src/base/temperature.test.cc
Normal file
@@ -0,0 +1,123 @@
|
||||
/*
|
||||
* Copyright (c) 2021 Arm Limited
|
||||
* All rights reserved
|
||||
*
|
||||
* The license below extends only to copyright in the software and shall
|
||||
* not be construed as granting a license to any other intellectual
|
||||
* property including but not limited to intellectual property relating
|
||||
* to a hardware implementation of the functionality of the software
|
||||
* licensed hereunder. You may use the software subject to the license
|
||||
* terms below provided that you ensure that this notice is replicated
|
||||
* unmodified and in its entirety in all distributions of the software,
|
||||
* modified or unmodified, in source code or in binary form.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions are
|
||||
* met: redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer;
|
||||
* redistributions in binary form must reproduce the above copyright
|
||||
* notice, this list of conditions and the following disclaimer in the
|
||||
* documentation and/or other materials provided with the distribution;
|
||||
* neither the name of the copyright holders nor the names of its
|
||||
* contributors may be used to endorse or promote products derived from
|
||||
* this software without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
#include <sstream>
|
||||
|
||||
#include "base/temperature.hh"
|
||||
|
||||
TEST(TemperatureTest, Constructor)
|
||||
{
|
||||
Temperature temp;
|
||||
EXPECT_EQ(temp, Temperature(0.0));
|
||||
}
|
||||
|
||||
TEST(TemperatureTest, Conversion)
|
||||
{
|
||||
Temperature freezing(273.15);
|
||||
|
||||
EXPECT_EQ(Temperature::fromKelvin(42.0), Temperature(42.0));
|
||||
EXPECT_EQ(Temperature::fromCelsius(0.0), freezing);
|
||||
EXPECT_EQ(Temperature::fromFahrenheit(32.0), freezing);
|
||||
|
||||
EXPECT_EQ(freezing.toKelvin(), 273.15);
|
||||
EXPECT_EQ(freezing.toCelsius(), 0.0);
|
||||
EXPECT_EQ(Temperature(0).toFahrenheit(), -459.67);
|
||||
}
|
||||
|
||||
TEST(TemperatureTest, Comparison)
|
||||
{
|
||||
EXPECT_TRUE(Temperature(2.0) < Temperature(3.0));
|
||||
EXPECT_FALSE(Temperature(2.0) < Temperature(2.0));
|
||||
EXPECT_FALSE(Temperature(2.0) < Temperature(1.0));
|
||||
|
||||
EXPECT_FALSE(Temperature(2.0) > Temperature(3.0));
|
||||
EXPECT_FALSE(Temperature(2.0) > Temperature(2.0));
|
||||
EXPECT_TRUE(Temperature(2.0) > Temperature(1.0));
|
||||
|
||||
EXPECT_TRUE(Temperature(2.0) <= Temperature(3.0));
|
||||
EXPECT_TRUE(Temperature(2.0) <= Temperature(2.0));
|
||||
EXPECT_FALSE(Temperature(2.0) <= Temperature(1.0));
|
||||
|
||||
EXPECT_FALSE(Temperature(2.0) >= Temperature(3.0));
|
||||
EXPECT_TRUE(Temperature(2.0) >= Temperature(2.0));
|
||||
EXPECT_TRUE(Temperature(2.0) >= Temperature(1.0));
|
||||
|
||||
EXPECT_TRUE(Temperature(2.0) == Temperature(2.0));
|
||||
EXPECT_FALSE(Temperature(2.0) == Temperature(3.0));
|
||||
|
||||
EXPECT_FALSE(Temperature(2.0) != Temperature(2.0));
|
||||
EXPECT_TRUE(Temperature(2.0) != Temperature(3.0));
|
||||
}
|
||||
|
||||
TEST(TemperatureTest, BinaryOperators)
|
||||
{
|
||||
EXPECT_EQ(Temperature(2.0) + Temperature(1.0), Temperature(3.0));
|
||||
EXPECT_EQ(Temperature(2.0) - Temperature(1.0), Temperature(1.0));
|
||||
|
||||
EXPECT_EQ(Temperature(8.0) * 2.0, Temperature(16.0));
|
||||
EXPECT_EQ(2.0 * Temperature(8.0), Temperature(16.0));
|
||||
EXPECT_EQ(Temperature(8.0) / 2.0, Temperature(4.0));
|
||||
}
|
||||
|
||||
TEST(TemperatureTest, AssignmentOperators)
|
||||
{
|
||||
Temperature temp1(0);
|
||||
temp1 += Temperature(1.0);
|
||||
EXPECT_EQ(temp1, Temperature(1.0));
|
||||
|
||||
Temperature temp2(1.0);
|
||||
temp2 -= Temperature(1.0);
|
||||
EXPECT_EQ(temp2, Temperature(0.0));
|
||||
|
||||
Temperature temp3(32.0);
|
||||
temp3 *= 2.0;
|
||||
EXPECT_EQ(temp3, Temperature(64.0));
|
||||
|
||||
Temperature temp4(32.0);
|
||||
temp4 /= 2.0;
|
||||
EXPECT_EQ(temp4, Temperature(16.0));
|
||||
}
|
||||
|
||||
TEST(TemperatureTest, OutStream)
|
||||
{
|
||||
Temperature temp(42);
|
||||
std::ostringstream ss;
|
||||
ss << "T: " << temp << std::endl;
|
||||
EXPECT_EQ("T: 42K\n", ss.str());
|
||||
}
|
||||
Reference in New Issue
Block a user