Class Seq

Synopsis

#include <include/rapidcheck/Seq.h>

template <typename T>
class Seq

Description

This class implements lazy sequences, or streams if you will. This is mainly used by RapidCheck to implement shrinking where it is not feasible to materialize all of the possible shrinks at once. In particular, a Seq may be infinite although that's not appropriate for shrinking, of course!

A Seq object is constructed either as an empty sequence using the default constructor or with an implementation object that implements the actual sequence.

The implementation class must meet the following requirements:

  • It must provide a method Maybe<T> operator()() (i.e. it must be a functor) which returns the next value or nothing if there are no more values. If this method throws, it is treated the same as Nothing.
  • It must have a copy constructor that produces a semantically identical copy. This means that it should provide equal values to the original.

However, unless you have a reason to create your own implementation class, you should just use the provided combinators in the rc::seq namespace to construct your Seqs.

Mentioned in

Classes

ISeqImpl

Methods

Seq overloadConstructs an empty Seq that has no values.
Seq overloadEquivalent to default constructor.
Seq overloadConstructs a Seq from the given implementation object.
nextReturns the next value.
operator= overload

Source

Lines 33-72 in include/rapidcheck/Seq.h.

template <typename T>
class Seq {
  /// Creates a new `Seq` using the implementation class specificed by the
  /// type parameter constructed by forwarding the given arguments.
  template <typename Impl, typename... Args>
  friend Seq<typename rc::compat::return_type<Impl>::type::ValueType>
  makeSeq(Args &&... args);

public:
  /// The type of the values of this `Seq`.
  using ValueType = T;

  /// Constructs an empty `Seq` that has no values.
  Seq() noexcept = default;

  /// Equivalent to default constructor.
  Seq(NothingType) noexcept;

  /// Constructs a `Seq` from the given implementation object.
  template <typename Impl,
            typename = typename std::enable_if<
                !std::is_same<Decay<Impl>, Seq>::value>::type>
  explicit Seq(Impl &&impl);

  /// Returns the next value.
  Maybe<T> next() noexcept;

  Seq(const Seq &other);
  Seq &operator=(const Seq &rhs);
  Seq(Seq &&other) noexcept = default;
  Seq &operator=(Seq &&rhs) noexcept = default;

private:
  class ISeqImpl;

  template <typename Impl>
  class SeqImpl;

  std::unique_ptr<ISeqImpl> m_impl;
};





Add Discussion as Guest

Log in