X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=gdax-orderbook-hpp%2Fdemo%2Fdependencies%2Flibcds-2.3.2%2Fcds%2Fcontainer%2Fsplit_list_map_nogc.h;fp=gdax-orderbook-hpp%2Fdemo%2Fdependencies%2Flibcds-2.3.2%2Fcds%2Fcontainer%2Fsplit_list_map_nogc.h;h=3ae82f235d3a2ac60de90f074518cd347c4c7ef0;hb=4223430d9168223029c7639149025c79e69b4f37;hp=0000000000000000000000000000000000000000;hpb=7ea7751a31c0388bf888052517be181a2989b113;p=c11concurrency-benchmarks.git diff --git a/gdax-orderbook-hpp/demo/dependencies/libcds-2.3.2/cds/container/split_list_map_nogc.h b/gdax-orderbook-hpp/demo/dependencies/libcds-2.3.2/cds/container/split_list_map_nogc.h new file mode 100644 index 0000000..3ae82f2 --- /dev/null +++ b/gdax-orderbook-hpp/demo/dependencies/libcds-2.3.2/cds/container/split_list_map_nogc.h @@ -0,0 +1,389 @@ +/* + This file is a part of libcds - Concurrent Data Structures library + + (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2017 + + Source code repo: http://github.com/khizmax/libcds/ + Download: http://sourceforge.net/projects/libcds/files/ + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE + FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +*/ + +#ifndef CDSLIB_CONTAINER_SPLIT_LIST_MAP_NOGC_H +#define CDSLIB_CONTAINER_SPLIT_LIST_MAP_NOGC_H + +#include +#include + +namespace cds { namespace container { + + /// Split-ordered list map (template specialization for gc::nogc) + /** @ingroup cds_nonintrusive_map + \anchor cds_nonintrusive_SplitListMap_nogc + + This specialization is so-called append-only. + The map does not support the removal of list item. + + See \ref cds_nonintrusive_SplitListMap_hp "SplitListMap" for description of template parameters. + + @warning Many member functions return an iterator pointing to an item. + The iterator can be used to set up field of the item, + but you should provide an exclusive access to it, + see \ref cds_intrusive_item_creating "insert item troubleshooting". + */ + template < + typename Key, + typename Value, +#ifdef CDS_DOXYGEN_INVOKED + class Traits = split_list::traits +#else + class Traits +#endif + > + class SplitListMap: + protected container::SplitListSet< + cds::gc::nogc, + std::pair, + split_list::details::wrap_map_traits + > + { + //@cond + typedef container::SplitListSet< + cds::gc::nogc, + std::pair, + split_list::details::wrap_map_traits + > base_class; + //@endcond + public: + typedef cds::gc::nogc gc; ///< Garbage collector + typedef Key key_type; ///< key type + typedef Value mapped_type; ///< type of value stored in the map + + typedef std::pair value_type ; ///< Pair type + typedef typename base_class::ordered_list ordered_list; ///< Underlying ordered list class + typedef typename base_class::key_comparator key_comparator; ///< key comparison functor + + typedef typename base_class::hash hash; ///< Hash functor for \ref key_type + typedef typename base_class::item_counter item_counter; ///< Item counter type + typedef typename base_class::stat stat; ///< Internal statistics + + protected: + //@cond + typedef typename base_class::traits::key_accessor key_accessor; + //@endcond + + public: + ///@name Forward iterators + //@{ + /// Forward iterator + /** + The forward iterator for split-list is based on \p OrderedList forward iterator and has some features: + - it has no post-increment operator + - it iterates items in unordered fashion + + The iterator interface: + \code + class iterator { + public: + // Default constructor + iterator(); + + // Copy construtor + iterator( iterator const& src ); + + // Dereference operator + value_type * operator ->() const; + + // Dereference operator + value_type& operator *() const; + + // Preincrement operator + iterator& operator ++(); + + // Assignment operator + iterator& operator = (iterator const& src); + + // Equality operators + bool operator ==(iterator const& i ) const; + bool operator !=(iterator const& i ) const; + }; + \endcode + */ + typedef typename base_class::iterator iterator; + + /// Const forward iterator + typedef typename base_class::const_iterator const_iterator; + + /// Returns a forward iterator addressing the first element in a map + /** + For empty set \code begin() == end() \endcode + */ + iterator begin() + { + return base_class::begin(); + } + + /// Returns an iterator that addresses the location succeeding the last element in a map + /** + Do not use the value returned by end function to access any item. + The returned value can be used only to control reaching the end of the set. + For empty set \code begin() == end() \endcode + */ + iterator end() + { + return base_class::end(); + } + + /// Returns a forward const iterator addressing the first element in a map + const_iterator begin() const + { + return base_class::begin(); + } + + /// Returns a forward const iterator addressing the first element in a map + const_iterator cbegin() const + { + return base_class::cbegin(); + } + + /// Returns an const iterator that addresses the location succeeding the last element in a map + const_iterator end() const + { + return base_class::end(); + } + + /// Returns an const iterator that addresses the location succeeding the last element in a map + const_iterator cend() const + { + return base_class::cend(); + } + //@} + + public: + /// Initialize split-ordered map of default capacity + /** + The default capacity is defined in bucket table constructor. + See \p intrusive::split_list::expandable_bucket_table, \p intrusive::split_list::static_ducket_table + which selects by \p intrusive::split_list::traits::dynamic_bucket_table. + */ + SplitListMap() + : base_class() + {} + + /// Initialize split-ordered map + SplitListMap( + size_t nItemCount ///< estimated average item count + , size_t nLoadFactor = 1 ///< load factor - average item count per bucket. Small integer up to 10, default is 1. + ) + : base_class( nItemCount, nLoadFactor ) + {} + + public: + /// Inserts new node with key and default value + /** + The function creates a node with \p key and default value, and then inserts the node created into the map. + + Preconditions: + - The \p key_type should be constructible from value of type \p K. + In trivial case, \p K is equal to \ref key_type. + - The \p mapped_type should be default-constructible. + + Returns an iterator pointed to inserted value, or \p end() if inserting is failed + */ + template + iterator insert( K const& key ) + { + //TODO: pass arguments by reference (make_pair makes copy) + return base_class::emplace( key_type( key ), mapped_type()); + } + + /// Inserts new node + /** + The function creates a node with copy of \p val value + and then inserts the node created into the map. + + Preconditions: + - The \p key_type should be constructible from \p key of type \p K. + - The \p mapped_type should be constructible from \p val of type \p V. + + Returns an iterator pointed to inserted value, or \p end() if inserting is failed + */ + template + iterator insert( K const& key, V const& val ) + { + return base_class::emplace( key_type( key ), mapped_type( val )); + } + + /// Inserts new node and initialize it by a functor + /** + This function inserts new node with key \p key and if inserting is successful then it calls + \p func functor with signature + \code + struct functor { + void operator()( value_type& item ); + }; + \endcode + + The argument \p item of user-defined functor \p func is the reference + to the map's item inserted. \p item.second is a reference to item's value that may be changed. + User-defined functor \p func should guarantee that during changing item's value no any other changes + could be made on this map's item by concurrent threads. + The user-defined functor is called only if the inserting is successful. + + The \p key_type should be constructible from value of type \p K. + + The function allows to split creating of new item into two part: + - create item from \p key; + - insert new item into the map; + - if inserting is successful, initialize the value of item by calling \p f functor + + This can be useful if complete initialization of object of \p mapped_type is heavyweight and + it is preferable that the initialization should be completed only if inserting is successful. + + Returns an iterator pointed to inserted value, or \p end() if inserting is failed + */ + template + iterator insert_with( const K& key, Func func ) + { + iterator it = insert( key ); + if ( it != end()) + func( (*it)); + return it; + } + + /// For key \p key inserts data of type \p mapped_type created in-place from \p args + /** + \p key_type should be constructible from type \p K + + Returns \p true if inserting successful, \p false otherwise. + */ + template + iterator emplace( K&& key, Args&&... args ) + { + return base_class::emplace( key_type( std::forward( key )), mapped_type( std::forward( args )...)); + } + + /// Updates the item + /** + If \p key is not in the map and \p bAllowInsert is \p true, the function inserts a new item. + Otherwise, the function returns an iterator pointing to the item found. + + Returns std::pair where \p first is an iterator pointing to + item found or inserted (if inserting is not allowed and \p key is not found, the iterator will be \p end()), + + \p second is true if new item has been added or \p false if the item + already is in the map. + */ + template + std::pair update( K const& key, bool bAllowInsert = true ) + { + //TODO: pass arguments by reference (make_pair makes copy) + return base_class::update( std::make_pair( key_type( key ), mapped_type()), bAllowInsert ); + } + //@cond + template + CDS_DEPRECATED("ensure() is deprecated, use update()") + std::pair ensure( K const& key ) + { + return update( key, true ); + } + //@endcond + + /// Checks whether the map contains \p key + /** + The function searches the item with key equal to \p key + and returns an iterator pointed to item found and \ref end() otherwise + */ + template + iterator contains( K const& key ) + { + return base_class::contains( key ); + } + //@cond + template + CDS_DEPRECATED("deprecated, use contains()") + iterator find( K const& key ) + { + return contains( key ); + } + //@endcond + + /// Checks whether the map contains \p key using \p pred predicate for searching + /** + The function is an analog of contains( key ) but \p pred is used for key comparing. + \p Less functor has the interface like \p std::less. + \p pred must imply the same element order as the comparator used for building the map. + */ + template + iterator contains( K const& key, Less pred ) + { + CDS_UNUSED( pred ); + return base_class::contains( key, cds::details::predicate_wrapper()); + } + //@cond + template + CDS_DEPRECATED("deprecated, use contains()") + iterator find_with( K const& key, Less pred ) + { + return contains( key, pred ); + } + //@endcond + + + /// Clears the set (not atomic, for debugging purposes only) + void clear() + { + base_class::clear(); + } + + /// Checks if the map is empty + /** + Emptiness is checked by item counting: if item count is zero then the map is empty. + Thus, the correct item counting feature is an important part of Michael's map implementation. + */ + bool empty() const + { + return base_class::empty(); + } + + /// Returns item count in the map + size_t size() const + { + return base_class::size(); + } + + /// Returns internal statistics + stat const& statistics() const + { + return base_class::statistics(); + } + + /// Returns internal statistics for \p ordered_list + typename ordered_list::stat const& list_statistics() const + { + return base_class::list_statistics(); + } + }; +}} // namespace cds::container + + +#endif // #ifndef CDSLIB_CONTAINER_SPLIT_LIST_MAP_NOGC_H