boost/pfr
2
0
Fork 0
mirror of https://github.com/boostorg/pfr.git synced 2026-01-19 04:22:13 +00:00
Code Issues Projects Releases Wiki Activity

improve docs (refs #55)

Browse Source
This commit is contained in:
Antony Polukhin
2020-10-14 21:26:11 +03:00
parent d2ac7325bd
commit 3b369d6303
2 changed files with 26 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -9,8 +9,8 @@ This is a C++14 library for very basic reflection that gives you access to struc
Branches | Build | Tests coverage | More info
----------------|-------------- | -------------- |-----------
Develop: | [![Build Status](https://travis-ci.org/apolukhin/magic_get.svg?branch=develop)](https://travis-ci.org/apolukhin/magic_get) [![Build status](https://ci.appveyor.com/api/projects/status/1edm74h5id8qpr2k/branch/develop?svg=true)](https://ci.appveyor.com/project/apolukhin/magic-get/branch/develop) | [![Coverage Status](https://coveralls.io/repos/github/apolukhin/magic_get/badge.png?branch=develop)](https://coveralls.io/github/apolukhin/magic_get?branch=develop) | <!-- [details...](http://www.boost.org/development/tests/develop/developer/pfr.html)) -->
Master: | [![Build Status](https://travis-ci.org/apolukhin/magic_get.svg?branch=master)](https://travis-ci.org/apolukhin/magic_get) [![Build status](https://ci.appveyor.com/api/projects/status/1edm74h5id8qpr2k/branch/master?svg=true)](https://ci.appveyor.com/project/apolukhin/magic-get/branch/master) | [![Coverage Status](https://coveralls.io/repos/github/apolukhin/magic_get/badge.png?branch=master)](https://coveralls.io/github/apolukhin/magic_get?branch=master) | <!-- [details...](http://www.boost.org/development/tests/master/developer/pfr.html)) -->
Develop: | [![Build Status](https://travis-ci.org/apolukhin/magic_get.svg?branch=develop)](https://travis-ci.org/apolukhin/magic_get) [![Build status](https://ci.appveyor.com/api/projects/status/3tled9gd24k9paia/branch/develop?svg=true)](https://ci.appveyor.com/project/apolukhin/magic-get/branch/develop) | [![Coverage Status](https://coveralls.io/repos/github/apolukhin/magic_get/badge.png?branch=develop)](https://coveralls.io/github/apolukhin/magic_get?branch=develop) | <!-- [details...](http://www.boost.org/development/tests/develop/developer/pfr.html)) -->
Master: | [![Build Status](https://travis-ci.org/apolukhin/magic_get.svg?branch=master)](https://travis-ci.org/apolukhin/magic_get) [![Build status](https://ci.appveyor.com/api/projects/status/3tled9gd24k9paia/branch/master?svg=true)](https://ci.appveyor.com/project/apolukhin/magic-get/branch/master) | [![Coverage Status](https://coveralls.io/repos/github/apolukhin/magic_get/badge.png?branch=master)](https://coveralls.io/github/apolukhin/magic_get?branch=master) | <!-- [details...](http://www.boost.org/development/tests/master/developer/pfr.html)) -->
### Motivating Example #0
```c++

36
include/boost/pfr/ops_fields.hpp
View File

@@ -33,53 +33,65 @@
/// \b Synopsis:
namespace boost { namespace pfr {
/// Does a field-by-field comparison.
/// Does a field-by-field equality comparison.
///
/// \returns `std::tie( _lhs-fields_ ) == std::tie( _rhs-fields_ )`
/// Let MIN be std::min(tuple_size_v<T>, tuple_size_v<U>). Let _lhs-fields_ and _rhs-fields_ be the tuples of MIN fields of lhs and rhs correspondingly.
///
/// \returns `std::tie( _lhs-fields_ ) == std::tie( _rhs-fields_ ) && tuple_size_v<T> == tuple_size_v<U>`
template <class T, class U>
bool eq_fields(const T& lhs, const U& rhs) noexcept {
return detail::binary_visit<detail::equal_impl>(lhs, rhs);
}
/// Does a field-by-field comparison.
/// Does a field-by-field inequality comparison.
///
/// \returns `std::tie( _lhs-fields_ ) != std::tie( _rhs-fields_ )`
/// Let MIN be std::min(tuple_size_v<T>, tuple_size_v<U>). Let _lhs-fields_ and _rhs-fields_ be the tuples of MIN fields of lhs and rhs correspondingly.
///
/// \returns `std::tie( _lhs-fields_ ) != std::tie( _rhs-fields_ ) || tuple_size_v<T> != tuple_size_v<U>`
template <class T, class U>
bool ne_fields(const T& lhs, const U& rhs) noexcept {
return detail::binary_visit<detail::not_equal_impl>(lhs, rhs);
}
/// Does a field-by-field comparison.
/// Does a field-by-field greter comparison.
///
/// \returns `std::tie( _lhs-fields_ ) > std::tie( _rhs-fields_ )`
/// Let MIN be std::min(tuple_size_v<T>, tuple_size_v<U>). Let _lhs-fields_ and _rhs-fields_ be the tuples of MIN fields of lhs and rhs correspondingly.
///
/// \returns `std::tie( _lhs-fields_ ) > std::tie( _rhs-fields_ ) || (std::tie( _lhs-fields_ ) == std::tie( _rhs-fields_ ) && tuple_size_v<T> > tuple_size_v<U>)`
template <class T, class U>
bool gt_fields(const T& lhs, const U& rhs) noexcept {
return detail::binary_visit<detail::greater_impl>(lhs, rhs);
}
/// Does a field-by-field comparison.
/// Does a field-by-field less comparison.
///
/// \returns `std::tie( _lhs-fields_ ) < std::tie( _rhs-fields_ )`
/// Let MIN be std::min(tuple_size_v<T>, tuple_size_v<U>). Let _lhs-fields_ and _rhs-fields_ be the tuples of MIN fields of lhs and rhs correspondingly.
///
/// \returns `std::tie( _lhs-fields_ ) < std::tie( _rhs-fields_ ) || (std::tie( _lhs-fields_ ) == std::tie( _rhs-fields_ ) && tuple_size_v<T> < tuple_size_v<U>)`
template <class T, class U>
bool lt_fields(const T& lhs, const U& rhs) noexcept {
return detail::binary_visit<detail::less_impl>(lhs, rhs);
}
/// Does a field-by-field comparison.
/// Does a field-by-field greater equal comparison.
///
/// \returns `std::tie( _lhs-fields_ ) >= std::tie( _rhs-fields_ )`
/// Let MIN be std::min(tuple_size_v<T>, tuple_size_v<U>). Let _lhs-fields_ and _rhs-fields_ be the tuples of MIN fields of lhs and rhs correspondingly.
///
/// \returns `std::tie( _lhs-fields_ ) > std::tie( _rhs-fields_ ) || (std::tie( _lhs-fields_ ) == std::tie( _rhs-fields_ ) && tuple_size_v<T> >= tuple_size_v<U>)`
template <class T, class U>
bool ge_fields(const T& lhs, const U& rhs) noexcept {
return detail::binary_visit<detail::greater_equal_impl>(lhs, rhs);
}
/// Does a field-by-field comparison.
/// Does a field-by-field less equal comparison.
///
/// \returns `std::tie( _lhs-fields_ ) <= std::tie( _rhs-fields_ )`
/// Let MIN be std::min(tuple_size_v<T>, tuple_size_v<U>). Let _lhs-fields_ and _rhs-fields_ be the tuples of MIN fields of lhs and rhs correspondingly.
///
/// \returns `std::tie( _lhs-fields_ ) < std::tie( _rhs-fields_ ) || (std::tie( _lhs-fields_ ) == std::tie( _rhs-fields_ ) && tuple_size_v<T> <= tuple_size_v<U>)`
template <class T, class U>
bool le_fields(const T& lhs, const U& rhs) noexcept {
return detail::binary_visit<detail::less_equal_impl>(lhs, rhs);