comparison: src/cx/map.h
src/cx/map.h
- changeset 992
- 14ca894190fd
- parent 985
- 68754c7de906
- child 993
- b642eca4b956
equal
deleted
inserted
replaced
| 991:ec49db06dae0 | 992:14ca894190fd |
|---|---|
| 237 // TODO: set-like map operations (union, intersect, difference) | 237 // TODO: set-like map operations (union, intersect, difference) |
| 238 | 238 |
| 239 /** | 239 /** |
| 240 * Creates a value iterator for a map. | 240 * Creates a value iterator for a map. |
| 241 * | 241 * |
| 242 * \note An iterator iterates over all elements successively. Therefore the order | 242 * \note An iterator iterates over all elements successively. Therefore, the order |
| 243 * highly depends on the map implementation and may change arbitrarily when the contents change. | 243 * highly depends on the map implementation and may change arbitrarily when the contents change. |
| 244 * | 244 * |
| 245 * @param map the map to create the iterator for | 245 * @param map the map to create the iterator for |
| 246 * @return an iterator for the currently stored values | 246 * @return an iterator for the currently stored values |
| 247 */ | 247 */ |
| 254 /** | 254 /** |
| 255 * Creates a key iterator for a map. | 255 * Creates a key iterator for a map. |
| 256 * | 256 * |
| 257 * The elements of the iterator are keys of type CxHashKey. | 257 * The elements of the iterator are keys of type CxHashKey. |
| 258 * | 258 * |
| 259 * \note An iterator iterates over all elements successively. Therefore the order | 259 * \note An iterator iterates over all elements successively. Therefore, the order |
| 260 * highly depends on the map implementation and may change arbitrarily when the contents change. | 260 * highly depends on the map implementation and may change arbitrarily when the contents change. |
| 261 * | 261 * |
| 262 * @param map the map to create the iterator for | 262 * @param map the map to create the iterator for |
| 263 * @return an iterator for the currently stored keys | 263 * @return an iterator for the currently stored keys |
| 264 */ | 264 */ |
| 271 /** | 271 /** |
| 272 * Creates an iterator for a map. | 272 * Creates an iterator for a map. |
| 273 * | 273 * |
| 274 * The elements of the iterator are key/value pairs of type CxMapEntry. | 274 * The elements of the iterator are key/value pairs of type CxMapEntry. |
| 275 * | 275 * |
| 276 * \note An iterator iterates over all elements successively. Therefore the order | 276 * \note An iterator iterates over all elements successively. Therefore, the order |
| 277 * highly depends on the map implementation and may change arbitrarily when the contents change. | 277 * highly depends on the map implementation and may change arbitrarily when the contents change. |
| 278 * | 278 * |
| 279 * @param map the map to create the iterator for | 279 * @param map the map to create the iterator for |
| 280 * @return an iterator for the currently stored entries | 280 * @return an iterator for the currently stored entries |
| 281 * @see cxMapIteratorKeys() | 281 * @see cxMapIteratorKeys() |
| 289 | 289 |
| 290 | 290 |
| 291 /** | 291 /** |
| 292 * Creates a mutating iterator over the values of a map. | 292 * Creates a mutating iterator over the values of a map. |
| 293 * | 293 * |
| 294 * \note An iterator iterates over all elements successively. Therefore the order | 294 * \note An iterator iterates over all elements successively. Therefore, the order |
| 295 * highly depends on the map implementation and may change arbitrarily when the contents change. | 295 * highly depends on the map implementation and may change arbitrarily when the contents change. |
| 296 * | 296 * |
| 297 * @param map the map to create the iterator for | 297 * @param map the map to create the iterator for |
| 298 * @return an iterator for the currently stored values | 298 * @return an iterator for the currently stored values |
| 299 */ | 299 */ |
| 304 /** | 304 /** |
| 305 * Creates a mutating iterator over the keys of a map. | 305 * Creates a mutating iterator over the keys of a map. |
| 306 * | 306 * |
| 307 * The elements of the iterator are keys of type CxHashKey. | 307 * The elements of the iterator are keys of type CxHashKey. |
| 308 * | 308 * |
| 309 * \note An iterator iterates over all elements successively. Therefore the order | 309 * \note An iterator iterates over all elements successively. Therefore, the order |
| 310 * highly depends on the map implementation and may change arbitrarily when the contents change. | 310 * highly depends on the map implementation and may change arbitrarily when the contents change. |
| 311 * | 311 * |
| 312 * @param map the map to create the iterator for | 312 * @param map the map to create the iterator for |
| 313 * @return an iterator for the currently stored keys | 313 * @return an iterator for the currently stored keys |
| 314 */ | 314 */ |
| 319 /** | 319 /** |
| 320 * Creates a mutating iterator for a map. | 320 * Creates a mutating iterator for a map. |
| 321 * | 321 * |
| 322 * The elements of the iterator are key/value pairs of type CxMapEntry. | 322 * The elements of the iterator are key/value pairs of type CxMapEntry. |
| 323 * | 323 * |
| 324 * \note An iterator iterates over all elements successively. Therefore the order | 324 * \note An iterator iterates over all elements successively. Therefore, the order |
| 325 * highly depends on the map implementation and may change arbitrarily when the contents change. | 325 * highly depends on the map implementation and may change arbitrarily when the contents change. |
| 326 * | 326 * |
| 327 * @param map the map to create the iterator for | 327 * @param map the map to create the iterator for |
| 328 * @return an iterator for the currently stored entries | 328 * @return an iterator for the currently stored entries |
| 329 * @see cxMapMutIteratorKeys() | 329 * @see cxMapMutIteratorKeys() |
