perlin 0.1.0pre1 → 0.1.0

data/README.md

@@ -1,14 +1,36 @@
 Perlin
 ======
 
-A Perlin noise implementation based off
-<http://freespace.virgin.net/hugo.elias/models/m_perlin.htm>. Implemented as a Ruby C extension, it is considerably faster than the pure Ruby equivalent, [perlin_noise](https://github.com/junegunn/perlin_noise).
+A fast Perlin/Simplex noise generator.
+Implemented as a Ruby C extension, it is considerably faster than the pure Ruby equivalent, [perlin_noise](https://github.com/junegunn/perlin_noise).
 
-- Written by Brian 'bojo' Jones <mojobojo@gmail.com>
-- Optimizations thanks to Camille Goudeseune, Univ of Illinois, <cog@illinois.edu>
+By default, the noise generated uses Perlin's Simplex functions, but can produce "Classic" Perlin noise
+(not recommended, since it is significantly slower).
+
+If a large number of noise values are required, requesting chunks of values can be faster, which can then be iterated
+through at leisure (or use the block version of #chunk).
+
+- [Benchmarks](https://github.com/Spooner/ruby-perlin/blob/master/bench/benchmarks.txt)
+
+CREDITS
+-------
+
+- Written by Brian 'bojo' Jones (mojobojo@gmail.com)
+- Optimizations thanks to Camille Goudeseune, Univ of Illinois, (cog@illinois.edu)
 - Made into gem and extended by Bil Bas (bil.bagpuss@gmail.com)
 
 - [Simplex noise functions copyright (c) 2007-2012 Eliot Eshelman](http://www.6by9.net/b/2012/02/03/simplex-noise-for-c-and-python)
+- "Classic" noise functions based on http://freespace.virgin.net/hugo.elias/models/m_perlin.htm
+
+USE CASES
+---------
+
+One use for this gem would be to generate "randomness" for games, such as building levels for a rogue-alike game.
+
+If generating textures, it is advised to use a Simplex noise shader instead of this gem, since shaders are considerably
+faster than setting pixels, for example by using TexPlay. The issue is not so much that generating the noise is faster,
+but that setting individual pixel colours from Ruby is very slow. However, if graphics shaders are not available, then
+this could be used, but would be painfully slow for anything but tiny images.
 
 INSTALL
 -------
@@ -21,13 +43,28 @@ USAGE
     require 'perlin'
 
     # Takes values seed, persistence, and octaves
-    noise = Perlin::Generator.new 123, 1.0, 1
+    gen = Perlin::Generator.new 123, 1.0, 1
 
-    # Returns a 'height' value for (x, y)
-    puts noise[10, 20]  #=> 0.9004574418067932
+    # Returns a 'height' value for 2 or 3-dimensional noise.
+    gen[10, 20]        #=> 0.0011919947855197324
+    gen[5, 22.2, 99.8] #=> 0.692631933498385
 
     # Returns a 2D array of 'heights' for a range (x, y, size_x, size_y, interval)
-    arr = noise.chunk 1, 1, 2, 3, 1
+    noise = gen.chunk 1, 1, 2, 3, 1
+
+    noise[1][2] #=> 0.28406014362476045
+    p noise     #= > [[-0.9227624778765608, -0.0016387049134645594, -0.4764434188330739],
+                #     [0.24490384926510073, -0.4764434188330739, 0.28406014362476045]]
+
+
+    # Returns a 3D array of 'heights' for a range (x, y, size_x, size_y, interval)
+    noise = gen.chunk 0, 0, 0, 2, 3, 4, 0.5
+    noise.size       #=> 2
+    noise[0].size    #=> 3
+    noise[0][0].size #=> 4
+    noise[1][2][3]   #=>  -0.1585322813268602
+
+    # Can run in "Classic" Perlin mode (Not recommended - SLOW!)
 
-    p arr  #= > [[0.05753844603896141, -0.2208995521068573, 0.3973901569843292],
-           #    [0.1383310854434967, -0.22248442471027374, 0.15600799024105072]]
+    gen.classic = true
+    gen[10, 20]        #=> -0.19936732947826385

data/Rakefile

@@ -11,38 +11,9 @@ begin
 rescue LoadError
 end
 
-require File.expand_path('../lib/perlin/version', __FILE__)
-
 CLOBBER << "coverage"
 
-# somewhere in your Rakefile, define your gem spec
-spec = Gem::Specification.new do |s|
-  s.name = 'perlin'
-  s.version = Perlin::VERSION
-  s.date = Time.now.strftime '%Y-%m-%d'
-  s.authors = ["Brian 'bojo' Jones", 'Camille Goudeseune', 'Bil Bas']
-
-  s.summary = 'Perlin Noise C extension'
-  s.description = <<-END
-#{s.summary}
-
-A Perlin/Simplex noise implementation based of
-<http://freespace.virgin.net/hugo.elias/models/m_perlin.htm>. Implemented as a Ruby C extension.
-  END
-
-  s.email = %w<mojobojo@gmail.com>
-  s.files = Dir.glob %w<CHANGELOG LICENSE Rakefile README.md lib/**/*.* lib ext/**/*.* examples/**/*.*>
-  s.homepage = 'https://github.com/boj/ruby-perlin'
-  s.licenses = %w<MIT>
-  s.extensions << 'ext/perlin/extconf.rb'
-  s.rubyforge_project = 'ruby-perlin'
-  s.test_files = []
-  s.has_rdoc = 'yard'
-
-  s.add_development_dependency 'rake-compile', '~> 0.8.1'
-  s.add_development_dependency 'simplecov', '~> 0.6.4'
-  s.add_development_dependency 'launchy', '~> 2.1.0'
-end
+spec = Gem::Specification.load Dir["*.gemspec"][0]
 
 Gem::PackageTask.new spec do
 end

data/ext/perlin/extconf.rb

@@ -9,7 +9,9 @@ dir_config(extension_name)
 $CFLAGS += ' -DRUBY_19' if RUBY_VERSION =~ /^1.9/
 
 # let's use c99
-#$CFLAGS += " -std=c99"
 $CFLAGS += " -std=gnu99"
 
+# Avoid warnings since we are using C99, not C90!
+$warnflags.gsub!('-Wdeclaration-after-statement', '') if $warnflags
+
 create_makefile(extension_name)

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: perlin
 version: !ruby/object:Gem::Version
-  version: 0.1.0pre1
-  prerelease: 5
+  version: 0.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Brian 'bojo' Jones
@@ -11,10 +11,58 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-07 00:00:00.000000000 Z
+date: 2012-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake-compile
+  name: RedCloth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.9
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -81,19 +129,15 @@ files:
 - LICENSE
 - Rakefile
 - README.md
-- lib/perlin/1.9/perlin.so
-- lib/perlin/generator.rb
-- lib/perlin/version.rb
-- lib/perlin.rb
 - ext/perlin/classic.c
-- ext/perlin/classic.h
-- ext/perlin/extconf.rb
 - ext/perlin/generator.c
-- ext/perlin/generator.h
 - ext/perlin/perlin.c
-- ext/perlin/perlin.h
 - ext/perlin/simplex.c
+- ext/perlin/classic.h
+- ext/perlin/generator.h
+- ext/perlin/perlin.h
 - ext/perlin/simplex.h
+- ext/perlin/extconf.rb
 - examples/chunk_in_2d.rb
 - examples/chunk_in_3d.rb
 - examples/index_in_2d.rb
@@ -113,15 +157,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 176652013
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
+      segments:
+      - 0
+      hash: 176652013
 requirements: []
 rubyforge_project: ruby-perlin
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Perlin Noise C extension

data/lib/perlin.rb

@@ -1,13 +0,0 @@
-require 'perlin/version'
-
-begin
-  RUBY_VERSION =~ /(\d+.\d+)/
-  require "perlin/#{$1}/perlin.so"
-rescue LoadError
-  require "perlin/perlin.so"
-end
-
-require 'perlin/generator'
-
-module Perlin
-end

data/lib/perlin/generator.rb

@@ -1,161 +0,0 @@
-module Perlin
-  # Perlin noise generator.
-  #
-  # @!attribute [rw] seed
-  #   @return [Integer]
-  #
-  # @!attribute [r] persistence
-  #   @return [Float]
-  #
-  # @!attribute [r] octave
-  #   @return [Integer]
-  class Generator
-    attr_reader :seed, :octave, :persistence
-    def classic?; @classic; end
-
-    # @!method initialize(seed, persistence, octave)
-    #   Create a noise generator.
-    #
-    #   Using the same seed will always produce the same pattern. Animate a perlin 'texture' by altering the seed based on time.
-    #
-    #   @param seed [Integer] Seed value to create a different pattern.
-    #   @param persistence [Float] Used to generate different frequencies/amplitudes of output.
-    #   @param octave [Integer] Number of iterations to run (higher number of octaves takes more time)
-    #   @option options :classic [Boolean] (false) Whether to use the slower Classic algorithm, rather than default (and much faster) Simplex.
-    def initialize(seed, persistence, octave, options = {})
-      options = {
-          :classic => false,
-      }.merge! options
-
-      initialize_(seed, persistence, octave, options[:classic])
-    end
-    protected :initialize_ # Underlying C implementation.
-
-    # @overload chunk(x, y, steps_x, steps_y, interval)
-    #   Calculates a rectangular section of height (n) values and returns them as a 2D array.
-    #
-    #   This is much faster than accessing each point separately using {#[]}
-    #
-    #   @example
-    #     noise = Perlin::Generator.new 123, 1.0, 1
-    #     arr = noise.chunk 1, 1, 2, 3, 1.5
-    #
-    #     # access position 1, 2 (remember that arr is offset by the x, y value of the chunk)
-    #     puts arr[0, 1] #=> -0.2208995521068573
-    #
-    #     p arr  #= > [[0.05753844603896141, -0.2208995521068573, 0.3973901569843292], [0.1383310854434967, -0.22248442471027374, 0.15600799024105072]]
-    #
-    #   @param x [Float]
-    #   @param y [Float]
-    #   @param steps_x [Integer]
-    #   @param steps_y [Integer]
-    #   @param interval [Float]
-    #
-    #   @return [Array<Array<Float>>] height (n) values within the rectangle.
-    #
-    # @overload chunk(x, y, steps_x, steps_y, interval) {|h, x, y| }
-    #   Calculates a rectangular section of height (n) values and returns them as a 2D array.
-    #
-    #   This is much faster than accessing each point separately using {#[]}
-    #
-    #   @example
-    #     noise = Perlin::Generator.new 123, 0.5, 3
-    #     noise.chunk 1.0, 2.3, 3, 2, 1.5 do |h, x, y|
-    #       # Use the height value, which is at x, y.
-    #     end
-    #
-    #   @param x [Float]
-    #   @param y [Float]
-    #   @param steps_x [Integer]
-    #   @param steps_y [Integer]
-    #   @param interval [Float]
-    #
-    #   @yieldparam h [Float] Height at x, y
-    #   @yieldparam x [Float]
-    #   @yieldparam y [Float]
-    #
-    #   @return [nil]
-    #
-    # @overload chunk(x, y, z, size_x, size_y, size_z, interval)
-    #   Calculates a rectangular section of height (n) values and returns them as a 3D array.
-    #
-    #   This is much faster than accessing each point separately using {#[]}
-    #
-    #   @example
-    #     noise = Perlin::Generator.new 123, 0.5, 5
-    #     arr = noise.chunk 6.0, 5.0, 4.0, 3, 2, 1, 1.5
-    #
-    #     # access position 2, 1, 0 (remember that arr is offset by the x, y and z value of the chunk)
-    #     puts arr[2, 1, 0] #=>
-    #
-    #     p arr  #= >
-    #
-    #   @param x [Float]
-    #   @param y [Float]
-    #   @param z [Float]
-    #   @param steps_x [Integer]
-    #   @param steps_y [Integer]
-    #   @param steps_z [Integer]
-    #   @param interval [Float]
-    #
-    #   @return [Array<Array<Float>>] height (n) values within the rectangle.
-    #
-    # @overload chunk(x, y, z, size_x, size_y, size_z, interval) {|h, x, y| }
-    #   Calculates a rectangular section of height (n) values and returns them as a 3D array.
-    #
-    #   This is much faster than accessing each point separately using {#[]}
-    #
-    #   @example
-    #     noise = Perlin::Generator.new 123, 0.8, 3
-    #     noise.chunk 6.0, 5.0, 4.0, 3, 2, 1, 1.5 do |h, x, y, z|
-    #       # Use the height value, which is at x, y, z.
-    #     end
-    #
-    #   @param x [Float]
-    #   @param y [Float]
-    #   @param z [Float]
-    #   @param steps_x [Integer]
-    #   @param steps_y [Integer]
-    #   @param steps_z [Integer]
-    #   @param interval [Float]
-    #
-    #   @yieldparam h [Float] Height at x, y, z
-    #   @yieldparam x [Float]
-    #   @yieldparam y [Float]
-    #   @yieldparam z [Float]
-    #
-    #   @return [nil]
-
-    # Gets height (n) at a point in 2D or 3D space.
-    #
-    # This is much slower, if accessing many points, than using {#chunk}
-    #
-    # @overload [](x, y)
-    #   Gets height (n) value at a specific 2D position.
-    #
-    #   @example
-    #     noise = Perlin::Generator.new 123, 1.0, 1
-    #
-    #     # Returns a 'height' value for (x, y)
-    #     puts noise[10, 20]  #=> 0.9004574418067932
-    #
-    #   @param x [Float]
-    #   @param y [Float]
-    #   @return [Float] height (n) value at the position
-    #
-    # @overload [](x, y, z)
-    #   Gets height (n) value at a specific 3D position.
-    #
-    #   @example
-    #     noise = Perlin::Generator.new 123, 1.0, 1
-    #
-    #     # Returns a 'height' value for (x, y, z)
-    #     puts noise[10, 20, 30]  #=> 0.017745036631822586
-    #
-    #   @param x [Float]
-    #   @param y [Float]
-    #   @param z [Float]
-    #   @return [Float]  height (n) value at the position
-    alias_method :run, :[]
-  end
-end

data/lib/perlin/version.rb

@@ -1,5 +0,0 @@
-# Perlin noise generation.
-module Perlin
-  # Current version of the gem.
-  VERSION = "0.1.0pre1"
-end