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

docs: chrono.h header file location updated

Browse Source
This commit is contained in:
Mateusz Pusz
2024-01-07 15:44:36 +01:00
parent 7a8b233d49
commit 720f31055f
3 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/users_guide/framework_basics/the_affine_space.md
View File

@@ -235,7 +235,7 @@ clock.
[interoperability with other units libraries](../use_cases/interoperability_with_other_libraries.md). [interoperability with other units libraries](../use_cases/interoperability_with_other_libraries.md).
It also has built-in compatibility with `std::chrono` types, so users do not have to define It also has built-in compatibility with `std::chrono` types, so users do not have to define
interoperability traits or point origins for such types by themselves. Those are already interoperability traits or point origins for such types by themselves. Those are already
provided in the `mp-units/chrono.h` header file. provided in the `mp-units/systems/si/chrono.h` header file.
Now, we can refactor our database to benefit from the explicit points: Now, we can refactor our database to benefit from the explicit points:

6
docs/users_guide/use_cases/interoperability_with_other_libraries.md
View File

@@ -13,7 +13,8 @@ library, we have to provide specializations of:
Before we delve into the template specialization details, let's first decide if we want the Before we delve into the template specialization details, let's first decide if we want the
conversions to happen implicitly or if explicit ones would be a better choice. Or maybe conversions to happen implicitly or if explicit ones would be a better choice. Or maybe
the conversion should be implicit in one direction only (e.g., into **mp-units** abstractions) while the explicit conversions in the other direction should be preferred? the conversion should be implicit in one direction only (e.g., into **mp-units** abstractions)
while the explicit conversions in the other direction should be preferred?
There is no one unified answer to the above questions. Everything depends on the use case. There is no one unified answer to the above questions. Everything depends on the use case.
@@ -243,7 +244,8 @@ Those are:
- [`std::chrono::time_point`](https://en.cppreference.com/w/cpp/chrono/time_point) - specifies - [`std::chrono::time_point`](https://en.cppreference.com/w/cpp/chrono/time_point) - specifies
quantity points of time. quantity points of time.
The **mp-units** library comes with built-in interoperability with those types. It is enough to include the _mp-units/chrono.h_ file to benefit from it. This file provides: The **mp-units** library comes with built-in interoperability with those types. It is enough to
include the _mp-units/systems/si/chrono.h_ file to benefit from it. This file provides:
- partial specializations of `quantity_like_traits` and `quantity_point_like_traits` that provide - partial specializations of `quantity_like_traits` and `quantity_point_like_traits` that provide
support for implicit conversions between `std` and `mp_units` types in both directions, support for implicit conversions between `std` and `mp_units` types in both directions,

4
src/core/include/mp-units/customization_points.h
View File

@@ -169,7 +169,7 @@ concept ConversionSpecOf = ConversionSpec<T> && std::same_as<typename T::value_t
* Both return types should be encapsulated in either @c convert_explicitly or * Both return types should be encapsulated in either @c convert_explicitly or
* @c convert_implicitly to specify if the conversion is allowed to happen implicitly. * @c convert_implicitly to specify if the conversion is allowed to happen implicitly.
* *
* Usage example can be found in @c units/chrono.h header file. * Usage example can be found in @c mp-units/systems/si/chrono.h header file.
* *
* @tparam T the type to provide support for * @tparam T the type to provide support for
*/ */
@@ -186,7 +186,7 @@ struct quantity_like_traits;
* Both return types should be encapsulated in either @c convert_explicitly or * Both return types should be encapsulated in either @c convert_explicitly or
* @c convert_implicitly to specify if the conversion is allowed to happen implicitly. * @c convert_implicitly to specify if the conversion is allowed to happen implicitly.
* *
* Usage example can be found in @c units/chrono.h header file. * Usage example can be found in @c mp-units/systems/si/chrono.h header file.
* *
* @tparam T the type to provide support for * @tparam T the type to provide support for
*/ */