hashfunctions 1.0.0

data/.gitignore

@@ -0,0 +1,45 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# aptana
+.project
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/LICENSE.txt

@@ -0,0 +1,234 @@
+THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON 
+PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION 
+OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
+
+1. DEFINITIONS
+
+"Contribution" means:
+
+a) in the case of the initial Contributor, the initial code and 
+documentation distributed under this Agreement, and
+
+b) in the case of each subsequent Contributor:
+
+i) changes to the Program, and
+
+ii) additions to the Program;
+
+where such changes and/or additions to the Program originate from 
+and are distributed by that particular Contributor. A Contribution 
+'originates' from a Contributor if it was added to the Program by 
+such Contributor itself or anyone acting on such Contributor's 
+behalf. Contributions do not include additions to the Program which: 
+(i) are separate modules of software distributed in conjunction with 
+the Program under their own license agreement, and (ii) are not 
+derivative works of the Program.
+
+"Contributor" means any person or entity that distributes the Program.
+
+"Licensed Patents " mean patent claims licensable by a Contributor 
+which are necessarily infringed by the use or sale of its 
+Contribution alone or when combined with the Program.
+
+"Program" means the Contributions distributed in accordance with 
+this Agreement.
+
+"Recipient" means anyone who receives the Program under this 
+Agreement, including all Contributors.
+
+2. GRANT OF RIGHTS
+
+a) Subject to the terms of this Agreement, each Contributor hereby 
+grants Recipient a non-exclusive, worldwide, royalty-free copyright 
+license to reproduce, prepare derivative works of, publicly display, 
+publicly perform, distribute and sublicense the Contribution of such 
+Contributor, if any, and such derivative works, in source code and 
+object code form.
+
+b) Subject to the terms of this Agreement, each Contributor hereby 
+grants Recipient a non-exclusive, worldwide, royalty-free patent 
+license under Licensed Patents to make, use, sell, offer to sell, 
+import and otherwise transfer the Contribution of such Contributor, 
+if any, in source code and object code form. This patent license 
+shall apply to the combination of the Contribution and the Program 
+if, at the time the Contribution is added by the Contributor, such 
+addition of the Contribution causes such combination to be covered 
+by the Licensed Patents. The patent license shall not apply to any 
+other combinations which include the Contribution. No hardware per 
+se is licensed hereunder.
+
+c) Recipient understands that although each Contributor grants the 
+licenses to its Contributions set forth herein, no assurances are 
+provided by any Contributor that the Program does not infringe the 
+patent or other intellectual property rights of any other entity. 
+Each Contributor disclaims any liability to Recipient for claims 
+brought by any other entity based on infringement of intellectual 
+property rights or otherwise. As a condition to exercising the 
+rights and licenses granted hereunder, each Recipient hereby assumes 
+sole responsibility to secure any other intellectual property rights 
+needed, if any. For example, if a third party patent license is 
+required to allow Recipient to distribute the Program, it is 
+Recipient's responsibility to acquire that license before 
+distributing the Program.
+
+d) Each Contributor represents that to its knowledge it has 
+sufficient copyright rights in its Contribution, if any, to grant 
+the copyright license set forth in this Agreement.
+
+3. REQUIREMENTS
+
+A Contributor may choose to distribute the Program in object code 
+form under its own license agreement, provided that:
+
+a) it complies with the terms and conditions of this Agreement; and
+
+b) its license agreement:
+
+i) effectively disclaims on behalf of all Contributors all 
+warranties and conditions, express and implied, including warranties 
+or conditions of title and non-infringement, and implied warranties 
+or conditions of merchantability and fitness for a particular purpose;
+
+ii) effectively excludes on behalf of all Contributors all liability 
+for damages, including direct, indirect, special, incidental and 
+consequential damages, such as lost profits;
+
+iii) states that any provisions which differ from this Agreement are 
+offered by that Contributor alone and not by any other party; and
+
+iv) states that source code for the Program is available from such 
+Contributor, and informs licensees how to obtain it in a reasonable 
+manner on or through a medium customarily used for software exchange.
+
+When the Program is made available in source code form:
+
+a) it must be made available under this Agreement; and
+
+b) a copy of this Agreement must be included with each copy of the 
+Program.
+
+Contributors may not remove or alter any copyright notices contained 
+within the Program.
+
+Each Contributor must identify itself as the originator of its 
+Contribution, if any, in a manner that reasonably allows subsequent 
+Recipients to identify the originator of the Contribution.
+
+4. COMMERCIAL DISTRIBUTION
+
+Commercial distributors of software may accept certain 
+responsibilities with respect to end users, business partners and 
+the like. While this license is intended to facilitate the 
+commercial use of the Program, the Contributor who includes the 
+Program in a commercial product offering should do so in a manner 
+which does not create potential liability for other Contributors. 
+Therefore, if a Contributor includes the Program in a commercial 
+product offering, such Contributor ("Commercial Contributor") hereby 
+agrees to defend and indemnify every other Contributor ("Indemnified 
+Contributor") against any losses, damages and costs (collectively 
+"Losses") arising from claims, lawsuits and other legal actions 
+brought by a third party against the Indemnified Contributor to the 
+extent caused by the acts or omissions of such Commercial 
+Contributor in connection with its distribution of the Program in a 
+commercial product offering. The obligations in this section do not 
+apply to any claims or Losses relating to any actual or alleged 
+intellectual property infringement. In order to qualify, an 
+Indemnified Contributor must: a) promptly notify the Commercial 
+Contributor in writing of such claim, and b) allow the Commercial 
+Contributor to control, and cooperate with the Commercial 
+Contributor in, the defense and any related settlement negotiations. 
+The Indemnified Contributor may participate in any such claim at its 
+own expense.
+
+For example, a Contributor might include the Program in a commercial 
+product offering, Product X. That Contributor is then a Commercial 
+Contributor. If that Commercial Contributor then makes performance 
+claims, or offers warranties related to Product X, those performance 
+claims and warranties are such Commercial Contributor's 
+responsibility alone. Under this section, the Commercial Contributor 
+would have to defend claims against the other Contributors related 
+to those performance claims and warranties, and if a court requires 
+any other Contributor to pay any damages as a result, the Commercial 
+Contributor must pay those damages.
+
+5. NO WARRANTY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS 
+PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF 
+ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, 
+ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, 
+MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient 
+is solely responsible for determining the appropriateness of using 
+and distributing the Program and assumes all risks associated with 
+its exercise of rights under this Agreement, including but not 
+limited to the risks and costs of program errors, compliance with 
+applicable laws, damage to or loss of data, programs or equipment, 
+and unavailability or interruption of operations.
+
+6. DISCLAIMER OF LIABILITY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT 
+NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, 
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
+(INCLUDING WITHOUT LIMITATION LOST PROFITS), 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 OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS 
+GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+7. GENERAL
+
+If any provision of this Agreement is invalid or unenforceable under 
+applicable law, it shall not affect the validity or enforceability 
+of the remainder of the terms of this Agreement, and without further 
+action by the parties hereto, such provision shall be reformed to 
+the minimum extent necessary to make such provision valid and 
+enforceable.
+
+If Recipient institutes patent litigation against a Contributor with 
+respect to a patent applicable to software (including a cross-claim 
+or counterclaim in a lawsuit), then any patent licenses granted by 
+that Contributor to such Recipient under this Agreement shall 
+terminate as of the date such litigation is filed. In addition, if 
+Recipient institutes patent litigation against any entity (including 
+a cross-claim or counterclaim in a lawsuit) alleging that the 
+Program itself (excluding combinations of the Program with other 
+software or hardware) infringes such Recipient's patent(s), then 
+such Recipient's rights granted under Section 2(b) shall terminate 
+as of the date such litigation is filed.
+
+All Recipient's rights under this Agreement shall terminate if it 
+fails to comply with any of the material terms or conditions of this 
+Agreement and does not cure such failure in a reasonable period of 
+time after becoming aware of such noncompliance. If all Recipient's 
+rights under this Agreement terminate, Recipient agrees to cease use 
+and distribution of the Program as soon as reasonably practicable. 
+However, Recipient's obligations under this Agreement and any 
+licenses granted by Recipient relating to the Program shall continue 
+and survive.
+
+Everyone is permitted to copy and distribute copies of this 
+Agreement, but in order to avoid inconsistency the Agreement is 
+copyrighted and may only be modified in the following manner. The 
+Agreement Steward reserves the right to publish new versions 
+(including revisions) of this Agreement from time to time. No one 
+other than the Agreement Steward has the right to modify this 
+Agreement. IBM is the initial Agreement Steward. IBM may assign the 
+responsibility to serve as the Agreement Steward to a suitable 
+separate entity. Each new version of the Agreement will be given a 
+distinguishing version number. The Program (including Contributions) 
+may always be distributed subject to the version of the Agreement 
+under which it was received. In addition, after a new version of the 
+Agreement is published, Contributor may elect to distribute the 
+Program (including its Contributions) under the new version. Except 
+as expressly stated in Sections 2(a) and 2(b) above, Recipient 
+receives no rights or licenses to the intellectual property of any 
+Contributor under this Agreement, whether expressly, by implication, 
+estoppel or otherwise. All rights in the Program not expressly 
+granted under this Agreement are reserved.
+
+This Agreement is governed by the laws of the State of New York and 
+the intellectual property laws of the United States of America. No 
+party to this Agreement will bring a legal action under this 
+Agreement more than one year after the cause of action arose. Each 
+party waives its rights to a jury trial in any resulting litigation.

data/README.md

@@ -0,0 +1,29 @@
+General Purpose Hash Functions Gem
+==================================
+
+**hashfunctions** is a [Ruby][1] gem which implements 
+11 fast hash functions for general purpose non-cryptographic use 
+implemented originally by [Arash Partow][2]. Part of this library is 
+the native C [**hashfunctions-extension**][3] extension which is used
+if it's installed as gem.
+
+Some example:
+
+    require "general-hash-functions"
+    hash = GeneralHashFunctions::djbhash("some string")
+    # will return the 395673328
+    
+See description of all contained functions at Arash Partow's page:
+http://www.partow.net/programming/hashfunctions/index.html#AvailableHashFunctions
+
+
+Copyright
+---------
+
+Copyright © 2002 [Arash Partow][2]. Copyright © 2012 
+[Martin Kozák][4]. See `LICENSE.txt` for further details.
+
+[1]: http://www.ruby-lang.org/en/
+[2]: http://www.partow.net/
+[3]: http://github.com/martinkozak/hashfunctions-extension
+[4]: http://www.martinkozak.net/

data/Rakefile

@@ -0,0 +1,22 @@
+# encoding: utf-8
+require 'rubygems'
+require 'rake'
+require 'rake/extensiontask'
+
+spec = Gem::Specification.new do |s|
+  s.name = "hashfunctions"
+  s.email = "martinkozak@martinkozak.net"
+  s.author = "Martin Kozák"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "11 fast hash functions for general purpose non-cryptographic use."
+  s.description = "11 fast hash functions for general purpose non-cryptographic use implemented originally by Arash Partow. Uses the C extension if appropriate gem is available."
+  s.homepage = "http://github.com/martinkozak/hashfunctions"
+  s.license = "CPL"
+  s.version = "1.0.0"
+  s.files = `git ls-files`.split("\n")
+  s.add_development_dependency("rake", ">= 0")
+  s.add_development_dependency("rake-compiler", ">= 0")
+end
+
+Gem::PackageTask.new(spec) do |pkg|
+end

data/lib/general-hash-functions.rb

@@ -0,0 +1,127 @@
+#
+#**************************************************************************
+#*                                                                        *
+#*          General Purpose Hash Function Algorithms Library              *
+#*                                                                        *
+#* Author: Arash Partow - 2002                                            *
+#* URL: http://www.partow.net                                             *
+#* URL: http://www.partow.net/programming/hashfunctions/index.html        *
+#*                                                                        *
+#* Copyright notice:                                                      *
+#* Free use of the General Purpose Hash Function Algorithms Library is    *
+#* permitted under the guidelines and in accordance with the most current *
+#* version of the Common Public License.                                  *
+#* http://www.opensource.org/licenses/cpl1.0.php                          *
+#*                                                                        *
+#**************************************************************************
+#
+
+module GeneralHashFunctionsPure
+
+  def self.rshash( str )
+    a    = 63689
+    b    = 378551
+    hash = 0
+    str.each_byte{ |i| 
+      hash = (hash * a + i) & 0xffffffff
+      a = (a * b) & 0xffffffff
+    }
+    return hash
+  end
+
+
+  def self.jshash( str )
+    hash = 1315423911
+    str.each_byte{ |i| 
+      hash ^= ( ( hash << 5 ) + i + ( hash >> 2 ) ) & 0xffffffff
+    }
+    return hash
+  end
+
+
+  def self.elfhash( str )
+    hash = 0
+    x = 0
+    str.each_byte{ |i|
+      hash = (hash << 4) + i
+      if  (x = hash & 0xF0000000) != 0
+        hash ^= (x >> 24)
+        hash &= ~x
+      end
+      hash &= 0xffffffff
+    }
+    return hash
+  end
+
+
+  def self.bkdrhash( str )
+    seed = 131    # 31 131 1313 13131 131313 etc..
+    hash = 0
+    str.each_byte{ |i|
+      hash = (( hash * seed ) + i) & 0xffffffff
+    }
+    return hash
+  end
+
+
+  def self.sdbmhash( str )
+    hash = 0
+    str.each_byte{ |i|
+      hash = (i + ( hash << 6 ) + ( hash << 16 ) - hash) & 0xffffffff
+    }
+    return hash
+  end
+
+
+  def self.djbhash( str )
+    hash = 5381
+    str.each_byte{ |i|
+      hash = (((hash << 5) + hash) + i) & 0xffffffff
+    }
+    return hash
+  end
+
+
+  def self.dekhash( str )
+    hash = str.length
+    str.each_byte{ |i|
+      hash = (((hash << 5) ^ (hash >> 27)) ^ i) & 0xffffffff
+    }
+    return hash
+  end
+
+
+  def self.bphash( str )
+    hash = 0
+    str.each_byte{ |i|
+      hash = (hash << 7 ^ i) & 0xffffffff
+    }
+    return hash
+  end
+
+
+  def self.fnvhash( str )
+    fnv_prime = 0x811C9DC5
+    hash = 0
+    str.each_byte{ |i|
+      hash *= fnv_prime
+      hash ^= i
+      hash &= 0xffffffff
+    }
+    return hash
+  end
+
+
+  def self.aphash( str )
+    raise NotImplementedError::new("Arash Partow's hash is provided by C extension only.")
+  end
+  
+end
+
+
+begin
+    require "general-hash-functions/extension"
+    GeneralHashFunctions = GeneralHashFunctionsExt
+rescue LoadError
+    GeneralHashFunctions = GeneralHashFunctionsPure
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: hashfunctions
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Martin Kozák
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &9094440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *9094440
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: &9091240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *9091240
+description: 11 fast hash functions for general purpose non-cryptographic use implemented
+  originally by Arash Partow. Uses the C extension if appropriate gem is available.
+email: martinkozak@martinkozak.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/general-hash-functions.rb
+homepage: http://github.com/martinkozak/hashfunctions
+licenses:
+- CPL
+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.15
+signing_key: 
+specification_version: 3
+summary: 11 fast hash functions for general purpose non-cryptographic use.
+test_files: []