rb_lovely 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee5ff98c21526db5492808222dda0a1323a6e307
-  data.tar.gz: abdce3830c9a0be152907318f05f0f7267332814
+  metadata.gz: b5d7473f46f078962567e35e26f31e444a221cbd
+  data.tar.gz: 8ed3631fc234e853cae5cd35d3dbe16db41af6bf
 SHA512:
-  metadata.gz: 0ae92b111ea962b4e7e962d556a428c3627e62d724417e05846f875177c76e4b37fd9816103567ae50139dabe55da64e0ac1f835341b5ec6c883505d6be492c6
-  data.tar.gz: 91f3b2d225924117724ebdeb3a23948eeb728500d4bf60635a4687385e1038de8aa6552ee33cf67ec01d045555bced30c96030f85def4452d9d2dc6414d6640c
+  metadata.gz: aebd51f11653b4fcb7c198d54405d6d2394f624fa57dab474de57b34806c54f588fb29b3dc172a0538ef59993aab3f236363c28b925afa84582a0dcc14f225d3
+  data.tar.gz: d3f14f1f337dfe379f0d9b279e02d6b2cf068b55d3e1a3263060c22b3d14617138c6e0e4a1d95e933b2d3a169e439077f21e8b51eedf4cf7e12b88b4ef424e28

data/ext/rb_lovely/sorted_hash.cpp

@@ -228,19 +228,31 @@ VALUE hashDelete(VALUE self, VALUE toDelete) {
   }
 }
 
+enum class ValueOrKey { VALUE, KEY, BOTH };
+
+template <ValueOrKey V>
 VALUE hashShift(VALUE self) {
   Hash* hash = rubyCast<Hash>(self);
   if (hash->container.empty())
    return Qnil;
 
   auto& idx = hash->container.get<1>();
-  auto keyBak = idx.begin()->key;
-  auto valBak = idx.begin()->val;
-  idx.erase(idx.begin());
+  auto first = idx.begin();
+  if (V == ValueOrKey::BOTH) {
+    auto keyBak = first->key;
+    auto valBak = first->val;
+    idx.erase(first);
 
-  return rb_ary_new3(2, keyBak, valBak);
+    return rb_ary_new3(2, keyBak, valBak);
+  }
+  else {
+    auto bak = V == ValueOrKey::VALUE ? first->val : first->key;
+    idx.erase(first);
+    return bak;
+  }
 }
 
+template <ValueOrKey V>
 VALUE hashPop(VALUE self) {
   Hash* hash = rubyCast<Hash>(self);
   if (hash->container.empty())
@@ -249,35 +261,18 @@ VALUE hashPop(VALUE self) {
   auto& idx = hash->container.get<1>();
   auto last = idx.end();
   --last;
-  auto keyBak = last->key;
-  auto valBak = last->val;
-  idx.erase(last);
-
-  return rb_ary_new3(2, keyBak, valBak);
-}
 
-VALUE hashShiftValue(VALUE self) {
-  Hash* hash = rubyCast<Hash>(self);
-  if (hash->container.empty())
-   return Qnil;
-
-  auto& idx = hash->container.get<1>();
-  auto bak = idx.begin()->val;
-  idx.erase(idx.begin());
-  return bak;
-}
-
-VALUE hashPopValue(VALUE self) {
-  Hash* hash = rubyCast<Hash>(self);
-  if (hash->container.empty())
-    return Qnil;
-
-  auto& idx = hash->container.get<1>();
-  auto last = idx.end();
-  --last;
-  auto bak = last->val;
-  idx.erase(last);
-  return bak;
+  if (V == ValueOrKey::BOTH) {
+    auto keyBak = last->key;
+    auto valBak = last->val;
+    idx.erase(last);
+    return rb_ary_new3(2, keyBak, valBak);
+  }
+  else {
+    auto bak = V == ValueOrKey::VALUE ? last->val : last->key;
+    idx.erase(last);
+    return bak;
+  }
 }
 
 VALUE hashHas(VALUE self, VALUE key) {
@@ -324,10 +319,12 @@ extern "C" {
     // rb_define_method(rbHash, "reject!", RUBY_METHOD_FUNC(hashMutatingReject), 0);
     // rb_define_method(rbHash, "reject_first!", RUBY_METHOD_FUNC(hashMutatingRejectFirst), 0);
     // rb_define_method(rbHash, "select!", RUBY_METHOD_FUNC(hashMutatingSelect), 0);
-    rb_define_method(rbHash, "shift", RUBY_METHOD_FUNC(hashShift), 0);
-    rb_define_method(rbHash, "pop", RUBY_METHOD_FUNC(hashPop), 0);
-    rb_define_method(rbHash, "shift_value", RUBY_METHOD_FUNC(hashShiftValue), 0);
-    rb_define_method(rbHash, "pop_value", RUBY_METHOD_FUNC(hashPopValue), 0);
+    rb_define_method(rbHash, "shift", RUBY_METHOD_FUNC(hashShift<ValueOrKey::BOTH>), 0);
+    rb_define_method(rbHash, "shift_value", RUBY_METHOD_FUNC(hashShift<ValueOrKey::VALUE>), 0);
+    rb_define_method(rbHash, "shift_key", RUBY_METHOD_FUNC(hashShift<ValueOrKey::KEY>), 0);
+    rb_define_method(rbHash, "pop", RUBY_METHOD_FUNC(hashPop<ValueOrKey::BOTH>), 0);
+    rb_define_method(rbHash, "pop_value", RUBY_METHOD_FUNC(hashPop<ValueOrKey::VALUE>), 0);
+    rb_define_method(rbHash, "pop_key", RUBY_METHOD_FUNC(hashPop<ValueOrKey::KEY>), 0);
     // Enumerable would test both key and value for include?
     rb_define_method(rbHash, "include?", RUBY_METHOD_FUNC(hashHas), 1);
     rb_define_method(rbHash, "has_key?", RUBY_METHOD_FUNC(hashHas), 1);

data/yard.rb

@@ -248,10 +248,10 @@ module RbLovely
     # @complexity O(c)
     # @example
     #   @set = RbLovely::SortedHash [:a, 2, :b, 1]
-    #   expect(@set.first).to equal [:b, 1]
+    #   expect(@set.first).to eql [:b, 1]
     def first ; end
 
-    # Retrieve first_value value as determined by value sort order or nil if the hash is empty.
+    # Retrieve first value as determined by value sort order or nil if the hash is empty.
     # @complexity O(c)
     # @return [Array] The first key-value pair in the hash.
     # @example
@@ -259,6 +259,14 @@ module RbLovely
     #   expect(@set.first_value).to equal 1
     def first_value ; end
 
+    # Retrieve first key as determined by value sort order or nil if the hash is empty.
+    # @complexity O(c)
+    # @return The first key in the hash
+    # @example
+    #   @set = RbLovely::SortedHash [:a, 1, :b, 2]
+    #   expect(@set.first_value).to equal :a
+    def first_key ; end
+
     # Retrieve last key-value pair as determined by value sort order or nil if the hash is empty.
     # @complexity O(c)
     # @return [Array] The last key-value pair in the hash.
@@ -274,6 +282,13 @@ module RbLovely
     #   expect(@set.last_value).to equal 2
     def last_value ; end
 
+    # Retrieve last key as determined by value sort order or nil if the hash is empty.
+    # @complexity O(c)
+    # @example
+    #   @set = RbLovely::SortedHash [:a, 1, :b, 2]
+    #   expect(@set.last_key).to equal :b
+    def last_key ; end
+
     # Remove the first key-value pair in the hash and return it or return nil if the hash is empty.
     # @complexity O(c).
     # @see #pop
@@ -283,6 +298,24 @@ module RbLovely
     #   expect(hash.shift).to equal [:a, 2]
     def shift ; end
 
+    # Remove the first key-value pair in the hash and return the key or return nil if the hash is empty.
+    # @complexity O(c).
+    # @see #pop_key
+    # @return The first key pair according to the <=> method defined on each member or nil if the hash is empty.
+    # @example
+    #   set = RbLovely::SortedHash [:a, 2, :b, 10]
+    #   expect(hash.shift_key).to equal :a
+    def shift_key ; end
+
+    # Remove the first key-value pair in the hash and return the value or return nil if the hash is empty.
+    # @complexity O(c).
+    # @see #pop_value
+    # @return The first key pair according to the <=> method defined on each member or nil if the hash is empty.
+    # @example
+    #   set = RbLovely::SortedHash [:a, 2, :b, 10]
+    #   expect(hash.shift_value).to equal 2
+    def shift_value ; end
+
     # Remove the last key-value pair in the hash and return it or return nil if the hash is empty.
     # @complexity O(c).
     # @see #shift
@@ -292,6 +325,24 @@ module RbLovely
     #   expect(hash.pop).to equal [:b, 10]
     def pop ; end
 
+    # Remove the last key-value pair in the hash and return the key or return nil if the hash is empty.
+    # @complexity O(c).
+    # @see #shift_key
+    # @return The last key according to the <=> method defined on each member or nil if the hash is empty.
+    # @example
+    #   set = RbLovely::SortedHash [:a, 2, :b, 10]
+    #   expect(hash.pop_key).to equal :b
+    def pop_key ; end
+
+    # Remove the last key-value pair in the hash and return the value or return nil if the hash is empty.
+    # @complexity O(c).
+    # @see #shift_value
+    # @return The last key according to the <=> method defined on each member or nil if the hash is empty.
+    # @example
+    #   set = RbLovely::SortedHash [:a, 2, :b, 10]
+    #   expect(hash.pop_value).to equal 10
+    def pop_value ; end
+
     # Remove the first key-value pair in the hash and return it or return nil if the hash is empty.
     # @complexity O(c).
     # @see #pop_value

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rb_lovely
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - James Pike
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-06 00:00:00.000000000 Z
+date: 2014-09-07 00:00:00.000000000 Z
 dependencies: []
 description: A fast sorted set built using std::set and a fast sorted hash built using
   boost::multi_index_container.