pqueue 2.0.2 → 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58541f0cdd4e79a637522d1d78794428c6ea6510
+  data.tar.gz: 7834f9997de1480be4d11bef6c9e4ad08d547644
+SHA512:
+  metadata.gz: 85926b70318b7a6b3b0a5f5fbcad2ee4ef667435db897151618bcf645c5bb219ad6a5b1503c6a2871abed96f44e951a0a275c1575bcea4c641ee5323c0a0672d
+  data.tar.gz: 4dfb6c6d2e0413f6c636e6d54a4cc56216994795cd6d2fe83d07b0f01527a2ec880a82927ec44ac0bfd01babc36e41ea3a2733d8e56bfc944f9a53e4fc31eb3e

data/Contributing.md

@@ -0,0 +1,63 @@
+# CONTRIBUTING
+
+## Setup
+
+Once you've cloned the repo, hit up Bundler.
+
+```
+$ bundle
+```
+
+## Testing
+
+We are using the Microtest framework which is a very simple test
+framework built to mimic the original Test::Unit but build on
+Ruby Test, the slick meta-testing framework.
+
+Thanks to the configuration in `etc/test.rb` running test should
+be as simple as:
+
+```
+$ rubytest
+```
+
+## Releasing
+
+When releasing a new version there a few things that need to done.
+First, of course, make sure the version number is correct by editing
+the `Index.yml` file. Then update the canonical `.index` file via:
+
+```
+$ index -u Index.yml Gemfile
+```
+
+Also, don't forget to add an entry to the `HISTORY.md` file for the
+new release.
+
+Though it is not likely to be needed for this project, ensure the MANIFEST
+is up to date:
+
+```
+$ mast -u
+```
+
+Now build the gem:
+
+```
+$ gem build .gemspec
+```
+
+To release simply use:
+
+```
+$ gem push pqueue-x.x.x.gem
+```
+
+Finally, don't forget to add a tag for the release. I always use the
+description of the release from the HISTORY file as the tag message
+(excluding the changes list).
+
+```
+$ gem tag -a x.x.x
+```
+

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ae (1.8.2)
+      ansi
+    ansi (1.4.3)
+    indexer (0.3.1)
+    microtest (0.2.1)
+      rubytest
+    rubytest (0.7.0)
+      ansi
+    rubytest-cli (0.1.0)
+      ansi
+      rubytest (>= 0.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ae
+  indexer
+  microtest
+  rubytest
+  rubytest-cli

data/{HISTORY.rdoc → History.md}

@@ -1,6 +1,23 @@
-= CHANGE HISTORY
+# CHANGE HISTORY
 
-== 2.0.2 / 2011-10-29
+## 2.1.0 / 2014-03-03
+
+Ostatnicky has found a bug! As it turns out both `#deq` and `#shift` were 
+aliased incorrectly to `push`, when they should have been to `#pop`. 
+With this release that has been fixes, but we have modified `#shift`
+to instead return the lowest priority item, which is a more polymorphic
+definition with its use in Array. In addition we have added `#peek` as
+an alias for `#top`, and added `bottom`, which it the opposite of `#top`.
+
+Changes:
+
+* Fix `#deq` as alias of `#pop`, not `#push`.
+* Fix `#shift` to be like `#pop` but opposite priority.
+* Add `#peek` as alias of `#top`.
+* Add `#bottom` method as opposite of `#top`.
+
+
+## 2.0.2 / 2011-10-29
 
 It's been one of those days. I went to to get a wash cloth for the shower,
 on my way through the kitchen realized the chilling cookie dough needed to
@@ -13,10 +30,10 @@ me food I don't want to eat. Yea, one of those days!
 
 Changes:
 
-* Fixed #reheap search algorithm.
+* Fixed `#reheap` search algorithm.
 
 
-== 2.0.1 / 2011-10-29
+## 2.0.1 / 2011-10-29
 
 Quick fix to remove old legacy library that was supposed to be 
 removed in previous release. No big deal, it just confused the 
@@ -27,7 +44,7 @@ Changes:
 * Remove legacy version of library.
 
 
-== 2.0.0 / 2011-10-29
+## 2.0.0 / 2011-10-29
 
 This is a complete rewrite to simplify the design and use more
 of Ruby's internal methods.  Overall performance should be markedly
@@ -44,7 +61,7 @@ Changes:
 * Switch to BSD-2-Clause license.
 
 
-== 1.0.0 / 2009-07-05
+## 1.0.0 / 2009-07-05
 
 This is the initial standalone release of PQueue, spun-off from the
 Ruby Facets and originally written by K. Komada.

data/Index.yml

@@ -0,0 +1,44 @@
+---
+name:
+  pqueue
+
+version:
+  2.1.0
+
+title:
+  PQueue
+
+summary:
+  Queue of Prioritized Elements
+
+description:
+  A priority queue is like a standard queue, except that each inserted elements
+  is given a certain priority, based on the result of the comparison block given
+  at instantiation time. Retrieving an element from the queue will always return
+  the one with the highest priority.
+
+resources:
+  home: http://rubyworks.github.com/pqueue
+  code: http://github.com/rubyworks/pqueue
+  bugs: http://github.com/rubyworks/pqueue/issues
+
+repositories:
+  upstream: git://github.com/rubyworks/pqueue.git
+
+authors:
+  - Trans <transfire@gmail.com>
+  - K. Kodama
+  - Ronald Butler
+  - Olivier Renaud
+  - Rick Bradley
+
+organization:
+  Rubyworks
+
+created:
+  2001-03-10
+
+copyrights:
+  - (c) 2009 Rubyworks (BSD-2)
+  - (c) 2001 K. Kodama
+

data/License.txt

@@ -0,0 +1,23 @@
+(BSD-2-Clause License)
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+   2. 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 ``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 HOLDERS 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.
+

data/README.md

@@ -0,0 +1,71 @@
+# PQueue
+
+[![Gem Version](https://badge.fury.io/rb/pqueue.png)](http://badge.fury.io/rb/pqueue)
+[![Build Status](https://secure.travis-ci.org/rubyworks/pqueue.png)](http://travis-ci.org/rubyworks/pqueue)    
+[![Flattr Me](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/324911/Rubyworks-Ruby-Development-Fund)
+
+[Website](http://rubyworks.github.com/pqueue) ·
+[YARD API](http://rubydoc.info/gems/pqueue) ·
+[Report Issue](http://github.com/rubyworks/pqueue/issues) ·
+[Source Code](http://github.com/rubyworks/pqueue)
+
+
+## About
+
+PQueue is a priority queue with array based heap.
+A priority queue is like a standard queue, except that each inserted
+element is given a certain priority, based on the result of the
+comparison block given at instantiation time. Also, retrieving an element
+from the queue will always return the one with the highest priority
+(see #pop and #top).
+
+The default is to compare the elements in respect to their #<=> method.
+For example, Numeric elements with higher values will have higher
+priorities.
+
+This library is  a rewrite of the original PQueue.rb by K. Kodama and
+Heap.rb by Ronald Butler. The two libraries were later merged
+and generally improved by Olivier Renaud. Then the whole library 
+rewritten by Trans using the original as a functional reference.
+
+
+## Usage
+
+Usage is simple enough. Think of it as an array that takes a block, where
+the block decides which element of the array goes first.
+
+    require 'pqueue'
+
+    pq = PQueue.new([2,3,1]){ |a,b| a > b }
+
+    pq.pop  #=> 3
+
+
+## Install
+
+Using RubyGems:
+
+    gem install pqueue
+  
+
+## Acknowledgements
+
+Although the library has been completely rewritten since, we still would
+like to acknowledge the efforts of the original PQueue authors and
+contributors.
+
+* Olivier Renaud (2007)
+* Rick Bradley (2003)
+* Ronald Butler (2002)
+* K Kodama (2001, original library)
+
+
+## License & Copyrights
+
+Copyright (c) 2011 Rubyworks
+
+PQueue is distributable in accordance with the *BSD-2-Clause* license.
+
+PQueue is based on the original PQueue library (c) 2001 by K. Kodama.
+
+See the LICENSE.txt file for details.

data/lib/pqueue.rb

@@ -18,7 +18,7 @@
 class PQueue
 
   #
-  VERSION = "2.0.0"  #:erb: VERSION = "<%= version %>"
+  VERSION = "2.1.0"  #:erb: VERSION = "<%= version %>"
 
   #
   # Returns a new priority queue.
@@ -78,17 +78,17 @@ class PQueue
   end
 
   #
-  # Alias of #push.
+  # Traditional alias for #push.
   #
-  alias :<< :push
+  alias enq push
 
   #
   # Alias of #push.
   #
-  alias enq push
+  alias :<< :push
 
   #
-  # Return the element with the highest priority and remove it from
+  # Get the element with the highest priority and remove it from
   # the queue.
   #
   # The highest priority is determined by the block given at instantiation
@@ -104,14 +104,24 @@ class PQueue
   end
 
   #
-  # Alias of #push.
+  # Traditional alias for #pop.
   #
-  alias shift push
+  alias deq pop
 
+  # Get the element with the lowest priority and remove it from
+  # the queue.
+  #
+  # The lowest priority is determined by the block given at instantiation
+  # time.
   #
-  # Alias of #pop.
+  # The deletion time is O(log n), with n is the size of the queue.
+  #
+  # Return nil if the queue is empty.
   #
-  alias deq push
+  def shift
+    return nil if empty?
+    @que.shift
+  end
 
   #
   # Returns the element with the highest priority, but
@@ -122,6 +132,20 @@ class PQueue
     return @que.last
   end
 
+  #
+  # Traditional alias for #top.
+  #
+  alias peek top
+
+  #
+  # Returns the element with the lowest priority, but
+  # does not remove it from the queue.
+  #
+  def bottom
+    return nil if empty?
+    return @que.first
+  end
+
   #
   # Add more than one element at the same time. See #push.
   #

metadata

@@ -1,98 +1,149 @@
 --- !ruby/object:Gem::Specification
 name: pqueue
 version: !ruby/object:Gem::Version
-  version: 2.0.2
-  prerelease: 
+  version: 2.1.0
 platform: ruby
 authors:
+- Trans
 - K. Kodama
 - Ronald Butler
 - Olivier Renaud
 - Rick Bradley
-- Thomas Sawyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-29 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: detroit
-  requirement: &18261020 !ruby/object:Gem::Requirement
-    none: false
+  name: microtest
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18261020
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: microtest
-  requirement: &18260240 !ruby/object:Gem::Requirement
-    none: false
+  name: ae
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18260240
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: ae
-  requirement: &18259560 !ruby/object:Gem::Requirement
-    none: false
+  name: rubytest
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18259560
-description: ! 'A priority queue is like a standard queue, except that each inserted
-  elements
-
-  is given a certain priority, based on the result of the comparison block given
-
-  at instantiation time. Retrieving an element from the queue will always return
-
-  the one with the highest priority.'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubytest-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: indexer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A priority queue is like a standard queue, except that each inserted
+  elements is given a certain priority, based on the result of the comparison block
+  given at instantiation time. Retrieving an element from the queue will always return
+  the one with the highest priority.
 email:
 - transfire@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- HISTORY.rdoc
-- README.rdoc
-- COPYING.rdoc
+- License.txt
+- README.md
+- History.md
+- Contributing.md
 files:
-- .ruby
 - lib/pqueue.rb
 - test/test_pqueue.rb
-- HISTORY.rdoc
-- README.rdoc
-- COPYING.rdoc
+- License.txt
+- Gemfile.lock
+- Index.yml
+- README.md
+- History.md
+- Contributing.md
 homepage: http://rubyworks.github.com/pqueue
-licenses: []
+licenses:
+- BSD-2
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Queue of Prioritized Elements
-test_files: []
+test_files:
+- test/test_pqueue.rb
+has_rdoc: 

data/.ruby

@@ -1,58 +0,0 @@
----
-source:
-- meta
-authors:
-- name: K. Kodama
-- name: Ronald Butler
-- name: Olivier Renaud
-- name: Rick Bradley
-- name: Thomas Sawyer
-  email: transfire@gmail.com
-copyrights:
-- holder: K. Kodama
-  year: '2001'
-replacements: []
-alternatives: []
-requirements:
-- name: detroit
-  groups:
-  - build
-  development: true
-- name: microtest
-  groups:
-  - test
-  development: true
-- name: ae
-  groups:
-  - test
-  development: true
-dependencies: []
-conflicts: []
-repositories:
-- uri: git://github.com/rubyworks/pqueue.git
-  scm: git
-  name: upstream
-resources:
-  home: http://rubyworks.github.com/pqueue
-  code: http://github.com/rubyworks/pqueue
-  mail: http://groups.google.com/group/rubyworks-mailinglist
-  bugs: http://github.com/rubyworks/pqueue/issues
-extra: {}
-load_path:
-- lib
-revision: 0
-created: '2001-03-10'
-summary: Queue of Prioritized Elements
-title: PQueue
-version: 2.0.2
-name: pqueue
-description: ! 'A priority queue is like a standard queue, except that each inserted
-  elements
-
-  is given a certain priority, based on the result of the comparison block given
-
-  at instantiation time. Retrieving an element from the queue will always return
-
-  the one with the highest priority.'
-organization: rubyworks
-date: '2011-10-29'

data/COPYING.rdoc

@@ -1,31 +0,0 @@
-= COPYRIGHT NOTICES
-
-== PQueue
-
-Copyright:: (c) 2011 Rubyworks
-License:: BSD-2-Clause
-Website:: http://rubyworks.github.com/pqueue
-
-    Copyright 2011 Rubyworks. All rights reserved.
-
-    Redistribution and use in source and binary forms, with or without
-    modification, are permitted provided that the following conditions are met:
-
-       1. Redistributions of source code must retain the above copyright notice,
-          this list of conditions and the following disclaimer.
-
-       2. 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 ``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 HOLDERS 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.
-

data/README.rdoc

@@ -1,57 +0,0 @@
-= PQueue
-
-{Home}[http://rubyworks.github.com/pqueue] |
-{Code}[http://github.com/rubyworks/pqueue] |
-{Docs}[http://rubydoc.info/gems/pqueue/frames] |
-{Mail}[http://groups.google.com/group/rubyworks] | #rubyworks
-
-{<img src="http://travis-ci.org/rubyworks/pqueue.png" />}[http://travis-ci.org/rubyworks/pqueue]
-
-== DESCRIPTION
-
-Priority queue with array based heap.
-
-A priority queue is like a standard queue, except that each inserted
-elements is given a certain priority, based on the result of the
-comparison block given at instantiation time. Also, retrieving an element
-from the queue will always return the one with the highest priority
-(see #pop and #top).
-
-The default is to compare the elements in respect to their #<=> method.
-For example, Numeric elements with higher values will have higher
-priorities.
-
-This library is  a rewrite of the original PQueue.rb by K. Kodama and
-Heap.rb by Ronald Butler. The two libraries were later merged
-and generally improved by Olivier Renaud. Then the whole library 
-rewritten by Trans using the original as a functional reference.
-
-
-== SYNOPSIS
-
-  require 'pqueue'
-
-  pq = PQueue.new([2,3,1]){ |a,b| a > b }
-
-  pq.pop  #=> 3
-
-
-== ACKNOWLEDGMENTS
-
-Although the library has been completely rewritten since, we still would
-like to acknowledge the efforts of the original PQueue authors and
-contributors.
-
-* Olivier Renaud (2007)
-* Rick Bradley (2003)
-* Ronald Butler (2002)
-* K Kodama (2001, original library)
-
-
-== COPYRIGHTS
-
-Copyright (c) 2011 Rubyworks
-
-PQueue is distributable in accordance with the *FreeBSD* license.
-
-See the COPYING.rdoc file for details.