mpusz/mp-units
1
0
Fork 1
mirror of https://github.com/mpusz/mp-units.git synced 2025-08-02 11:54:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: hello_units example updated with aliases

Browse Source
This commit is contained in:
Mateusz Pusz
2021-04-17 11:52:49 +02:00
parent c6d195fc13
commit 669332061f
2 changed files with 56 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@@ -66,15 +66,16 @@ and dimensional analysis can be performed without sacrificing on accuracy. Pleas
the below example for a quick preview of basic library features: the below example for a quick preview of basic library features:
```cpp ```cpp
#define UNITS_REFERENCES #define UNITS_ALIASES
#define UNITS_LITERALS #define UNITS_LITERALS
#define UNITS_REFERENCES
#include <units/format.h> #include <units/format.h>
#include <units/isq/si/length.h>
#include <units/isq/si/speed.h>
#include <units/isq/si/time.h>
#include <units/isq/si/international/length.h> #include <units/isq/si/international/length.h>
#include <units/isq/si/international/speed.h> #include <units/isq/si/international/speed.h> // IWYU pragma: keep
#include <units/isq/si/length.h>
#include <units/isq/si/speed.h> // IWYU pragma: keep
#include <units/isq/si/time.h>
#include <units/quantity_io.h> #include <units/quantity_io.h>
#include <iostream> #include <iostream>
@@ -89,21 +90,29 @@ int main()
{ {
using namespace units::isq::si::literals; using namespace units::isq::si::literals;
using namespace units::isq::si::references; using namespace units::isq::si::references;
using namespace units::aliases::isq::si::international;
constexpr Speed auto v1 = 110 * (km / h); constexpr Speed auto v1 = 110 * (km / h);
constexpr Speed auto v2 = avg_speed(220_q_km, 2_q_h); constexpr Speed auto v2 = mi_per_h(70.);
constexpr Speed auto v3 = avg_speed(si::length<si::international::mile>(140), si::time<si::hour>(2)); constexpr Speed auto v3 = avg_speed(220_q_km, 2_q_h);
constexpr Speed auto v4 = units::quantity_cast<si::speed<si::metre_per_second>>(v2); constexpr Speed auto v4 = avg_speed(si::length<si::international::mile>(140), si::time<si::hour>(2));
constexpr Speed auto v5 = units::quantity_cast<si::metre_per_second>(v3); #if UNITS_DOWNCAST_MODE == 0
constexpr Speed auto v6 = units::quantity_cast<int>(v5); constexpr Speed auto v5 = quantity_cast<si::speed<si::metre_per_second>>(v3);
constexpr Speed auto v6 = quantity_cast<si::dim_speed, si::metre_per_second>(v4);
#else
constexpr Speed auto v5 = quantity_cast<si::speed<si::metre_per_second>>(v3);
constexpr Speed auto v6 = quantity_cast<si::metre_per_second>(v4);
#endif
constexpr Speed auto v7 = quantity_cast<int>(v6);
std::cout << v1 << '\n'; // 110 km/h std::cout << v1 << '\n'; // 110 km/h
std::cout << fmt::format("{}", v2) << '\n'; // 110 km/h std::cout << v2 << '\n'; // 70 mi/h
std::cout << fmt::format("{:*^14}", v3) << '\n'; // ***70 mi/h**** std::cout << fmt::format("{}", v3) << '\n'; // 110 km/h
std::cout << fmt::format("{:%Q in %q}", v4) << '\n'; // 30.5556 in m/s std::cout << fmt::format("{:*^14}", v4) << '\n'; // ***70 mi/h****
std::cout << fmt::format("{0:%Q} in {0:%q}", v5) << '\n'; // 31.2928 in m/s std::cout << fmt::format("{:%Q in %q}", v5) << '\n'; // 30.5556 in m/s
std::cout << fmt::format("{:%Q}", v6) << '\n'; // 31 std::cout << fmt::format("{0:%Q} in {0:%q}", v6) << '\n'; // 31.2928 in m/s
std::cout << fmt::format("{:%Q}", v7) << '\n'; // 31
} }
``` ```
_Try it on the [Compiler Explorer](https://godbolt.org/z/7sshE7o58)._ _Try it on the [Compiler Explorer](https://godbolt.org/z/WP39WvE6M)._

41
docs/quick_start.rst
View File

@@ -42,15 +42,16 @@ but still easy to use interface where all unit conversions and dimensional analy
performed without sacrificing on accuracy. Please see the below example for a quick preview performed without sacrificing on accuracy. Please see the below example for a quick preview
of basic library features:: of basic library features::
#define UNITS_REFERENCES #define UNITS_ALIASES
#define UNITS_LITERALS #define UNITS_LITERALS
#define UNITS_REFERENCES
#include <units/format.h> #include <units/format.h>
#include <units/isq/si/length.h>
#include <units/isq/si/speed.h>
#include <units/isq/si/time.h>
#include <units/isq/si/international/length.h> #include <units/isq/si/international/length.h>
#include <units/isq/si/international/speed.h> #include <units/isq/si/international/speed.h> // IWYU pragma: keep
#include <units/isq/si/length.h>
#include <units/isq/si/speed.h> // IWYU pragma: keep
#include <units/isq/si/time.h>
#include <units/quantity_io.h> #include <units/quantity_io.h>
#include <iostream> #include <iostream>
@@ -65,25 +66,33 @@ of basic library features::
{ {
using namespace units::isq::si::literals; using namespace units::isq::si::literals;
using namespace units::isq::si::references; using namespace units::isq::si::references;
using namespace units::aliases::isq::si::international;
constexpr Speed auto v1 = 110 * (km / h); constexpr Speed auto v1 = 110 * (km / h);
constexpr Speed auto v2 = avg_speed(220_q_km, 2_q_h); constexpr Speed auto v2 = mi_per_h(70.);
constexpr Speed auto v3 = avg_speed(si::length<si::international::mile>(140), si::time<si::hour>(2)); constexpr Speed auto v3 = avg_speed(220_q_km, 2_q_h);
constexpr Speed auto v4 = units::quantity_cast<si::speed<si::metre_per_second>>(v2); constexpr Speed auto v4 = avg_speed(si::length<si::international::mile>(140), si::time<si::hour>(2));
constexpr Speed auto v5 = units::quantity_cast<si::metre_per_second>(v3); #if UNITS_DOWNCAST_MODE == 0
constexpr Speed auto v6 = units::quantity_cast<int>(v5); constexpr Speed auto v5 = quantity_cast<si::speed<si::metre_per_second>>(v3);
constexpr Speed auto v6 = quantity_cast<si::dim_speed, si::metre_per_second>(v4);
#else
constexpr Speed auto v5 = quantity_cast<si::speed<si::metre_per_second>>(v3);
constexpr Speed auto v6 = quantity_cast<si::metre_per_second>(v4);
#endif
constexpr Speed auto v7 = quantity_cast<int>(v6);
std::cout << v1 << '\n'; // 110 km/h std::cout << v1 << '\n'; // 110 km/h
std::cout << fmt::format("{}", v2) << '\n'; // 110 km/h std::cout << v2 << '\n'; // 70 mi/h
std::cout << fmt::format("{:*^14}", v3) << '\n'; // ***70 mi/h**** std::cout << fmt::format("{}", v3) << '\n'; // 110 km/h
std::cout << fmt::format("{:%Q in %q}", v4) << '\n'; // 30.5556 in m/s std::cout << fmt::format("{:*^14}", v4) << '\n'; // ***70 mi/h****
std::cout << fmt::format("{0:%Q} in {0:%q}", v5) << '\n'; // 31.2928 in m/s std::cout << fmt::format("{:%Q in %q}", v5) << '\n'; // 30.5556 in m/s
std::cout << fmt::format("{:%Q}", v6) << '\n'; // 31 std::cout << fmt::format("{0:%Q} in {0:%q}", v6) << '\n'; // 31.2928 in m/s
std::cout << fmt::format("{:%Q}", v7) << '\n'; // 31
} }
.. admonition:: Try it on Compiler Explorer .. admonition:: Try it on Compiler Explorer
`Example #2 <https://godbolt.org/z/7sshE7o58>`_ `Example #2 <https://godbolt.org/z/WP39WvE6M>`_
.. seealso:: .. seealso::