Catch::Generators::RepeatGenerator< T > Class Template Reference

#include <catch_generators_generic.hpp>

Inheritance diagram for Catch::Generators::RepeatGenerator< T >:

Collaboration diagram for Catch::Generators::RepeatGenerator< T >:

Public Member Functions
	RepeatGenerator (size_t repeats, GeneratorWrapper< T > &&generator)
T const &	get () const override
bool	next () override
	RepeatGenerator (size_t repeats, GeneratorWrapper< T > &&generator)
T const &	get () const override
bool	next () override
Public Member Functions inherited from Catch::Generators::IGenerator< T >
virtual	~IGenerator ()=default
virtual	~IGenerator ()=default
Public Member Functions inherited from Catch::Generators::GeneratorUntypedBase
	GeneratorUntypedBase ()=default
virtual	~GeneratorUntypedBase ()
	GeneratorUntypedBase ()=default
virtual	~GeneratorUntypedBase ()

Additional Inherited Members
Public Types inherited from Catch::Generators::IGenerator< T >
using	type = T

Detailed Description

template<typename T>
class Catch::Generators::RepeatGenerator< T >

Definition at line 3775 of file catch.hpp.

Constructor & Destructor Documentation

RepeatGenerator() [1/2]

template<typename T >

Catch::Generators::RepeatGenerator< T >::RepeatGenerator ( size_t repeats, GeneratorWrapper< T > && generator )

inline

Definition at line 100 of file catch_generators_generic.hpp.

                                                                        :
            m_generator(std::move(generator)),
            m_target_repeats(repeats)
        {
            assert(m_target_repeats > 0 && "Repeat generator must repeat at least once");
        }

RepeatGenerator() [2/2]

template<typename T >

Catch::Generators::RepeatGenerator< T >::RepeatGenerator ( size_t repeats, GeneratorWrapper< T > && generator )

inline

Definition at line 3782 of file catch.hpp.

                                                                        :
            m_generator(std::move(generator)),
            m_target_repeats(repeats)
        {
            assert(m_target_repeats > 0 && "Repeat generator must repeat at least once");
        }

Member Function Documentation

get() [1/2]

template<typename T >

T const & Catch::Generators::RepeatGenerator< T >::get ( ) const

inlineoverridevirtual

Implements Catch::Generators::IGenerator< T >.

Definition at line 107 of file catch_generators_generic.hpp.

                                      {
            if (m_current_repeat == 0) {
                m_returned.push_back(m_generator.get());
                return m_returned.back();
            }
            return m_returned[m_repeat_index];
        }

get() [2/2]

template<typename T >

T const & Catch::Generators::RepeatGenerator< T >::get ( ) const

inlineoverridevirtual

Implements Catch::Generators::IGenerator< T >.

Definition at line 3789 of file catch.hpp.

                                      {
            if (m_current_repeat == 0) {
                m_returned.push_back(m_generator.get());
                return m_returned.back();
            }
            return m_returned[m_repeat_index];
        }

Here is the call graph for this function:

next() [1/2]

template<typename T >

bool Catch::Generators::RepeatGenerator< T >::next ( )

inlineoverridevirtual

Implements Catch::Generators::GeneratorUntypedBase.

Definition at line 115 of file catch_generators_generic.hpp.

                             {
            // There are 2 basic cases:
            // 1) We are still reading the generator
            // 2) We are reading our own cache
 
            // In the first case, we need to poke the underlying generator.
            // If it happily moves, we are left in that state, otherwise it is time to start reading from our cache
            if (m_current_repeat == 0) {
                const auto success = m_generator.next();
                if (!success) {
                    ++m_current_repeat;
                }
                return m_current_repeat < m_target_repeats;
            }
 
            // In the second case, we need to move indices forward and check that we haven't run up against the end
            ++m_repeat_index;
            if (m_repeat_index == m_returned.size()) {
                m_repeat_index = 0;
                ++m_current_repeat;
            }
            return m_current_repeat < m_target_repeats;
        }

next() [2/2]

template<typename T >

bool Catch::Generators::RepeatGenerator< T >::next ( )

inlineoverridevirtual

Implements Catch::Generators::GeneratorUntypedBase.

Definition at line 3797 of file catch.hpp.

                             {
            // There are 2 basic cases:
            // 1) We are still reading the generator
            // 2) We are reading our own cache
 
            // In the first case, we need to poke the underlying generator.
            // If it happily moves, we are left in that state, otherwise it is time to start reading from our cache
            if (m_current_repeat == 0) {
                const auto success = m_generator.next();
                if (!success) {
                    ++m_current_repeat;
                }
                return m_current_repeat < m_target_repeats;
            }
 
            // In the second case, we need to move indices forward and check that we haven't run up against the end
            ++m_repeat_index;
            if (m_repeat_index == m_returned.size()) {
                m_repeat_index = 0;
                ++m_current_repeat;
            }
            return m_current_repeat < m_target_repeats;
        }

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• libraries/sys-vm/external/Catch2/include/internal/catch_generators_generic.hpp
• libraries/sys-vm/external/Catch2/single_include/catch2/catch.hpp