Link Search Menu Expand Document
fp-ts-numerics

UInt32 overview

Added in v1.0.0

Table of contents

Constructor

fromNumber

Attempts to construct a [[UInt32]] from a number, computing none if the number is not an integer in the bounds of UInt32, otherwise some(n).

Signature

export declare function fromNumber(n: number): option.Option<UInt32>

Added in v1.0.0

fromNumberLossy

Constructs a [[UInt32]] from a number, wrapping the value if it overflows the range of [[UInt32]].

Signature

export declare function fromNumberLossy(n: number): UInt32

Added in v1.0.0

of

Constructs a UInt32 from [[Digits]]

Signature

export declare function of(zero: 0): UInt32
export declare function of(...digits: Digits): NonZero<UInt32>

Added in v1.0.0

unsafeFromNumber

Attempts to construct a [[UInt32]] from a number, throwing a RangeError if the number is not an integer in the bounds of UInt32.

Signature

export declare function unsafeFromNumber(n: number): UInt32

Added in v1.0.0

Data Type

UInt32 (interface)

Signature

export interface UInt32 extends Newtype<typeof U_INT_32, NonNegative<number>> {}

Added in v1.0.0

Typeclass Instance

CommutativeRing

Signature

export declare const CommutativeRing: CommutativeRing<UInt32>

Added in v1.0.0

EuclideanRing

Signature

export declare const EuclideanRing: EuclideanRing<UInt32>

Added in v1.0.0

HasPow

Signature

export declare const HasPow: HasPow<UInt32>

Added in v1.0.0

HasToInt

Signature

export declare const HasToInt: { toInt: typeof toInt }

Added in v1.0.0

Ring

Signature

export declare const Ring: Ring<UInt32>

Added in v1.0.0

Semiring

Signature

export declare const Semiring: Semiring<UInt32>

Added in v1.0.0

utils

Digits (type alias)

A tuple of literal integers representing every valid sequence of digits for [[UInt32]]

Signature

export type Digits =
  | [0]
  | [LeadingDigit]
  | [LeadingDigit, Digit]
  | [LeadingDigit, Digit, Digit]
  | [LeadingDigit, Digit, Digit, Digit]
  | [LeadingDigit, Digit, Digit, Digit, Digit]
  | [LeadingDigit, Digit, Digit, Digit, Digit, Digit]
  | [LeadingDigit, Digit, Digit, Digit, Digit, Digit, Digit]
  | [LeadingDigit, Digit, Digit, Digit, Digit, Digit, Digit, Digit]
  | [LeadingDigit, Digit, Digit, Digit, Digit, Digit, Digit, Digit, Digit]
  | [1 | 2 | 3, Digit, Digit, Digit, Digit, Digit, Digit, Digit, Digit, Digit]
  | [4, 0 | 1, Digit, Digit, Digit, Digit, Digit, Digit, Digit, Digit]
  | [4, 2, Exclude<Digit, 9>, Digit, Digit, Digit, Digit, Digit, Digit, Digit]
  | [4, 2, 9, 0 | 1 | 2 | 3, Digit, Digit, Digit, Digit, Digit, Digit]
  | [4, 2, 9, 4, Exclude<Digit, 9>, Digit, Digit, Digit, Digit, Digit]
  | [4, 2, 9, 4, 9, 0 | 1 | 2 | 3 | 4 | 5, Digit, Digit, Digit, Digit]
  | [4, 2, 9, 4, 9, 6, Exclude<Digit, 7 | 8 | 9>, Digit, Digit, Digit]
  | [4, 2, 9, 4, 9, 6, 7, 0 | 1, Digit, Digit]
  | [4, 2, 9, 4, 9, 6, 7, 2, Exclude<Digit, 9>, Digit]
  | [4, 2, 9, 4, 9, 6, 7, 2, 9, Exclude<Digit, 6 | 7 | 8 | 9>]

Added in v1.0.0

UInt32

Signature

export declare const UInt32: Bounded<UInt32> &
  CommutativeRing<UInt32> &
  Enum<UInt32> &
  Eq<UInt32> &
  EuclideanRing<UInt32> &
  HasPow<UInt32> &
  HasToInt<UInt32> &
  HasToRational<UInt32> &
  Integral<UInt32> &
  Numeric<UInt32> &
  Ord<UInt32> &
  Ring<UInt32> &
  Semiring<UInt32> &
  Show<UInt32> & {
    add: typeof add
    bottom: UInt32
    Bounded: Bounded<UInt32>
    compare: (x: UInt32, y: UInt32) => Ordering
    div: typeof div
    Enum: Enum<UInt32>
    Eq: Eq<UInt32>
    equals: typeof equals
    fromInt: typeof fromInt
    fromNumber: typeof fromNumber
    fromNumberLossy: typeof fromNumberLossy
    Integral: Integral<UInt32>
    isTypeOf: typeof isTypeOf
    mod: typeof mod
    mul: typeof mul
    negate: typeof negate
    next: typeof next
    Numeric: Numeric<UInt32>
    of: typeof of
    one: UInt32
    Ord: Ord<UInt32>
    pow: typeof pow
    prev: typeof prev
    quot: typeof quot
    HasToRational: HasToRational<UInt32>
    rem: typeof rem
    Show: Show<UInt32>
    sub: typeof sub
    toInt: typeof toInt
    toInteger: typeof toInteger
    toNonNegativeNumber: typeof toNumber
    top: UInt32
    toRational: typeof toRational
    unsafeFromNumber: typeof unsafeFromNumber
    zero: UInt32
  }

Added in v1.0.0

add

Signature

export declare function add(a: UInt32, b: UInt32): UInt32

Added in v1.0.0

bottom

Signature

export declare const bottom: UInt32

Added in v1.0.0

compare

Signature

export declare const compare: (x: UInt32, y: UInt32) => Ordering

Added in v1.0.0

degree

Signature

export declare function degree(i: UInt32): Natural

Added in v1.0.0

div

Signature

export declare function div(n: UInt32, d: NonZero<UInt32>): UInt32

Added in v1.0.0

equals

Signature

export declare function equals(a: UInt32, b: UInt32): boolean

Added in v1.0.0

fromInt

Signature

export declare function fromInt(int: Int): Option<UInt32>

Added in v1.0.0

isTypeOf

Signature

export declare function isTypeOf(x: unknown): x is UInt32

Added in v1.0.0

mod

Signature

export declare function mod(n: UInt32, d: NonZero<UInt32>): UInt32

Added in v1.0.0

mul

Signature

export declare function mul(a: UInt32, b: UInt32): UInt32

Added in v1.0.0

negate

Signature

export declare function negate(a: UInt32): UInt32

Added in v1.0.0

next

Signature

export declare function next(a: UInt32): Option<UInt32>

Added in v1.0.0

one

Signature

export declare const one: UInt32

Added in v1.0.0

pow

Signature

export declare function pow(n: UInt32, exp: UInt32): UInt32

Added in v1.0.0

prev

Signature

export declare function prev(a: UInt32): Option<UInt32>

Added in v1.0.0

quot

Signature

export declare function quot(a: UInt32, b: NonZero<UInt32>): UInt32

Added in v1.0.0

rem

Signature

export declare function rem(a: UInt32, b: NonZero<UInt32>): UInt32

Added in v1.0.0

sub

Signature

export declare function sub(a: UInt32, b: UInt32): UInt32

Added in v1.0.0

toInt

Signature

export declare function toInt(a: UInt32): Int

Added in v1.0.0

toInteger

Signature

export declare function toInteger(a: UInt32): Int

Added in v1.0.0

toNumber

Signature

export declare function toNumber(i: UInt32): NonNegative<number>

Added in v1.0.0

toRational

Signature

export declare function toRational(a: UInt32): Rational

Added in v1.0.0

top

Signature

export declare const top: UInt32

Added in v1.0.0

zero

Signature

export declare const zero: UInt32

Added in v1.0.0