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

[heading Prototype]

``
template<class Integer>
iterator_range< range_detail::integer_iterator<Integer> >
irange(Integer first, Integer  last);

template<class Integer, class StepSize>
iterator_range< range_detail::integer_iterator_with_step<Integer, StepSize> >
irange(Integer first, Integer last, StepSize step_size);
``

[heading Description]

`irange` is a function to generate an Integer Range.

`irange` allows treating integers as a model of the __random_access_range__ Concept. It should be noted that the `first` and `last` parameters denoted a half-open range.

[heading Definition]

Defined in the header file `boost/range/irange.hpp`

[heading Requirements]

# `Integer` is a model of the `Integer` Concept.
# `StepSize` is a model of the `SignedInteger` Concept.

[heading Complexity]

Constant. Since this function generates a new range the most significant performance cost is incurred through the iteration of the generated range.

[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:irange irange]
	7
	8	[heading Prototype]
	9
	10	``
	11	template<class Integer>
	12	iterator_range< range_detail::integer_iterator<Integer> >
	13	irange(Integer first, Integer last);
	14
	15	template<class Integer, class StepSize>
	16	iterator_range< range_detail::integer_iterator_with_step<Integer, StepSize> >
	17	irange(Integer first, Integer last, StepSize step_size);
	18	``
	19
	20	[heading Description]
	21
	22	`irange` is a function to generate an Integer Range.
	23
	24	`irange` allows treating integers as a model of the __random_access_range__ Concept. It should be noted that the `first` and `last` parameters denoted a half-open range.
	25
	26	[heading Definition]
	27
	28	Defined in the header file `boost/range/irange.hpp`
	29
	30	[heading Requirements]
	31
	32	# `Integer` is a model of the `Integer` Concept.
	33	# `StepSize` is a model of the `SignedInteger` Concept.
	34
	35	[heading Complexity]
	36
	37	Constant. Since this function generates a new range the most significant performance cost is incurred through the iteration of the generated range.
	38
	39	[endsect]
	40