[ceph.git] / ceph / src / boost / libs / range / doc / reference / adaptors / indirected.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:indirected indirected]

[table
    [[Syntax] [Code]]
    [[Pipe] [`rng | boost::adaptors::indirected`]]
    [[Function] [`boost::adaptors::indirect(rng)`]]
]

* [*Precondition:] The `value_type` of the range defines unary `operator*()`
* [*Postcondition:] For all elements `x` in the returned range, `x` is the result of `*y` where `y` is the corresponding element in the original range.
* [*Range Category:] __single_pass_range__
* [*Range Return Type:] `boost::indirected_range<decltype(rng)>`
* [*Returned Range Category:] The range category of `rng`

[section:indirected_example indirected example]
[import ../../../test/adaptor_test/indirected_example.cpp]
[indirected_example]
[endsect]

This would produce the output:
``
0,1,2,3,4,5,6,7,8,9,
``
[endsect]
Commit	Line	Data
7c673cae FG	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:indirected indirected]
	7
	8	[table
	9	[[Syntax] [Code]]
	10	[[Pipe] [`rng \| boost::adaptors::indirected`]]
	11	[[Function] [`boost::adaptors::indirect(rng)`]]
	12	]
	13
	14	* [Precondition:] The `value_type` of the range defines unary `operator()`
	15	* [Postcondition:] For all elements `x` in the returned range, `x` is the result of `y` where `y` is the corresponding element in the original range.
	16	* [*Range Category:] __single_pass_range__
	17	* [*Range Return Type:] `boost::indirected_range<decltype(rng)>`
	18	* [*Returned Range Category:] The range category of `rng`
	19
	20	[section:indirected_example indirected example]
	21	[import ../../../test/adaptor_test/indirected_example.cpp]
	22	[indirected_example]
	23	[endsect]
	24
	25	This would produce the output:
	26	``
	27	0,1,2,3,4,5,6,7,8,9,
	28	``
	29	[endsect]
	30
	31