ceph/src/boost/libs/icl/doc/functions_selection.qbk

   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 [/ //= Selection ===================================================================]
  11 [section Selection]
  12
  13 [table
  14 [[['*Selection*]]                          [__ch_itv_sets__][__ch_itv_maps__][__ch_ele_sets__][__ch_ele_maps__]     [condition]            ]
  15 [[`iterator T::find(const domain_type&)`]                [ ]        [ ]         [__Olgn__]  [__Olgn__] []                     ]
  16 [[`const_iterator T::find(const domain_type&)const`]     [__Olgn__] [__Olgn__]  [__Olgn__]  [__Olgn__] []                     ]
  17 [[`const_iterator find(T&, const domain_type&)`]         [__Olgn__] [__Olgn__]  [ ]         [ ]        []                     ]
  18 [[`const_iterator T::find(const interval_type&)const`]   [__Olgn__] [__Olgn__]  [ ]         [ ]        []                     ]
  19 [[`const_iterator find(T&, const interval_type&)`]       [__Olgn__] [__Olgn__]  [ ]         [ ]        []                     ]
  20 [[`codomain_type& operator[] (const domain_type&)`]      [ ]        [ ]         [ ]         [__Olgn__] []                     ]
  21 [[`codomain_type operator() (const domain_type&)const`]  [ ]        [__Olgn__]  [ ]         [__Olgn__] [`is_total<T>::value`] ]
  22 ]
  23
  24 * All time *complexities* are ['*logarithmic*] in the containers `iterative_size()`.
  25 * `operator()` is available for total maps only.
  26 * `interval_type` is also the interval container's `key_type`
  27
  28
  29
  30 [table
  31 [[['*Selection*]]                              [Types]     [Description]                                        ]
  32 [[`iterator T::find(const domain_type& x)`]    [__s __m]   [Searches the container for the element `x` and return an iterator to it, if `x` is found.
  33                                                             Otherwise `find` returns iterator `end()`.] ]
  34 [[`const_iterator T::find`\n
  35   `(const domain_type& x)const`]               [__s __m]   [Const version of `find` above.] ]
  36 [[`const_iterator T::find`\n
  37   `(const domain_type& x)const`\n\n
  38   `const_iterator find`\n
  39   `(T&, const domain_type& x)`]                [__S __M]
  40                                                            [For interval containers `c`, `c.find(x)` or `icl::find(c,x)` searches a key element `x` and
  41                                                             returns an iterator to the interval containing the element `x`.] ]
  42 [[`const_iterator T::find`\n
  43   `(const interval_type& x)const`\n\n
  44   `const_iterator find`\n
  45   `(T&, const interval_type& x)`]
  46                                                [__S __M]   [For interval containers `c`, `c.find(y)` or `icl::find(c,y)` searches an interval `y`
  47                                                             and returns an iterator to the first interval in `c` that overlaps with `y`.] ]
  48
  49 [[`codomain_type& operator[]`\n
  50   `(const domain_type& x)`]                    [__m ]      [For the key element `x` the operator returns a reference to the mapped value.
  51                                                             A pair `std::pair(x,codomain_type())` will be inserted, of `x` is not found in the map.] ]
  52 [[`codomain_type operator()`\n
  53   `(const domain_type& x)const`]               [__M __m ]  [Returns the mapped value for a key `x`. The operator is only available for ['*total*] maps. ] ]
  54 ]
  55
  56
  57
  58 ['*See also . . .*]
  59 [table
  60 []
  61 [[[link boost_icl.function_reference.intersection ['*Intersection*]] ]]
  62 ]
  63 ['*Back to section . . .*]
  64 [table
  65 []
  66 [[[link function_synopsis_table ['*Function Synopsis*]]    ]]
  67 [[[link boost_icl.interface ['*Interface*]]                ]]
  68 ]
  69
  70 [endsect][/ Selection]
  71
  72