generate.qbk 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. [/
  2. Copyright 2010 Neil Groves
  3. Distributed under the Boost Software License, Version 1.0.
  4. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  5. /]
  6. [section:generate generate]
  7. [heading Prototype]
  8. ``
  9. template<class ForwardRange, class Generator>
  10. ForwardRange& generate( ForwardRange& rng, Generator gen );
  11. template<class ForwardRange, class Generator>
  12. const ForwardRange& generate( const ForwardRange& rng, Generator gen );
  13. ``
  14. [heading Description]
  15. `generate` assigns the result of `gen()` to each element in range `rng`. Returns the resultant range.
  16. [heading Definition]
  17. Defined in the header file `boost/range/algorithm/generate.hpp`
  18. [heading Requirements]
  19. * `ForwardRange` is a model of the __forward_range__ Concept.
  20. * `ForwardRange` is mutable.
  21. * `Generator` is a model of the `GeneratorConcept`.
  22. * The `value_type` of `SinglePassRange` is convertible to a type in `OutputIterator`'s set of value types.
  23. [heading Precondition:]
  24. * `out_it` is not an iterator within `rng`.
  25. * `[out_it, out_it + distance(rng))` is a valid range.
  26. [heading Complexity]
  27. Linear. Exactly `distance(rng)` assignments are performed.
  28. [endsect]