Module

Data.Int

Package
purescript-integers
Repository
purescript/purescript-integers

#fromNumber Source

fromNumber :: Number -> Maybe Int

Creates an Int from a Number value. The number must already be an integer and fall within the valid range of values for the Int type otherwise Nothing is returned.

#floor Source

floor :: Number -> Int

Convert a Number to an Int, by taking the closest integer equal to or less than the argument. Values outside the Int range are clamped, NaN and Infinity values return 0.

#ceil Source

ceil :: Number -> Int

Convert a Number to an Int, by taking the closest integer equal to or greater than the argument. Values outside the Int range are clamped, NaN and Infinity values return 0.

#round Source

round :: Number -> Int

Convert a Number to an Int, by taking the nearest integer to the argument. Values outside the Int range are clamped, NaN and Infinity values return 0.

#toNumber Source

toNumber :: Int -> Number

Converts an Int value back into a Number. Any Int is a valid Number so there is no loss of precision with this function.

#fromString Source

fromString :: String -> Maybe Int

Reads an Int from a String value. The number must parse as an integer and fall within the valid range of values for the Int type, otherwise Nothing is returned.

#Parity Source

data Parity

A type for describing whether an integer is even or odd.

Constructors

Instances

#parity Source

parity :: Int -> Parity

Returns whether an Int is Even or Odd.

parity 0 == Even
parity 1 == Odd

#even Source

even :: Int -> Boolean

Returns whether an Int is an even number.

even 0 == true
even 1 == false

#odd Source

odd :: Int -> Boolean

The negation of even.

odd 0 == false
odd 1 == true

#Radix Source

newtype Radix

The number of unique digits (including zero) used to represent integers in a specific base.

#binary Source

binary :: Radix

The base-2 system.

#octal Source

octal :: Radix

The base-8 system.

#decimal Source

decimal :: Radix

The base-10 system.

#hexadecimal Source

hexadecimal :: Radix

The base-16 system.

#base36 Source

base36 :: Radix

The base-36 system.

#radix Source

radix :: Int -> Maybe Radix

Create a Radix from a number between 2 and 36.

#fromStringAs Source

fromStringAs :: Radix -> String -> Maybe Int

Like fromString, but the integer can be specified in a different base.

Example:

fromStringAs binary      "100" == Just 4
fromStringAs hexadecimal "ff"  == Just 255

#pow Source

pow :: Int -> Int -> Int

Raise an Int to the power of another Int.

#toStringAs Source