cds/container/details/base.h

   1 /*
   2     This file is a part of libcds - Concurrent Data Structures library
   3
   4     (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016
   5
   6     Source code repo: http://github.com/khizmax/libcds/
   7     Download: http://sourceforge.net/projects/libcds/files/
   8
   9     Redistribution and use in source and binary forms, with or without
  10     modification, are permitted provided that the following conditions are met:
  11
  12     * Redistributions of source code must retain the above copyright notice, this
  13       list of conditions and the following disclaimer.
  14
  15     * Redistributions in binary form must reproduce the above copyright notice,
  16       this list of conditions and the following disclaimer in the documentation
  17       and/or other materials provided with the distribution.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  23     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  25     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  26     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27     OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 */
  30
  31 #ifndef CDSLIB_CONTAINER_DETAILS_BASE_H
  32 #define CDSLIB_CONTAINER_DETAILS_BASE_H
  33
  34 #include <cds/intrusive/details/base.h>
  35
  36 namespace cds {
  37
  38 /// Standard (non-intrusive) containers
  39 /**
  40     @ingroup cds_nonintrusive_containers
  41     This namespace contains implementations of non-intrusive (std-like) lock-free containers.
  42 */
  43 namespace container {
  44
  45     /// Common options for non-intrusive containers
  46     /** @ingroup cds_nonintrusive_helper
  47         This namespace contains options for non-intrusive containers that is, in general, the same as for the intrusive containers.
  48         It imports all definitions from cds::opt and cds::intrusive::opt namespaces
  49     */
  50     namespace opt {
  51         using namespace cds::intrusive::opt;
  52     }   // namespace opt
  53
  54     /// @defgroup cds_nonintrusive_containers Non-intrusive containers
  55     /** @defgroup cds_nonintrusive_helper Helper structs for non-intrusive containers
  56         @ingroup cds_nonintrusive_containers
  57     */
  58
  59     /** @defgroup cds_nonintrusive_stack Stack
  60         @ingroup cds_nonintrusive_containers
  61     */
  62     /** @defgroup cds_nonintrusive_queue Queue
  63         @ingroup cds_nonintrusive_containers
  64     */
  65     /** @defgroup cds_nonintrusive_deque Deque
  66         @ingroup cds_nonintrusive_containers
  67     */
  68     /** @defgroup cds_nonintrusive_priority_queue Priority queue
  69         @ingroup cds_nonintrusive_containers
  70     */
  71     /** @defgroup cds_nonintrusive_map Map
  72         @ingroup cds_nonintrusive_containers
  73     */
  74     /** @defgroup cds_nonintrusive_set Set
  75         @ingroup cds_nonintrusive_containers
  76     */
  77     /** @defgroup cds_nonintrusive_list List
  78         @ingroup cds_nonintrusive_containers
  79     */
  80     /** @defgroup cds_nonintrusive_tree Tree
  81         @ingroup cds_nonintrusive_containers
  82     */
  83
  84 }   // namespace container
  85 }   // namespace cds
  86
  87 #endif // #ifndef CDSLIB_CONTAINER_DETAILS_BASE_H