diff --git a/README.md b/README.md index b81025d1..070a671e 100644 --- a/README.md +++ b/README.md @@ -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: ```cpp -#define UNITS_REFERENCES +#define UNITS_ALIASES #define UNITS_LITERALS +#define UNITS_REFERENCES #include -#include -#include -#include #include -#include +#include // IWYU pragma: keep +#include +#include // IWYU pragma: keep +#include #include #include @@ -89,21 +90,29 @@ int main() { using namespace units::isq::si::literals; using namespace units::isq::si::references; + using namespace units::aliases::isq::si::international; constexpr Speed auto v1 = 110 * (km / h); - constexpr Speed auto v2 = avg_speed(220_q_km, 2_q_h); - constexpr Speed auto v3 = avg_speed(si::length(140), si::time(2)); - constexpr Speed auto v4 = units::quantity_cast>(v2); - constexpr Speed auto v5 = units::quantity_cast(v3); - constexpr Speed auto v6 = units::quantity_cast(v5); + constexpr Speed auto v2 = mi_per_h(70.); + constexpr Speed auto v3 = avg_speed(220_q_km, 2_q_h); + constexpr Speed auto v4 = avg_speed(si::length(140), si::time(2)); +#if UNITS_DOWNCAST_MODE == 0 + constexpr Speed auto v5 = quantity_cast>(v3); + constexpr Speed auto v6 = quantity_cast(v4); +#else + constexpr Speed auto v5 = quantity_cast>(v3); + constexpr Speed auto v6 = quantity_cast(v4); +#endif + constexpr Speed auto v7 = quantity_cast(v6); std::cout << v1 << '\n'; // 110 km/h - std::cout << fmt::format("{}", v2) << '\n'; // 110 km/h - std::cout << fmt::format("{:*^14}", v3) << '\n'; // ***70 mi/h**** - std::cout << fmt::format("{:%Q in %q}", v4) << '\n'; // 30.5556 in m/s - std::cout << fmt::format("{0:%Q} in {0:%q}", v5) << '\n'; // 31.2928 in m/s - std::cout << fmt::format("{:%Q}", v6) << '\n'; // 31 + std::cout << v2 << '\n'; // 70 mi/h + std::cout << fmt::format("{}", v3) << '\n'; // 110 km/h + std::cout << fmt::format("{:*^14}", v4) << '\n'; // ***70 mi/h**** + std::cout << fmt::format("{:%Q in %q}", v5) << '\n'; // 30.5556 in m/s + 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)._ diff --git a/docs/quick_start.rst b/docs/quick_start.rst index faba09cd..66351cf1 100644 --- a/docs/quick_start.rst +++ b/docs/quick_start.rst @@ -42,48 +42,57 @@ 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 of basic library features:: - #define UNITS_REFERENCES + #define UNITS_ALIASES #define UNITS_LITERALS - + #define UNITS_REFERENCES + #include - #include - #include - #include #include - #include + #include // IWYU pragma: keep + #include + #include // IWYU pragma: keep + #include #include #include - + using namespace units::isq; - + constexpr Speed auto avg_speed(Length auto d, Time auto t) { return d / t; } - + int main() { using namespace units::isq::si::literals; using namespace units::isq::si::references; - + using namespace units::aliases::isq::si::international; + constexpr Speed auto v1 = 110 * (km / h); - constexpr Speed auto v2 = avg_speed(220_q_km, 2_q_h); - constexpr Speed auto v3 = avg_speed(si::length(140), si::time(2)); - constexpr Speed auto v4 = units::quantity_cast>(v2); - constexpr Speed auto v5 = units::quantity_cast(v3); - constexpr Speed auto v6 = units::quantity_cast(v5); - + constexpr Speed auto v2 = mi_per_h(70.); + constexpr Speed auto v3 = avg_speed(220_q_km, 2_q_h); + constexpr Speed auto v4 = avg_speed(si::length(140), si::time(2)); + #if UNITS_DOWNCAST_MODE == 0 + constexpr Speed auto v5 = quantity_cast>(v3); + constexpr Speed auto v6 = quantity_cast(v4); + #else + constexpr Speed auto v5 = quantity_cast>(v3); + constexpr Speed auto v6 = quantity_cast(v4); + #endif + constexpr Speed auto v7 = quantity_cast(v6); + std::cout << v1 << '\n'; // 110 km/h - std::cout << fmt::format("{}", v2) << '\n'; // 110 km/h - std::cout << fmt::format("{:*^14}", v3) << '\n'; // ***70 mi/h**** - std::cout << fmt::format("{:%Q in %q}", v4) << '\n'; // 30.5556 in m/s - std::cout << fmt::format("{0:%Q} in {0:%q}", v5) << '\n'; // 31.2928 in m/s - std::cout << fmt::format("{:%Q}", v6) << '\n'; // 31 + std::cout << v2 << '\n'; // 70 mi/h + std::cout << fmt::format("{}", v3) << '\n'; // 110 km/h + std::cout << fmt::format("{:*^14}", v4) << '\n'; // ***70 mi/h**** + std::cout << fmt::format("{:%Q in %q}", v5) << '\n'; // 30.5556 in m/s + 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 - `Example #2 `_ + `Example #2 `_ .. seealso::