README.md
changeset 10 0ac292cc1467
parent 7 1e8a8b4d209c
child 18 9b30f80f6e49
     1.1 --- a/README.md	Sat Aug 24 02:36:11 2013 -0700
     1.2 +++ b/README.md	Mon Aug 26 20:41:58 2013 -0700
     1.3 @@ -59,6 +59,30 @@
     1.4  * Integer alignment (useful for allocators or code generators).
     1.5  * KE\_DELETE and KE\_OVERRIDE which map to delete and override keywords if C++11 is available.
     1.6  
     1.7 +### Moveable (am-moveable.h)
     1.8 +
     1.9 +Moveable<T> is a helper to emulate C++11 move semantics (rvalue references). A class can implement
    1.10 +a move constructor like so:
    1.11 +
    1.12 +    class X
    1.13 +    {
    1.14 +     public:
    1.15 +      X(Moveable<X> other)
    1.16 +
    1.17 +And a moveable value can be given like:
    1.18 +
    1.19 +    vector.append(Moveable<X>(value));
    1.20 +
    1.21 +Containers within AMTL all support move semantics; however, not all containers are moveable yet.
    1.22 +If move semantics are critical for correctness or performance, it is wise to disallow copy
    1.23 +construction entirely:
    1.24 +
    1.25 +    class X
    1.26 +    {
    1.27 +     ...
    1.28 +     private:
    1.29 +      X(const X &other) KE_DELETE;
    1.30 +
    1.31  ### Thread Utilities (am-thread-utils.h)
    1.32  
    1.33  Thread utils provides access to common sychronization primitives: mutexes, condition variables,
    1.34 @@ -136,9 +160,14 @@
    1.35  
    1.36  ### HashMap (am-hashmap.h)
    1.37  
    1.38 -ke::HashMap is a key -> value map built upon HashTable. This saves you from having to implement our
    1.39 -own Policy and provides some more generic accessors. However it is still necessary to implement a
    1.40 -hash function.
    1.41 +ke::HashMap is a key -> value map built upon HashTable. This saves you from having to implement all
    1.42 +of a Policy and provides some more generic accessors. However it is still necessary to implement a
    1.43 +hash and comparison function.
    1.44 +
    1.45 +### HashSet (am-hashset.h)
    1.46 +
    1.47 +ke::HashSet is a HashMap that only stores keys. Like HashMap, you must still implement a policy
    1.48 +with comparison and hash functions.
    1.49  
    1.50  ### InlineList (am-inlinelist.h)
    1.51