3rd-party
/
catch2
mirror of https://github.com/catchorg/Catch2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update name of Value Generators in doc to match class names

This commit is contained in:
Wim Leflere 2019-10-04 11:22:06 +02:00 committed by Martin Hořeňovský
parent 02ee130bd0
commit fcda35f645
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/generators.md
View File

@ -36,8 +36,8 @@ Catch2's provided generator functionality consists of three parts,
* `GENERATE` macro, that serves to integrate generator expression with * `GENERATE` macro, that serves to integrate generator expression with
a test case, a test case,
* 2 fundamental generators * 2 fundamental generators
* `ValueGenerator<T>` -- contains only single element * `SingleValueGenerator<T>` -- contains only single element
* `ValuesGenerator<T>` -- contains multiple elements * `FixedValuesGenerator<T>` -- contains multiple elements
* 5 generic generators that modify other generators * 5 generic generators that modify other generators
* `FilterGenerator<T, Predicate>` -- filters out elements from a generator * `FilterGenerator<T, Predicate>` -- filters out elements from a generator
for which the predicate returns "false" for which the predicate returns "false"
@ -56,9 +56,9 @@ a test case,
The generators also have associated helper functions that infer their The generators also have associated helper functions that infer their
type, making their usage much nicer. These are type, making their usage much nicer. These are
* `value(T&&)` for `ValueGenerator<T>` * `value(T&&)` for `SingleValueGenerator<T>`
* `values(std::initializer_list<T>)` for `ValuesGenerator<T>` * `values(std::initializer_list<T>)` for `FixedValuesGenerator<T>`
* `table<Ts...>(std::initializer_list<std::tuple<Ts...>>)` for `ValuesGenerator<std::tuple<Ts...>>` * `table<Ts...>(std::initializer_list<std::tuple<Ts...>>)` for `FixedValuesGenerator<std::tuple<Ts...>>`
* `filter(predicate, GeneratorWrapper<T>&&)` for `FilterGenerator<T, Predicate>` * `filter(predicate, GeneratorWrapper<T>&&)` for `FilterGenerator<T, Predicate>`
* `take(count, GeneratorWrapper<T>&&)` for `TakeGenerator<T>` * `take(count, GeneratorWrapper<T>&&)` for `TakeGenerator<T>`
* `repeat(repeats, GeneratorWrapper<T>&&)` for `RepeatGenerator<T>` * `repeat(repeats, GeneratorWrapper<T>&&)` for `RepeatGenerator<T>`
@ -90,7 +90,7 @@ Apart from registering generators with Catch2, the `GENERATE` macro has
one more purpose, and that is to provide simple way of generating trivial one more purpose, and that is to provide simple way of generating trivial
generators, as seen in the first example on this page, where we used it generators, as seen in the first example on this page, where we used it
as `auto i = GENERATE(1, 2, 3);`. This usage converted each of the three as `auto i = GENERATE(1, 2, 3);`. This usage converted each of the three
literals into a single `ValueGenerator<int>` and then placed them all in literals into a single `SingleValueGenerator<int>` and then placed them all in
a special generator that concatenates other generators. It can also be a special generator that concatenates other generators. It can also be
used with other generators as arguments, such as `auto i = GENERATE(0, 2, used with other generators as arguments, such as `auto i = GENERATE(0, 2,
take(100, random(300, 3000)));`. This is useful e.g. if you know that take(100, random(300, 3000)));`. This is useful e.g. if you know that

2
include/internal/catch_generators.hpp
View File

@ -71,7 +71,7 @@ namespace Generators {
template<typename T> template<typename T>
class FixedValuesGenerator final : public IGenerator<T> { class FixedValuesGenerator final : public IGenerator<T> {
static_assert(!std::is_same<T, bool>::value, static_assert(!std::is_same<T, bool>::value,
"ValuesGenerator does not support bools because of std::vector<bool>" "FixedValuesGenerator does not support bools because of std::vector<bool>"
"specialization, use SingleValue Generator instead."); "specialization, use SingleValue Generator instead.");
std::vector<T> m_values; std::vector<T> m_values;
size_t m_idx = 0; size_t m_idx = 0;