]> git.proxmox.com Git - ceph.git/blame - ceph/src/boost/libs/icl/doc/functions_ctor_dtor.qbk
bump version to 12.2.2-pve1
[ceph.git] / ceph / src / boost / libs / icl / doc / functions_ctor_dtor.qbk
CommitLineData
7c673cae
FG
1[/
2 Copyright (c) 2008-2009 Joachim Faulhaber
3
4 Distributed under the Boost Software License, Version 1.0.
5 (See accompanying file LICENSE_1_0.txt or copy at
6 http://www.boost.org/LICENSE_1_0.txt)
7]
8
9
10[/ //= Range ===================================================================]
11[section Range]
12
13[table
14[[['*Range*]] [__ch_itvs__][__ch_itv_sets__][__ch_itv_maps__][condition] ]
15[[`interval<domain_type> hull(const T&)`] [ ] [__O1__] [__O1__][] ]
16[[`domain_type T::lower()const`] [__O1__] [__O1__] [__O1__][] ]
17[[`domain_type T::upper()const`] [__O1__] [__O1__] [__O1__][] ]
18[[`domain_type T::first()const`] [__O1__] [__O1__] [__O1__][`!is_continuous<domain_type>::value`]]
19[[`domain_type T::last()const`] [__O1__] [__O1__] [__O1__][`!is_continuous<domain_type>::value`]]
20]
21
22The table above shows the availability of functions
23`hull`, `lower`, `upper`, `first` and `last` on intervals
24and interval containers that are all of ['*constant time complexity*].
25Find the functions description and some simple properties below.
26
27[table
28[[['*Range*]] [Types] [Description] ]
29[[`interval<domain_type> hull(const T&)`] [__S __M] [`hull(x)` returns the smallest interval that contains all intervals of an interval container `x`.] ]
30[[`domain_type T::lower()const`] [__i __S __M][`x.lower()` returns the lower bound of an interval or interval container `x`.] ]
31[[`domain_type T::upper()const`] [__i __S __M][`x.upper()` returns the upper bound of an interval or interval container `x`.] ]
32[[`domain_type T::first()const`] [__i __S __M][`x.first()` returns the first element of an interval or interval container `x`.
33 `T::first()` is defined for a non continuous `domain_type` only.] ]
34[[`domain_type T::last()const`] [__i __S __M][`x.last()` returns the last element of an interval or interval container `x`.
35 `T::last()` is defined for a non continuous `domain_type` only.] ]
36]
37
38``
39// for interval_containers x:
40hull(x).lower() == x.lower()
41hull(x).upper() == x.upper()
42hull(x).first() == x.first()
43hull(x).last() == x.last()
44``
45
46
47[endsect][/ Range]
48
49