API Docs for:
Show:

Formatter.util.number Class

Defined in: ../lib/pat.js:548
Module: pat

Number utility functions.

Item Index

Methods

Properties

Methods

isSigned

(
  • arg
)
Boolean static

Defined in ../lib/pat.js:579

Returns true if the given number is less than zero or negative zero.

Parameters:

  • arg Number

Returns:

Boolean:

isSymbolicNumber

(
  • arg
)
Boolean static

Defined in ../lib/pat.js:649

Returns true if the given argument represents a symbolic number (NaN, POSITIVEINFINITY, NEGATIVEINFINITY), false otherwise.

Parameters:

  • arg Number

Returns:

Boolean:

round

(
  • arg
  • [precision=0]
)
Number static

Defined in ../lib/pat.js:590

Returns the given argument rounded to the given precision.

Parameters:

  • arg Number

    Number to be rounded

  • [precision=0] Number optional

    Number of precise fractional digits. A falsy value specifies fractional precision of 0.

Returns:

Number:

signedInt

(
  • arg
)
Number static

Defined in ../lib/pat.js:604

Returns the given argument as a Number within the range [Formatter.util.number.MINSIGNEDINT, Formatter.util.number.MAXSIGNEDINT].

Parameters:

  • arg Number

Returns:

Number:

twosComplement

(
  • arg
)
Number static

Defined in ../lib/pat.js:622

Returns a decimal integer representing two's complement of the given number.

A JavaScript Number is a double-precision floating-point as specified by the IEEE 754 standard. All positive integers up to 2^53 are represented precisely, numbers beyond that threshold get their least significant bits clipped (((Math.pow(2,53) + 1) - Math.pow(2,53) results to 0, not 1).

The argument is therefore interpreted as an integer within the range [-2^52, 2^52-1]. A floating point argument is truncated, an argument out of the expected range is set to the smallest or to the greatest precise value depending on whether the argument is smaller than -2^52 or greater than 2^52-1.

Parameters:

  • arg Number

Returns:

Number:

Properties

MAX_INT

Number final static

Defined in ../lib/pat.js:554

Greatest precise integer value in JavaScript.

MAX_SIGNED_INT

Number final static

Defined in ../lib/pat.js:562

Greatest precise integer value in two's complement range.

MIN_SIGNED_INT

Number final static

Defined in ../lib/pat.js:570

Smallest precise integer value in two's complement range.