boost_range/doc/reference/adaptors/transformed.qbk

[/
    Copyright 2010 Neil Groves
    Distributed under the Boost Software License, Version 1.0.
    (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
/]
[section:transformed transformed]

[table
    [[Syntax] [Code]]
    [[Pipe] [`rng | boost::adaptors::transformed(fun)`]]
    [[Function] [`boost::adaptors::transform(rng, fun)`]]
]

* [*Precondition:] The `value_type` of the range is convertible to the argument type of `fun`.
* [*Postcondition:] For all elements `x` in the returned range, `x` is the result of `fun(y)` where `y` is the corresponding element in the original range.
* [*Throws:] Whatever the copy-constructor of `fun` might throw.
* [*Range Category:] __single_pass_range__
* [*Range Return Type:] `boost::transformed_range<typeof(rng)>`
* [*Returned Range Category:] The range category of `rng`.

[section:transformed_example transformed example]
[import ../../../test/adaptor_test/transformed_example.cpp]
[transformed_example]
[endsect]

This would produce the output:
``
2,4,6,8,10,12,14,16,18,20
``
[endsect]
[boost][range] - Update to relax preconditions for the strided adaptor, and numerous fixes to inspection report issues. [SVN r67418] 2010-12-22 22:31:33 +00:00			`[/`
			`Copyright 2010 Neil Groves`
			`Distributed under the Boost Software License, Version 1.0.`
			`(See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)`
			`/]`
Boost.RangeEx merged into Boost.Range [SVN r60897] 2010-03-28 16:08:35 +00:00			`[section:transformed transformed]`

			`[table`
			`[[Syntax] [Code]]`
			[[Pipe] [`rng \| boost::adaptors::transformed(fun)`]]
			[[Function] [`boost::adaptors::transform(rng, fun)`]]
			`]`

			* [*Precondition:] The `value_type` of the range is convertible to the argument type of `fun`.
			* [*Postcondition:] For all elements `x` in the returned range, `x` is the result of `fun(y)` where `y` is the corresponding element in the original range.
			* [*Throws:] Whatever the copy-constructor of `fun` might throw.
Boost.Range documentation iteration. Primarily this is the inclusion of Range Return Categories for every Range Adaptor page. [SVN r61653] 2010-04-28 18:03:26 +00:00			`* [*Range Category:] __single_pass_range__`
[boost][range] - Resolution of Trac ticket 4355. Made the naming of the returned types from range adaptors consistent and documented. [SVN r67420] 2010-12-22 23:42:02 +00:00			* [*Range Return Type:] `boost::transformed_range<typeof(rng)>`
Boost.Range documentation iteration. Primarily this is the inclusion of Range Return Categories for every Range Adaptor page. [SVN r61653] 2010-04-28 18:03:26 +00:00			* [*Returned Range Category:] The range category of `rng`.
Boost.RangeEx merged into Boost.Range [SVN r60897] 2010-03-28 16:08:35 +00:00
			`[section:transformed_example transformed example]`
[range] refactor use of examples in documentation to avoid redundancy [SVN r82344] 2013-01-03 23:44:30 +00:00			`[import ../../../test/adaptor_test/transformed_example.cpp]`
			`[transformed_example]`
Boost.RangeEx merged into Boost.Range [SVN r60897] 2010-03-28 16:08:35 +00:00			`[endsect]`

			`This would produce the output:`
			``
			`2,4,6,8,10,12,14,16,18,20`
			``
			`[endsect]`