https://github.com/xu-cheng/sfinae-utility
:heavy_check_mark: A C++ header-only library for SFINAE
https://github.com/xu-cheng/sfinae-utility
cplusplus cplusplus-14 sfinae template-metaprogramming
Last synced: 3 months ago
JSON representation
:heavy_check_mark: A C++ header-only library for SFINAE
- Host: GitHub
- URL: https://github.com/xu-cheng/sfinae-utility
- Owner: xu-cheng
- License: mit
- Created: 2017-07-19T07:17:47.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-09T11:06:07.000Z (almost 8 years ago)
- Last Synced: 2025-01-16T00:00:39.266Z (5 months ago)
- Topics: cplusplus, cplusplus-14, sfinae, template-metaprogramming
- Language: C++
- Homepage:
- Size: 4.88 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sfinae-utility
A C++ header-only library for [SFINAE](http://en.cppreference.com/w/cpp/language/sfinae).
## How to use?
This is a single header library. So just copy the file inside `include/` into your project.
The following SFINAE functions are provided:
```
is_container
has_find_method
has_key_type
has_value_type
has_mapped_type
has_key_or_value_type
is_container_with_value_type
is_container_with_find_method
is_map_container_with_types
```
For each of these functions, there is a helper variable template whose name has a suffix `_v`. For example, `is_container_v` is equivalent to `is_container::value`.
## Functions
* `is_container`
Return true if the input is a STL-like container. Specially, it checks whether `Container` has certain member types (`value_type`, `size_type`, `allocator_type`, `iterator` and `const_iterator`) and accepts certain methods (`size()`, `begin()` and `end()`).
* `has_find_method`
Return true if the container accepts `find(TypePassToFindMethod)` method.
* `has_key_type`
Return true if the `Container::key_type` is `KeyType`.
* `has_value_type`
Return true if the `Container::value_type` is `ValueType`.
* `has_mapped_type`
Return true if the `Container::mapped_type` is `MappedType`.
* `has_key_or_value_type`
Return true if the input has `KeyOrValueType` as `Container::key_type` or `Container::value_type`.
* `is_container_with_value_type`
Return true if the input is a STL-like container and has `ValueType` as `Container::value_type`.
* `is_container_with_find_method`
Return true if the input is a STL-like container, has `KeyOrValueType` as `Container::key_type` or `Container::value_type`, and accepts `find(KeyOrValueType)` method. This is useful to check whether the input is a `std::set` or `std::map` like container.
* `is_map_container_with_types`
Return true if the input is a STL-like map container and has `KeyType` as `Container::key_type` and `MappedType` as `Container::mapped_type`.
## Author
* [Xu Cheng](https://xuc.me)
## License
MIT License.