On dev: vc

[libcds.git] / readme.md

diff --git a/readme.md b/readme.md
index 3425013d28dfcae2dd80b6e1bafc867513bc2bdf..5093697bb75f0144faca23a9e6915de559a9cc0b 100644 (file)
--- a/readme.md
+++ b/readme.md
@@ -1,6 +1,8 @@
 CDS C++ library\r
 ===============\r
 [![GitHub version](https://badge.fury.io/gh/khizmax%2Flibcds.svg)](http://badge.fury.io/gh/khizmax%2Flibcds)\r
+[![License](https://img.shields.io/:license-bsd-blue.svg?style=round-square)](https://github.com/khizmax/libcds/blob/master/LICENSE)\r
+\r
 <!---\r
 The build time for lib and hdr-test is exceed the limit of 50 minutes\r
 [![Build Status](https://travis-ci.org/khizmax/libcds.svg?branch=dev)](https://travis-ci.org/khizmax/libcds)\r
@@ -13,7 +15,8 @@ The coverity dataset is about 4G of size and about 1G in compressed state so it
 The Concurrent Data Structures (CDS) library is a collection of concurrent containers\r
 that don't require external (manual) synchronization for shared access, and safe memory reclamation (SMR) \r
 algorithms like [Hazard Pointer](http://en.wikipedia.org/wiki/Hazard_pointer) \r
-and user-space [RCU](http://en.wikipedia.org/wiki/Read-copy-update). \r
+and user-space [RCU](http://en.wikipedia.org/wiki/Read-copy-update) that is used as an epoch-based SMR.\r
+\r
 CDS is mostly header-only template library. Only SMR core implementation is segregated to .so/.dll file.\r
 \r
 The library contains the implementations of the following containers:\r
@@ -23,9 +26,12 @@ The library contains the implementations of the following containers:
   - several implementation of unordered set/map - lock-free and fine-grained lock-based\r
   - [flat-combining] (http://mcg.cs.tau.ac.il/projects/projects/flat-combining) technique\r
   - lock-free [skip-list](http://en.wikipedia.org/wiki/Skip_list)\r
+  - lock-free FeldmanHashMap/Set [Multi-Level Array Hash](http://samos-conference.com/Resources_Samos_Websites/Proceedings_Repository_SAMOS/2013/Files/2013-IC-20.pdf)\r
+    with thread-safe bidirectional iterator support\r
+  - Bronson's et al algorithm for fine-grained lock-based AVL tree\r
   \r
 Generally, each container has an intrusive and non-intrusive (STL-like) version belonging to \r
-*cds::intrusive* and *cds::container* namespace respectively.\r
+*cds::intrusive* and *cds::container* namespace respectively. \r
 \r
 Version 2.x of the library is written on C++11 and can be compiled by GCC 4.8+, clang 3.3+, Intel C++ 15+, \r
 and MS VC++ 12 (2013) Update 4.\r
@@ -34,12 +40,18 @@ Download the latest release from http://sourceforge.net/projects/libcds/files/
 \r
 See online doxygen-generated doc here: http://libcds.sourceforge.net/doc/cds-api/index.html\r
 \r
+Evolution of libcds (Gource visualization by Landon Wilkins): https://www.youtube.com/watch?v=FHaJvVdmJ0w\r
+\r
+**How to build**\r
+   - *nix: [use CMake](build/cmake/readme.md)\r
+   - Windows: use MS Visual C++ 2015 project\r
+\r
 **Pull request requirements**\r
 - Pull-request to *master* branch will be unconditionally rejected\r
 - *integration* branch is intended for pull-request. Usually, *integration* branch is the same as *master*\r
 - *dev* branch is intended for main developing. Usually, it contains unstable code\r
 \r
-[![OpenHub statistics](https://www.openhub.net/p/khizmax-libcds/widgets/project_thin_badge)](https://www.openhub.net/p/khizmax-libcds/widgets/project_thin_badge)\r
+[![Project stats](https://www.openhub.net/p/khizmax-libcds/widgets/project_thin_badge.gif)](https://www.openhub.net/p/khizmax-libcds)\r
 \r
 References\r
 ----------\r
@@ -83,6 +95,9 @@ References
   - *StripedMap*, *StripedSet*: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"\r
   - *CuckooMap*, *CuckooSet*: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"\r
   - *SkipListMap*, *SkipListSet*: [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"\r
+  - *FeldmanHashMap*, *FeldmanHashSet*: [2013] Steven Feldman, Pierre LaBorde, Damian Dechev "Concurrent Multi-level Arrays:\r
+        Wait-free Extensible Hash Maps". Supports **thread-safe bidirectional iterators**\r
+        [pdf](http://samos-conference.com/Resources_Samos_Websites/Proceedings_Repository_SAMOS/2013/Files/2013-IC-20.pdf)\r
         \r
 *Ordered single-linked list*\r
   - *LazyList*: [2005] Steve Heller, Maurice Herlihy, Victor Luchangco, Mark Moir, William N. Scherer III, and Nir Shavit "A Lazy Concurrent List-Based Set Algorithm"\r