nprime v0.2.1

Nprime

Nprime, a simple and fast naive module for testing/calculating primes on the fly.

Install

$ npm install nprime [-g]

require:

var Nprime  = require( 'nprime' );

Run Tests

to run all test files, install devDependecies:

 $ cd nprime/
 # install or update devDependecies
 $ npm install --dev
 # run tests
 $ npm test

to execute a single test file simply do:

 $ node test/file-name.js

Run Benchmarks

run benchmark (find the first million of primes):

 $ cd nprime/
 $ npm run bench
 # or to run a single file
 $ node bench/file-name-bench.js

Methods

Arguments within are optional.

/*
 * Check if the number is composite.
 * It returns the value of first divisor,
 * or -1 if number is a prime.
 */
Nprime#test : function () : Number

/*
 * Get the next prime p >= n, use strict for >.
 */
Nprime#next : function ( Number n [, Boolean strict ] ) : Number

/*
 * Get the previous prime p <= n, use strict for <.
 */
Nprime#prev : function ( Number n [, Boolean strict ] ) : Number

MIT License

Copyright (c) 2014-present < Guglielmo Ferri : 44gatti@gmail.com >

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.