diff options
author | Anas Nashif <anas.nashif@intel.com> | 2013-08-26 08:15:55 -0400 |
---|---|---|
committer | Anas Nashif <anas.nashif@intel.com> | 2013-08-26 08:15:55 -0400 |
commit | bb4dd8289b351fae6b55e303f189127a394a1edd (patch) | |
tree | 77c9c35a31b1459dd7988c2448e797d142530c41 /libs/bimap/doc | |
parent | 1a78a62555be32868418fe52f8e330c9d0f95d5a (diff) | |
download | boost-bb4dd8289b351fae6b55e303f189127a394a1edd.tar.gz boost-bb4dd8289b351fae6b55e303f189127a394a1edd.tar.bz2 boost-bb4dd8289b351fae6b55e303f189127a394a1edd.zip |
Imported Upstream version 1.51.0upstream/1.51.0
Diffstat (limited to 'libs/bimap/doc')
-rw-r--r-- | libs/bimap/doc/reference/list_of.qbk | 12 | ||||
-rw-r--r-- | libs/bimap/doc/reference/set_of.qbk | 43 | ||||
-rw-r--r-- | libs/bimap/doc/reference/unconstrained_set_of.qbk | 4 | ||||
-rw-r--r-- | libs/bimap/doc/reference/unordered_set_of.qbk | 41 | ||||
-rw-r--r-- | libs/bimap/doc/reference/vector_of.qbk | 11 |
5 files changed, 61 insertions, 50 deletions
diff --git a/libs/bimap/doc/reference/list_of.qbk b/libs/bimap/doc/reference/list_of.qbk index b8f495ef8d..23f92c3b4e 100644 --- a/libs/bimap/doc/reference/list_of.qbk +++ b/libs/bimap/doc/reference/list_of.qbk @@ -152,6 +152,10 @@ requirements for these types of containers. // Only in map views // { + typedef ``['-unspecified-]`` key_type; + typedef ``['-unspecified-]`` mapped_type; + typedef ``['-unspecified-]`` mapped_type; // Equal to mapped_type + template< class CompatibleKey > bool ``[link reference_list_of_replace_key_iterator_key replace_key]``(iterator position, const CompatibleKey & x); @@ -228,14 +232,14 @@ In the set view: In the left map view: typedef Left key_type; - typedef ... data_type; + typedef ... mapped_type; typedef signature-compatible with std::pair< Left, ... > value_type; In the right map view: typedef ... key_type; - typedef Left data_type; + typedef Left mapped_type; typedef signature-compatible with std::pair< ... , Left > value_type; @@ -459,7 +463,7 @@ its original state. bool replace_data(iterator position, const CompatibleData & x); * [*Requires: ] `position` is a valid dereferenceable iterator of the set view. -`CompatibleKey` can be assigned to `data_type`. +`CompatibleKey` can be assigned to `mapped_type`. * [*Effects:] Assigns the value `x` to `e.second`, where `e` is the element pointed to by `position` into the `bimap` to which the set view belongs if replacing is allowed by all other views of the `bimap`. @@ -498,7 +502,7 @@ operation (except possibly mod), then the element pointed to by position is eras bool modify_data(iterator position, DataModifier mod); * [*Requires: ] `DataModifier` is a model of __SGI_UNARY_FUNCTION__ accepting arguments of -type: `data_type&`; `position` is a valid dereferenceable iterator of the view. +type: `mapped_type&`; `position` is a valid dereferenceable iterator of the view. * [*Effects:] Calls `mod(e.second)` where e is the element pointed to by position and rearranges `*position` into all the views of the `bimap`. If the rearrangement fails, the element is erased. diff --git a/libs/bimap/doc/reference/set_of.qbk b/libs/bimap/doc/reference/set_of.qbk index 543a6af227..1b52f5ebfa 100644 --- a/libs/bimap/doc/reference/set_of.qbk +++ b/libs/bimap/doc/reference/set_of.qbk @@ -105,7 +105,7 @@ look at it as a whole, you will be using a set view. public: typedef ``['-unspecified-]`` key_type; - typedef ``['-unspecified-]`` value_type; + typedef ``['-unspecified-]`` value_type; typedef ``['-unspecified-]`` key_compare; typedef ``['-unspecified-]`` value_compare; typedef ``['-unspecified-]`` allocator_type; @@ -239,22 +239,23 @@ look at it as a whole, you will be using a set view. std::pair<const_iterator,const_iterator> ``[link reference_set_of_range_lower_upper range]``( LowerBounder lower, UpperBounder upper) const; - typedef ``['-unspecified-]`` data_type; - + typedef ``['-unspecified-]`` mapped_type; + typedef ``['-unspecified-]`` data_type; // Equal to mapped_type + // Only in for `set_of` collection type // { template< class CompatibleKey > - const data_type & ``[link reference_set_of_at_key_const at]``(const CompatibleKey & k) const; + const mapped_type & ``[link reference_set_of_at_key_const at]``(const CompatibleKey & k) const; // Only if the other collection type is mutable // { template< class CompatibleKey > - data_type & ``[link reference_set_of_operator_bracket_key operator\[\]]``(const CompatibleKey & k); + mapped_type & ``[link reference_set_of_operator_bracket_key operator\[\]]``(const CompatibleKey & k); template< class CompatibleKey > - data_type & ``[link reference_set_of_at_key at]``(const CompatibleKey & k); + mapped_type & ``[link reference_set_of_at_key at]``(const CompatibleKey & k); // } @@ -343,14 +344,14 @@ In the set view: In the left map view: typedef Left key_type; - typedef ... data_type; + typedef ... mapped_type; typedef signature-compatible with std::pair< const Left, ... > value_type; In the right map view: typedef ... key_type; - typedef Left data_type; + typedef Left mapped_type; typedef signature-compatible with std::pair< ... ,const Left > value_type; @@ -541,7 +542,7 @@ its original state. bool replace_data(iterator position, const CompatibleData & x); * [*Requires: ] `position` is a valid dereferenceable iterator of the set view. -`CompatibleKey` can be assigned to `data_type`. +`CompatibleKey` can be assigned to `mapped_type`. * [*Effects:] Assigns the value `x` to `e.second`, where `e` is the element pointed to by `position` into the `bimap` to which the set view belongs if, * the map view is non-unique OR no other element with equivalent key exists @@ -584,7 +585,7 @@ operation (except possibly mod), then the element pointed to by position is eras bool modify_data(iterator position, DataModifier mod); * [*Requires: ] `DataModifier` is a model of __SGI_UNARY_FUNCTION__ accepting arguments of -type: `data_type&`; `position` is a valid dereferenceable iterator of the view. +type: `mapped_type&`; `position` is a valid dereferenceable iterator of the view. * [*Effects:] Calls `mod(e.second)` where e is the element pointed to by position and rearranges `*position` into all the views of the `bimap`. If the rearrangement fails, the element is erased. @@ -807,10 +808,10 @@ all values of type `key_type` satisfy. [#reference_set_of_at_key_const] template< class CompatibleKey > - const data_type & at(const CompatibleKey & k) const; + const mapped_type & at(const CompatibleKey & k) const; * [*Requires: ] `CompatibleKey` is a compatible key of `key_compare`. -* [*Effects:] Returns the `data_type` reference that is associated with `k`, or +* [*Effects:] Returns the `mapped_type` reference that is associated with `k`, or throws `std::out_of_range` if such key does not exist. * [*Complexity:] O(log(n)). * [*Note:] Only provided when `set_of` is used. @@ -823,10 +824,10 @@ Tey are only provided if the other collection type is mutable [#reference_set_of_operator_bracket_key] template< class CompatibleKey > - data_type & operator[](const CompatibleKey & k); + mapped_type & operator[](const CompatibleKey & k); * [*Requires: ] `CompatibleKey` is a compatible key of `key_compare`. -* [*Effects: ] `return insert(value_type(k,data_type()))->second;` +* [*Effects: ] `return insert(value_type(k,mapped_type()))->second;` * [*Complexity:] O(log(n)). * [*Note:] Only provided when `set_of` is used and the other collection type is mutable. @@ -834,10 +835,10 @@ type is mutable. [#reference_set_of_at_key] template< class CompatibleKey > - data_type & at(const CompatibleKey & k); + mapped_type & at(const CompatibleKey & k); * [*Requires: ] `CompatibleKey` is a compatible key of `key_compare`. -* [*Effects: ] Returns the `data_type` reference that is associated with `k`, or +* [*Effects: ] Returns the `mapped_type` reference that is associated with `k`, or throws `std::out_of_range` if such key does not exist. * [*Complexity:] O(log(n)). * [*Note:] Only provided when `set_of` is used and the other collection @@ -853,17 +854,17 @@ a non-existent key: this behaviour differs from that of `std::map`, which automatically assigns a default value to non-existent keys referred to by `operator[]`. - const data_type & operator[](const typename key_type & k) const; + const mapped_type & operator[](const typename key_type & k) const; -* [*Effects:] Returns the `data_type` reference that is associated with `k`, or +* [*Effects:] Returns the `mapped_type` reference that is associated with `k`, or throws `bimap::value_not_found` if such an element does not exist. * [*Complexity:] O(log(n)). - ``['-unspecified data_type proxy-]`` operator[](const typename key_type & k); + ``['-unspecified mapped_type proxy-]`` operator[](const typename key_type & k); -* [*Effects:] Returns a proxy to a `data_type` associated with `k` and the -bimap. The proxy behaves as a reference to the `data_type` object. If this +* [*Effects:] Returns a proxy to a `mapped_type` associated with `k` and the +bimap. The proxy behaves as a reference to the `mapped_type` object. If this proxy is read and `k` was not in the bimap, the bimap::value_not_found is thrown. If it is written then `bimap::duplicate_value` is thrown if the assignment is not allowed by one of the other views of the `bimap`. diff --git a/libs/bimap/doc/reference/unconstrained_set_of.qbk b/libs/bimap/doc/reference/unconstrained_set_of.qbk index 9b487ddb81..a2faa791ee 100644 --- a/libs/bimap/doc/reference/unconstrained_set_of.qbk +++ b/libs/bimap/doc/reference/unconstrained_set_of.qbk @@ -63,14 +63,14 @@ In the set view: In the left map view: typedef Left key_type; - typedef ... data_type; + typedef ... mapped_type; typedef signature-compatible with std::pair< Left, ... > value_type; In the right map view: typedef ... key_type; - typedef Left data_type; + typedef Left mapped_type; typedef signature-compatible with std::pair< ... , Left > value_type; diff --git a/libs/bimap/doc/reference/unordered_set_of.qbk b/libs/bimap/doc/reference/unordered_set_of.qbk index d386b8754c..7b22df0d60 100644 --- a/libs/bimap/doc/reference/unordered_set_of.qbk +++ b/libs/bimap/doc/reference/unordered_set_of.qbk @@ -182,6 +182,9 @@ do not exactly conform to the requirements for unordered associative containers. // Only in map views // { + typedef ``['-unspecified-]`` mapped_type; + typedef ``['-unspecified-]`` data_type; // Equal to mapped_type + template< class CompatibleKey > bool ``[link reference_unordered_set_of_replace_key_iterator_key replace_key]``(iterator position, const CompatibleKey & x); @@ -246,22 +249,22 @@ do not exactly conform to the requirements for unordered associative containers. // Only in maps views // { - typedef ``['-unspecified-]`` data_type; + typedef ``['-unspecified-]`` mapped_type; // Only in for `unordered_set_of` collection type // { template<class CompatibleKey> - const data_type & ``[link reference_unordered_set_of_at_key_const at]``(const CompatibleKey & k) const; + const mapped_type & ``[link reference_unordered_set_of_at_key_const at]``(const CompatibleKey & k) const; // Only if the other collection type is mutable // { template<class CompatibleKey> - data_type & ``[link reference_unordered_set_of_operator_bracket_key operator\[\]]``(const CompatibleKey & k); + mapped_type & ``[link reference_unordered_set_of_operator_bracket_key operator\[\]]``(const CompatibleKey & k); template<class CompatibleKey> - data_type & ``[link reference_unordered_set_of_at_key at]``(const CompatibleKey & k); + mapped_type & ``[link reference_unordered_set_of_at_key at]``(const CompatibleKey & k); // } @@ -296,14 +299,14 @@ In the set view: In the left map view: typedef Left key_type; - typedef ... data_type; + typedef ... mapped_type; typedef signature-compatible with std::pair< const Left, ... > value_type; In the right map view: typedef ... key_type; - typedef Left data_type; + typedef Left mapped_type; typedef signature-compatible with std::pair< ... ,const Left > value_type; @@ -512,7 +515,7 @@ its original state. bool replace_data(iterator position, const CompatibleData & x); * [*Requires: ] `position` is a valid dereferenceable iterator of the set view. -`CompatibleKey` can be assigned to `data_type`. +`CompatibleKey` can be assigned to `mapped_type`. * [*Effects:] Assigns the value `x` to `e.second`, where `e` is the element pointed to by `position` into the `bimap` to which the set view belongs if, * the map view is non-unique OR no other element with equivalent key exists @@ -555,7 +558,7 @@ operation (except possibly mod), then the element pointed to by position is eras bool modify_data(iterator position, DataModifier mod); * [*Requires: ] `DataModifier` is a model of __SGI_UNARY_FUNCTION__ accepting arguments of -type: `data_type&`; `position` is a valid dereferenceable iterator of the view. +type: `mapped_type&`; `position` is a valid dereferenceable iterator of the view. * [*Effects:] Calls `mod(e.second)` where e is the element pointed to by position and rearranges `*position` into all the views of the `bimap`. If the rearrangement fails, the element is erased. @@ -682,10 +685,10 @@ to `x` (and only those). [#reference_unordered_set_of_at_key_const] template< class CompatibleKey > - const data_type & at(const CompatibleKey & k) const; + const mapped_type & at(const CompatibleKey & k) const; * [*Requires: ] `CompatibleKey` is a compatible key of `key_compare`. -* [*Effects:] Returns the `data_type` reference that is associated with `k`, or +* [*Effects:] Returns the `mapped_type` reference that is associated with `k`, or throws `std::out_of_range` if such key does not exist. * [*Complexity:] Average case O(1) (constant), worst case O(n). * [*Note:] Only provided when `unordered_set_of` is used. @@ -699,10 +702,10 @@ Tey are only provided if the other collection type is mutable [#reference_unordered_set_of_operator_bracket_key] template< class CompatibleKey > - data_type & operator[](const CompatibleKey & k); + mapped_type & operator[](const CompatibleKey & k); * [*Requires: ] `CompatibleKey` is a compatible key of `key_compare`. -* [*Effects: ] `return insert(value_type(k,data_type()))->second;` +* [*Effects: ] `return insert(value_type(k,mapped_type()))->second;` * [*Complexity:] If the insertion is performed O(I(n)), else: Average case O(1) (constant), worst case O(n). * [*Note:] Only provided when `unordered_set_of` is used and the other collection @@ -712,10 +715,10 @@ type is mutable. [#reference_unordered_set_of_at_key] template< class CompatibleKey > - data_type & at(const CompatibleKey & k); + mapped_type & at(const CompatibleKey & k); * [*Requires: ] `CompatibleKey` is a compatible key of `key_compare`. -* [*Effects: ] Returns the `data_type` reference that is associated with `k`, or +* [*Effects: ] Returns the `mapped_type` reference that is associated with `k`, or throws `std::out_of_range` if such key does not exist. * [*Complexity:] Average case O(1) (constant), worst case O(n). * [*Note:] Only provided when `unordered_set_of` is used and the other collection @@ -731,17 +734,17 @@ As for bimap::value_not_found, this exception is thrown while trying to access a non-existent key: this behavior differs from that of std::map, which automatically assigns a default value to non-existent keys referred to by `operator[]`. - const data_type & operator[](const typename key_type & k) const; + const mapped_type & operator[](const typename key_type & k) const; -* [*Effects:] Returns the `data_type` reference that is associated with `k`, or +* [*Effects:] Returns the `mapped_type` reference that is associated with `k`, or throws `bimap::value_not_found` if such an element does not exist. * [*Complexity:] O(log(n)). - ``['-unspecified data_type proxy-]`` operator[](const typename key_type & k); + ``['-unspecified mapped_type proxy-]`` operator[](const typename key_type & k); -* [*Effects:] Returns a proxy to a `data_type` associated with `k` and the -bimap. The proxy behaves as a reference to the `data_type` object. If this +* [*Effects:] Returns a proxy to a `mapped_type` associated with `k` and the +bimap. The proxy behaves as a reference to the `mapped_type` object. If this proxy is read and `k` was not in the bimap, the bimap::value_not_found is thrown. If it is written then `bimap::duplicate_value` is thrown if the assignment is not allowed by one of the other views of the `bimap`. diff --git a/libs/bimap/doc/reference/vector_of.qbk b/libs/bimap/doc/reference/vector_of.qbk index 882302e28f..55ce978f35 100644 --- a/libs/bimap/doc/reference/vector_of.qbk +++ b/libs/bimap/doc/reference/vector_of.qbk @@ -163,6 +163,9 @@ for these types of containers. // Only in map views // { + typedef ``['-unspecified-]`` key_type; + typedef ``['-unspecified-]`` mapped_type; + typedef ``['-unspecified-]`` data_type; // Equal to mapped_type template< class CompatibleKey > bool ``[link reference_vector_of_replace_key_iterator_key replace_key]``(iterator position, const CompatibleKey & x); @@ -241,14 +244,14 @@ In the set view: In the left map view: typedef Left key_type; - typedef ... data_type; + typedef ... mapped_type; typedef signature-compatible with std::pair< Left, ... > value_type; In the right map view: typedef ... key_type; - typedef Left data_type; + typedef Left mapped_type; typedef signature-compatible with std::pair< ... , Left > value_type; @@ -505,7 +508,7 @@ its original state. bool replace_data(iterator position, const CompatibleData & x); * [*Requires: ] `position` is a valid dereferenceable iterator of the set view. -`CompatibleKey` can be assigned to `data_type`. +`CompatibleKey` can be assigned to `mapped_type`. * [*Effects:] Assigns the value `x` to `e.second`, where `e` is the element pointed to by `position` into the `bimap` to which the set view belongs if replacing is allowed by all other views of the `bimap`. @@ -544,7 +547,7 @@ operation (except possibly mod), then the element pointed to by position is eras bool modify_data(iterator position, DataModifier mod); * [*Requires: ] `DataModifier` is a model of __SGI_UNARY_FUNCTION__ accepting arguments of -type: `data_type&`; `position` is a valid dereferenceable iterator of the view. +type: `mapped_type&`; `position` is a valid dereferenceable iterator of the view. * [*Effects:] Calls `mod(e.second)` where e is the element pointed to by position and rearranges `*position` into all the views of the `bimap`. If the rearrangement fails, the element is erased. |