src/number.js

Method odd

Parameters:

  • arg must be a Number.
    (Number to compare)

Returns a Number
(The absolute difference)

diff : function ( num1, num2 ) { if ( isNaN( num1 ) || isNaN( num2 ) ) { throw new Error( label.error.expectedNumber ); } return Math.abs( num1 - num2 ); },

Method even

Tests if an number is even

Parameters:

  • arg must be a Number.
    (Number to test)

Returns a Boolean
(True if even, or undefined)

even : function ( arg ) { return arg % 2 === 0; },

Method format

Formats a Number to a delimited String

Parameters:

  • arg must be a Number.
    (Number to format)

  • delimiter must be a String.
    ([Optional] String to delimit the Number with)

  • every must be a String.
    ([Optional] Position to insert the delimiter, default is 3)

Returns a String
(Number represented as a comma delimited String)

format : function ( arg, delimiter, every ) { if ( isNaN( arg ) ) { throw new Error( label.error.expectedNumber ); } arg = arg.toString(); delimiter = delimiter || ","; every = every || 3; var d = arg.indexOf( "." ) > -1 ? "." + arg.replace( regex.number_format_1, "" ) : "", a = arg.replace( regex.number_format_2, "" ).split( "" ).reverse(), p = Math.floor( a.length / every ), i = 1, n, b; for ( b = 0; b < p; b++ ) { n = i === 1 ? every : ( every * i ) + ( i === 2 ? 1 : ( i - 1 ) ); a.splice( n, 0, delimiter ); i++; } a = a.reverse().join( "" ); if ( a.charAt( 0 ) === delimiter ) { a = a.substring( 1 ); } return a + d; },

Method half

Returns half of a, or true if a is half of b

Parameters:

  • a must be a Number.
    (Number to divide)

  • b must be a Number.
    ([Optional] Number to test a against)

Returns a Mixed
(Boolean if b is passed, Number if b is undefined)

half : function ( a, b ) { return b !== undefined ? ( ( a / b ) === 0.5 ) : ( a / 2 ); },

Public method odd

Tests if a number is odd

Parameters:

  • arg must be a Number.
    (Number to test)

Returns a Boolean
(True if odd, or undefined)

odd : function ( arg ) { return !number.even( arg ); },

Method parse

Parses the number

Parameters:

  • arg can be of any type.
    (Number to parse)

  • base must be a Number.
    (Integer representing the base or radix)

Returns a Number
(Integer or float)

parse : function ( arg, base ) { return ( base === undefined ) ? parseFloat( arg ) : parseInt( arg, base ); },

Method random

Generates a random number between 0 and arg

Parameters:

  • arg must be a Number.
    (Ceiling for random number, default is 100)

Returns a Number
(Random number)

random : function ( arg ) { arg = arg || 100; return Math.floor( Math.random() * ( arg + 1 ) ); },

Method round

Rounds a number up or down

Parameters:

  • arg must be a Number.
    (Number to round)

  • direction must be a String.
    ([Optional] "up" or "down")

Returns a Number
(Rounded interger)

round : function ( arg, direction ) { arg = number.parse( arg ); if ( direction === undefined || string.isEmpty( direction ) ) { return number.parse( arg.toFixed( 0 ) ); } else if ( regex.down.test( direction ) ) { return ~~( arg ); } else { return Math.ceil( arg ); } } };