Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/examples/310-Gen-VariablesInGenerators.cpp
diff options
context:
space:
mode:
authorMartin Hořeňovský2019-01-29 10:52:28 +0100
committerMartin Hořeňovský2019-01-31 10:43:25 +0100
commit061f1f836af4fcbec103e55f5c375260f0028937 (patch)
treee433d3641948a05cf291d63207de3e1e2830cb81 /examples/310-Gen-VariablesInGenerators.cpp
parent5929d9530cd50c116398f486fea7324055cffe83 (diff)
downloadcatch3-061f1f836af4fcbec103e55f5c375260f0028937.tar.gz
Update documentation and examples for generators
Diffstat (limited to 'examples/310-Gen-VariablesInGenerators.cpp')
-rw-r--r--examples/310-Gen-VariablesInGenerators.cpp72
1 files changed, 72 insertions, 0 deletions
diff --git a/examples/310-Gen-VariablesInGenerators.cpp b/examples/310-Gen-VariablesInGenerators.cpp
new file mode 100644
index 00000000..96840bbb
--- /dev/null
+++ b/examples/310-Gen-VariablesInGenerators.cpp
@@ -0,0 +1,72 @@
+// 310-Gen-VariablesInGenerator.cpp
+// Shows how to use variables when creating generators.
+
+// Note that using variables inside generators is dangerous and should
+// be done only if you know what you are doing, because the generators
+// _WILL_ outlive the variables -- thus they should be either captured
+// by value directly, or copied by the generators during construction.
+
+#include <catch2/catch.hpp>
+
+#include <random>
+
+// Lets start by implementing a parametrizable double generator
+class RandomDoubleGenerator : public Catch::Generators::IGenerator<double> {
+ std::minstd_rand m_rand;
+ std::uniform_real_distribution<> m_dist;
+ double current_number;
+public:
+
+ RandomDoubleGenerator(double low, double high):
+ m_rand(std::random_device{}()),
+ m_dist(low, high)
+ {
+ static_cast<void>(next());
+ }
+
+ double const& get() const override;
+ bool next() override {
+ current_number = m_dist(m_rand);
+ return true;
+ }
+};
+
+// Avoids -Wweak-vtables
+double const& RandomDoubleGenerator::get() const {
+ return current_number;
+}
+
+
+// Also provide a nice shortcut for creating the generator
+Catch::Generators::GeneratorWrapper<double> random(double low, double high) {
+ return Catch::Generators::GeneratorWrapper<double>(std::unique_ptr<Catch::Generators::IGenerator<double>>(new RandomDoubleGenerator(low, high)));
+}
+
+
+TEST_CASE("Generate random doubles across different ranges",
+ "[generator][example][advanced]") {
+ // Workaround for old libstdc++
+ using record = std::tuple<double, double>;
+ // Set up 3 ranges to generate numbers from
+ auto r = GENERATE(table<double, double>({
+ record{3, 4},
+ record{-4, -3},
+ record{10, 1000}
+ }));
+
+ // This will not compile (intentionally), because it accesses a variable
+ // auto number = GENERATE(take(50, random(r.first, r.second)));
+
+ // We have to manually register the generators instead
+ // Notice that we are using value capture in the lambda, to avoid lifetime issues
+ auto number = Catch::Generators::generate( CATCH_INTERNAL_LINEINFO,
+ [=]{
+ using namespace Catch::Generators;
+ return makeGenerators(take(50, random(std::get<0>(r), std::get<1>(r))));
+ }
+ );
+ REQUIRE(std::abs(number) > 0);
+}
+
+// Compiling and running this file will result in 150 successful assertions
+