mpusz/mp-units
1
0
Fork 1
mirror of https://github.com/mpusz/mp-units.git synced 2025-07-30 18:37:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Text output support added for quantity

Browse Source
This commit is contained in:
Mateusz Pusz
2019-10-16 17:04:41 +02:00
parent fe6a5da3f4
commit 9a9abca81d
7 changed files with 316 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/include/units/bits/fixed_string.h
View File

@ -21,6 +21,7 @@
// SOFTWARE. // SOFTWARE.
#include <cstdlib> #include <cstdlib>
#include <ostream>
namespace units { namespace units {
@ -68,6 +69,12 @@ namespace units {
} }
return first1 == last1 && first2 != last2; return first1 == last1 && first2 != last2;
} }
template<class Traits>
friend std::basic_ostream<CharT, Traits>& operator<<(std::basic_ostream<CharT, Traits>& os, const basic_fixed_string& txt)
{
return os << txt.c_str();
}
}; };
template<typename CharT, std::size_t N> template<typename CharT, std::size_t N>

106
src/include/units/format.h Normal file
View File

@ -0,0 +1,106 @@
// The MIT License (MIT)
//
// Copyright (c) 2018 Mateusz Pusz
//
// 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.
#pragma once
#include <units/quantity.h>
namespace units {
namespace detail {
template<typename Ratio, typename CharT, typename Traits>
void print_ratio(std::basic_ostream<CharT, Traits>& os)
{
if constexpr(Ratio::num != 1 || Ratio::den != 1) {
if constexpr(Ratio::den == 1) {
os << "[" << Ratio::num << "]";
}
else {
os << "[" << Ratio::num << "/" << Ratio::den << "]";
}
}
}
template<typename Ratio>
inline constexpr std::string_view ratio_txt = "";
template<> inline constexpr std::string_view ratio_txt<ratio<1, std::atto::den>> = "a";
template<> inline constexpr std::string_view ratio_txt<ratio<1, std::femto::den>> = "f";
template<> inline constexpr std::string_view ratio_txt<ratio<1, std::pico::den>> = "p";
template<> inline constexpr std::string_view ratio_txt<ratio<1, std::nano::den>> = "n";
template<> inline constexpr std::string_view ratio_txt<ratio<1, std::micro::den>> = "\u00b5\u0073";
template<> inline constexpr std::string_view ratio_txt<ratio<1, std::milli::den>> = "m";
template<> inline constexpr std::string_view ratio_txt<ratio<1, std::centi::den>> = "c";
template<> inline constexpr std::string_view ratio_txt<ratio<1, std::deci::den>> = "d";
template<> inline constexpr std::string_view ratio_txt<ratio<std::deca::num>> = "da";
template<> inline constexpr std::string_view ratio_txt<ratio<std::hecto::num>> = "h";
template<> inline constexpr std::string_view ratio_txt<ratio<std::kilo::num>> = "k";
template<> inline constexpr std::string_view ratio_txt<ratio<std::mega::num>> = "M";
template<> inline constexpr std::string_view ratio_txt<ratio<std::giga::num>> = "G";
template<> inline constexpr std::string_view ratio_txt<ratio<std::tera::num>> = "T";
template<> inline constexpr std::string_view ratio_txt<ratio<std::peta::num>> = "P";
template<> inline constexpr std::string_view ratio_txt<ratio<std::exa::num>> = "E";
template<typename Ratio, typename CharT, typename Traits>
void print_prefix_or_ratio(std::basic_ostream<CharT, Traits>& os)
{
if constexpr(Ratio::num != 1 || Ratio::den != 1) {
constexpr auto prefix = ratio_txt<Ratio>;
if constexpr(prefix != "") {
// print as a prefixed unit
os << prefix;
}
else {
// print as a ratio of the coherent unit
print_ratio<Ratio>(os);
}
}
}
template<typename CharT, typename Traits, typename... Es>
void print_dimensions(std::basic_ostream<CharT, Traits>& os, dimension<Es...>)
{
bool first = true;
auto ingr_printer = [&]<typename E>(E) {
if constexpr(E::num < 0) {
os << (first ? "1/" : "/");
}
else {
os << (first ? "" : "*");
}
os << E::dimension::symbol;
if constexpr(E::den != 1) {
os << "^(" << abs(E::num) << "/" << E::den << ")";
}
else if constexpr(abs(E::num) != 1) {
os << "^" << abs(E::num);
}
first = false;
};
(ingr_printer(Es{}), ...);
}
}
} // namespace units

39
src/include/units/quantity.h
View File

@ -24,7 +24,9 @@
#include <units/bits/concepts.h> #include <units/bits/concepts.h>
#include <units/unit.h> #include <units/unit.h>
#include <units/format.h>
#include <limits> #include <limits>
#include <ostream>
namespace units { namespace units {
@ -275,6 +277,37 @@ namespace units {
value_ %= q.count(); value_ %= q.count();
return *this; return *this;
} }
template<class CharT, class Traits>
friend std::basic_ostream<CharT, Traits>& operator<<(std::basic_ostream<CharT, Traits>& os, const quantity& q)
{
os << q.count() << " ";
if constexpr(!detail::is_unit<quantity::unit>) {
// print user-defined unit
os << unit::symbol::c_str();
}
else {
using ratio = quantity::unit::ratio;
using dim = quantity::unit::dimension;
if constexpr(!detail::is_dimension<dim>) {
// print as a prefix or ratio of a coherent unit
detail::print_prefix_or_ratio<ratio>(os);
if constexpr(!detail::is_dimension<dim>) {
// print coherent unit symbol defined by the user
os << downcast_target<units::unit<dim>>::symbol::c_str();
}
}
else {
// print as a ratio of a coherent unit
detail::print_ratio<ratio>(os);
// print coherent unit dimensions and their exponents
detail::print_dimensions(os, dim{});
}
}
return os;
}
}; };
template<typename U1, typename Rep1, typename U2, typename Rep2> template<typename U1, typename Rep1, typename U2, typename Rep2>
@ -442,9 +475,3 @@ namespace units {
} }
} // namespace units } // namespace units
// template<class charT, class traits, class Rep, class Period>
// basic_ostream<charT, traits>&
// operator<<(basic_ostream<charT, traits>& os,
// const duration<Rep, Period>& d);

1
test/unit_test/runtime/CMakeLists.txt
View File

@ -23,6 +23,7 @@
add_executable(unit_tests_runtime add_executable(unit_tests_runtime
catch_main.cpp catch_main.cpp
math_test.cpp math_test.cpp
text_test.cpp
) )
target_link_libraries(unit_tests_runtime target_link_libraries(unit_tests_runtime
PRIVATE PRIVATE

1
test/unit_test/runtime/math_test.cpp
View File

@ -21,7 +21,6 @@
// SOFTWARE. // SOFTWARE.
#include "units/math.h" #include "units/math.h"
#include "print_helpers.h"
#include "units/dimensions/area.h" #include "units/dimensions/area.h"
#include "units/dimensions/volume.h" #include "units/dimensions/volume.h"
#include <catch2/catch.hpp> #include <catch2/catch.hpp>

36
test/unit_test/runtime/print_helpers.h
View File

@ -1,36 +0,0 @@
// The MIT License (MIT)
//
// Copyright (c) 2018 Mateusz Pusz
//
// 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.
#include "units/dimensions/area.h"
#include <ostream>
// TODO Remove when a text formatting is implemented
namespace units {
template<typename Unit, typename Rep>
std::ostream& operator<<(std::ostream& os, const quantity<Unit, Rep>& value)
{
return os << value.count() << Unit::symbol::c_str();
}
}

169
test/unit_test/runtime/text_test.cpp Normal file
View File

@ -0,0 +1,169 @@
// The MIT License (MIT)
//
// Copyright (c) 2018 Mateusz Pusz
//
// 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.
#include "units/dimensions/area.h"
#include "units/dimensions/frequency.h"
#include "units/dimensions/power.h"
#include "units/dimensions/velocity.h"
#include "units/dimensions/volume.h"
#include "units/math.h"
#include <catch2/catch.hpp>
#include <sstream>
using namespace units;
TEST_CASE("operator<< on a quantity", "[text][ostream]")
{
std::stringstream stream;
SECTION("quantity with a predefined unit")
{
SECTION("integral representation")
{
stream << 16sq_m;
REQUIRE(stream.str() == "16 m^2");
}
SECTION("floating-point representation")
{
stream << 72.5kmph;
REQUIRE(stream.str() == "72.5 km/h");
}
}
SECTION("quantity with a predefined dimension but unknown unit")
{
SECTION("unit::ratio as an SI prefix")
{
stream << 4.N * 2cm;
REQUIRE(stream.str() == "8 cJ");
}
SECTION("unit::ratio::num != 1 && unit::ratio::den == 1")
{
stream << 4 * 2min / (2s * 2s);
REQUIRE(stream.str() == "2 [60]Hz");
}
SECTION("unit::ratio::num == 1 && unit::ratio::den != 1")
{
stream << 20._J / 2min;
REQUIRE(stream.str() == "10 [1/60]W");
}
SECTION("unit::ratio::num != 1 && unit::ratio::den != 1")
{
stream << 60.kJ / 2min;
REQUIRE(stream.str() == "30 [50/3]W");
}
}
SECTION("quantity with an unkown dimension")
{
SECTION("unit::ratio::num == 1 && unit::ratio::den == 1")
{
stream << 2s * 2m * 2kg;
REQUIRE(stream.str() == "8 m*kg*s");
}
SECTION("unit::ratio as an SI prefix")
{
stream << 4km * 2s;
REQUIRE(stream.str() == "8 [1000]m*s");
}
SECTION("unit::ratio::num != 1 && unit::ratio::den == 1")
{
stream << 4kg * 2min / (2s * 2s);
REQUIRE(stream.str() == "2 [60]kg/s");
}
SECTION("unit::ratio::num == 1 && unit::ratio::den != 1")
{
stream << 20.kg / 2min;
REQUIRE(stream.str() == "10 [1/60]kg/s");
}
SECTION("unit::ratio::num != 1 && unit::ratio::den != 1")
{
stream << 60.min / 2km;
REQUIRE(stream.str() == "30 [3/50]1/m*s");
}
SECTION("exp::num == 1 && exp::den == 1")
{
stream << 4m * 2s;
REQUIRE(stream.str() == "8 m*s");
}
SECTION("exp::num == 2 && exp::den == 1 for positive exponent")
{
stream << 4m * 2s * 2s;
REQUIRE(stream.str() == "16 m*s^2");
}
SECTION("exp::num == 2 && exp::den == 1 for negative exponent (first dimension)")
{
stream << 8.s / 2m / 2m;
REQUIRE(stream.str() == "2 1/m^2*s");
}
SECTION("exp::num == 2 && exp::den == 1 for negative exponent (not first dimension)")
{
stream << 8.m / 2kg / 2kg;
REQUIRE(stream.str() == "2 m/kg^2");
}
SECTION("fractional positive exponent")
{
stream << sqrt(9.m);
REQUIRE(stream.str() == "3 m^(1/2)");
}
SECTION("fractional negative exponent")
{
stream << sqrt(9 / 1.m);
REQUIRE(stream.str() == "3 1/m^(1/2)");
}
}
}
// SCENARIO("default format '{}' produces the same output as operator<<", "[text][fmt]")
// {
// GIVEN("A quantity q") {
// auto q = 2m;
// REQUIRE(q.count() == 2);
// WHEN("format(\"{}\", q) is called") {
// std::string fmtstr = format("{}", q);
// THEN("the same output as operator<< is returned") {
// std::stringstream stream;
// stream << q;
// REQUIRE(fmtstr == stream.str());
// }
// }
// }
// }
// Restate operator<< definitions in terms of std::format to make I/O manipulators apply to whole objects
// rather than their parts