simplify interface

.eslintrc.js

@@ -12,7 +12,8 @@ module.exports = {
     "rules": {
         "indent": [
             "error",
-            2
+            2,
+            { "SwitchCase": 1 }
         ],
         "linebreak-style": [
             "error",

.gitignore

@@ -1 +1,2 @@
 node_modules
+shrinkwrap.yaml

README.md

@@ -11,36 +11,21 @@ simplex-noise.js is a fast simplex noise implementation in Javascript. It works
 
 ## Usage
 
-By default simplex-noise.js will use Math.random() to seed the noise.
 ```javascript
 // initializing a new simplex instance
 // do this only once as it is relatively expensive
-var simplex = new SimplexNoise(),
-    value2d = simplex.noise2D(x, y),
-    value3d = simplex.noise3D(x, y, z),
-    value4d = simplex.noise4D(x, y, z, w);
+var noise = simplex(Math.random),
+    value2d = noise(x, y),
+    value3d = noise(x, y, z),
+    value4d = noise(x, y, z, w);
 ```
 
-You can also pass in a seed string which will then be used to initialize
-the noise using the built in alea PRNG.
-```javascript
-var simplex = new SimplexNoise('seed'),
-    value2d = simplex.noise2D(x, y),
-    sameSeed = new SimplexNoise('seed'),
-    differentSeed = new SimplexNoise('different seed');
-
-sameSeed.noise2D(x, y) === value2d
-differentSeed.noise2D(x, y) !== value2d
-```
-
-You can also pass an alternative random function to the constructor that is
-used to build the permutation table.
-This can be used with a custom pseudo random number generator:
+You can also pass an alternative random function to the function that is used to build the permutation table. This can be used with a custom pseudo random number generator:
 
 ```javascript
 var random = new Alea(seed),
-    simplex = new SimplexNoise(random),
-    value2d = simplex.noise2D(x, y);
+    noise = simplex(random),
+    value = noise(x, y);
 ```
 
 The ALEA PRNG can be found on in the npm package [alea](https://npmjs.org/package/alea).
@@ -50,9 +35,9 @@ The ALEA PRNG can be found on in the npm package [alea](https://npmjs.org/packag
 Node.js is also supported, you can install the package using [npm](https://npmjs.org/package/simplex-noise).
 
 ```javascript
-var SimplexNoise = require('simplex-noise'),
-    simplex = new SimplexNoise(Math.random),
-    value2d = simplex.noise2D(x, y);
+var simplex = require('simplex-noise'),
+    noise = simplex(Math.random),
+    value = noise(x, y);
 ```
 
 ## Benchmarks
@@ -73,6 +58,10 @@ npm install && npm test
 
 ## Changelog
 
+### 3.0.0
+- Changed function signature to `simplex(random)(x[, y, z, w]) -> noise`
+- Added support for 1D noise
+
 ### 2.4.0
 - Included a PRNG based on ALEA to directly allow seeding
 - Included typescript definitions

package.json

@@ -1,6 +1,6 @@
 {
   "name": "simplex-noise",
-  "version": "2.4.0",
+  "version": "3.0.0",
   "description": "simplex-noise is a fast simplex noise implementation in Javascript. Works in node and in the browser.",
   "homepage": "https://github.com/jwagner/simplex-noise.js",
   "author": "Jonas Wagner <[email protected]> (http://29a.ch/)",

perf/benchmark.js

@@ -1,25 +1,27 @@
 var Benchmark = this.Benchmark || require('benchmark');
-var SimplexNoise = this.SimplexNoise || require('../simplex-noise');
-var simplex = new SimplexNoise();
+var simplex = this.simplex || require('../simplex-noise');
 
 var suite = new Benchmark.Suite('simplex-noise')
   .add('init', function() {
-    var simplex = new SimplexNoise();
+    var noise = simplex(Math.random);
+  })
+  .add('noise1D', function() {
+    for (var x = 0; x < 8; x++) {
+      noise(x / 8);
+    }
   })
   .add('noise2D', function() {
     for (var x = 0; x < 8; x++) {
       for (var y = 0; y < 8; y++) {
-        for (var z = 0; z < 8; z++) {
-          simplex.noise2D(x / 8, y / 8);
-        }
+        noise(x / 8, y / 8);
       }
     }
   })
   .add('noise3D', function() {
     for (var x = 0; x < 8; x++) {
       for (var y = 0; y < 8; y++) {
         for (var z = 0; z < 8; z++) {
-          simplex.noise3D(x / 8, y / 8, z / 8);
+          noise(x / 8, y / 8, z / 8);
         }
       }
     }
@@ -28,7 +30,7 @@ var suite = new Benchmark.Suite('simplex-noise')
     for (var x = 0; x < 8; x++) {
       for (var y = 0; y < 8; y++) {
         for (var z = 0; z < 8; z++) {
-          simplex.noise3D(x / 8, y / 8, z / 8);
+          noise(x / 8, y / 8, z / 8);
         }
       }
     }
@@ -37,7 +39,7 @@ var suite = new Benchmark.Suite('simplex-noise')
     for (var x = 0; x < 8; x++) {
       for (var y = 0; y < 8; y++) {
         for (var z = 0; z < 8; z++) {
-          simplex.noise4D(x / 8, y / 8, z / 8, (x + y) / 16);
+          noise(x / 8, y / 8, z / 8, (x + y) / 16);
         }
       }
     }