Class: Integer

Integer

new Integer()

Integer
Source:
  • integer.js, line 26

Methods

<static> any(a) → {Integer}

Converts anything to Integer.
Parameters:
Name Type Description
a Object
Source:
  • integer.js, line 199
Returns:
Type
Integer
Example
  Integer.any(0);         // 0
  Integer.any(1234567);   // 1234567
  Integer.any(-12.34567); // -12
  Integer.any("37");      // 37

<static> factorial(n) → {Integer}

Parameters:
Name Type Description
n number
Source:
  • integer.js, line 326
Returns:
Type
Integer
Example
  Integer.factorial(3); // 1*2*3 = 6

<static> num(n) → {Integer}

Converts integer to Integer.
Parameters:
Name Type Description
n number
Source:
  • integer.js, line 90
Returns:
Type
Integer
Example
  Integer.num(0);       // 0
  Integer.num(1234567); // 1234567
  Integer.num(-37);     // -37

<static> one() → {Integer}

1
Source:
  • integer.js, line 74
Returns:
1
Type
Integer

<static> random(a) → {Integer}

Random.
Parameters:
Name Type Description
a number Length
Source:
  • integer.js, line 252
Returns:
Type
Integer

<static> str(str, base) → {Integer}

Converts string to Integer.
Parameters:
Name Type Argument Default Description
str string For example '-9' or 'FF' etc.
base number <optional>
 10 2, 8, 10 or 16
Source:
  • integer.js, line 130
Returns:
Type
Integer
Example
  Integer.str('77');     // 77
  Integer.str('ff', 16); // 255
  Integer.str('111', 2); // 7

<static> zero() → {Integer}

0
Source:
  • integer.js, line 82
Returns:
0
Type
Integer

abs() → {Integer}

Absolute Integer.
Source:
  • integer.js, line 1360
Returns:
|this|
Type
Integer

add(b) → {Integer}

Addition.
Parameters:
Name Type Description
b Integer
Source:
  • integer.js, line 962
Returns:
this + b
Type
Integer

addAbs(b, sign) → {Integer}

Add absolute values of Integer.
Parameters:
Name Type Description
b Integer
sign boolean
Source:
  • integer.js, line 876
Returns:
|this| + |b| (sign == true) -(|this| + |b|) (else)
Type
Integer

addzero(b) → {Integer}

Add zeros and shift decimal.
Parameters:
Name Type Description
b number Number of zeros.
Source:
  • integer.js, line 626
Returns:
this * 10n
Type
Integer

clone() → {Integer}

Copy Integer.
Source:
  • integer.js, line 606
Returns:
Type
Integer

cmp(b) → {number}

Compare between two Integer.
Parameters:
Name Type Description
b Integer
Source:
  • integer.js, line 1276
Returns:
-1 (this < b) 0 (this = b) 1 (this > b)
Type
number

cmpAbs(b) → {number}

Compare between two absolute values of Integer objects.
Parameters:
Name Type Description
b Integer
Source:
  • integer.js, line 1250
Returns:
-1 (|this| < |b|) 0 (|this| = |b|) 1 (|this| > |b|)
Type
number

div(b) → {Integer}

Division.
Parameters:
Name Type Description
b Integer
Source:
  • integer.js, line 1190
Returns:
this / b
Type
Integer

divmod(b, modulus) → {Integer}

Division or Mod.
Parameters:
Name Type Description
b Integer
modulus boolean If true then mod, else div.
Source:
  • integer.js, line 1036
Throws:
zero division
Type
Error
Returns:
this % b (modulus == true) this / b (else)
Type
Integer

eq(b) → {boolean}

==
Parameters:
Name Type Description
b Integer
Source:
  • integer.js, line 1306
Returns:
Type
boolean

equal(b) → {boolean}

===
Parameters:
Name Type Description
b Integer
Source:
  • integer.js, line 1330
Returns:
Type
boolean

gcd(b) → {Integer}

Greatest Common Divisor.
Parameters:
Name Type Description
b Integer
Source:
  • integer.js, line 819
Returns:
Type
Integer

gcdBin(b) → {Integer}

Greatest Common Divisor.
Parameters:
Name Type Description
b Integer
Source:
  • integer.js, line 837
Returns:
Type
Integer

getCapacity() → {number}

Source:
  • integer.js, line 588
Returns:
Type
number

getDigits() → {number[]}

Source:
  • integer.js, line 582
Returns:
Type
number[]

getLength() → {number}

Source:
  • integer.js, line 594
Returns:
Type
number

getSign() → {boolean}

Source:
  • integer.js, line 600
Returns:
Type
boolean

isEven() → {boolean}

Source:
  • integer.js, line 713
Returns:
Type
boolean

isNonZero() → {boolean}

Source:
  • integer.js, line 719
Returns:
Type
boolean

isOdd() → {boolean}

Source:
  • integer.js, line 707
Returns:
Type
boolean

leftShift(b) → {Integer}

<<
Parameters:
Name Type Description
b number
Source:
  • integer.js, line 645
Returns:
Type
Integer

mod(b) → {Integer}

Modulo.
Parameters:
Name Type Description
b Integer
Source:
  • integer.js, line 1200
Returns:
this % b
Type
Integer

mul(b) → {Integer}

Multiplication.
Parameters:
Name Type Description
b Integer
Source:
  • integer.js, line 998
Returns:
this * b
Type
Integer

neg() → {Integer}

Negate Integer.
Source:
  • integer.js, line 1371
Returns:
-this
Type
Integer

pow(b) → {Integer|number}

Pow.
Parameters:
Name Type Description
b number
Source:
  • integer.js, line 794
Returns:
thisb
Type
Integer | number

rightShift(b) → {Integer}

>>
Parameters:
Name Type Description
b number
Source:
  • integer.js, line 678
Returns:
Type
Integer

sqrt() → {Integer}

Square root.
Source:
  • integer.js, line 769
Returns:
√this
Type
Integer

square() → {Integer}

Fast squaring.
Source:
  • integer.js, line 725
Returns:
this * this
Type
Integer

sub(b) → {Integer}

Subtraction.
Parameters:
Name Type Description
b Integer
Source:
  • integer.js, line 980
Returns:
this - b
Type
Integer

subAbs(b, sign) → {Integer}

Subtract absolute values of Integer.
Parameters:
Name Type Description
b Integer
sign boolean
Source:
  • integer.js, line 918
Returns:
||this| - |b|| (sign == true) -||this| - |b|| (else)
Type
Integer

toString(b) → {string}

Convert Integer to String.
Parameters:
Name Type Argument Default Description
b number <optional>
 10 Base 2, 8, 10 or 16
Source:
  • integer.js, line 500
Returns:
Type
string

valueOf() → {number}

Convert Integer to number.
Source:
  • integer.js, line 566
Returns:
Type
number