Numeric.Sized.WordOfSize

This module exports the WordOfSize type and associated functions.

Documentation

newtype WordOfSize n

An unsigned integer type with a size decided by a type-level nat. Numeric operations wraparound by default:

>>> (255 :: WordOfSize 8) + 1
0

Constructors

WordOfSize

Fields

• getWordOfSize :: Natural

Instances

KnownNat n => Bounded (WordOfSize n)

Methods

minBound :: WordOfSize n

maxBound :: WordOfSize n

KnownNat n => Enum (WordOfSize n)

Methods

succ :: WordOfSize n -> WordOfSize n

pred :: WordOfSize n -> WordOfSize n

toEnum :: Int -> WordOfSize n

fromEnum :: WordOfSize n -> Int

enumFrom :: WordOfSize n -> [WordOfSize n]

enumFromThen :: WordOfSize n -> WordOfSize n -> [WordOfSize n]

enumFromTo :: WordOfSize n -> WordOfSize n -> [WordOfSize n]

enumFromThenTo :: WordOfSize n -> WordOfSize n -> WordOfSize n -> [WordOfSize n]

KnownNat n => Eq (WordOfSize n)

Methods

(==) :: WordOfSize n -> WordOfSize n -> Bool

(/=) :: WordOfSize n -> WordOfSize n -> Bool

KnownNat n => Integral (WordOfSize n)

Methods

quot :: WordOfSize n -> WordOfSize n -> WordOfSize n

rem :: WordOfSize n -> WordOfSize n -> WordOfSize n

div :: WordOfSize n -> WordOfSize n -> WordOfSize n

mod :: WordOfSize n -> WordOfSize n -> WordOfSize n

quotRem :: WordOfSize n -> WordOfSize n -> (WordOfSize n, WordOfSize n)

divMod :: WordOfSize n -> WordOfSize n -> (WordOfSize n, WordOfSize n)

toInteger :: WordOfSize n -> Integer

KnownNat n => Num (WordOfSize n)

Methods

(+) :: WordOfSize n -> WordOfSize n -> WordOfSize n

(-) :: WordOfSize n -> WordOfSize n -> WordOfSize n

(*) :: WordOfSize n -> WordOfSize n -> WordOfSize n

negate :: WordOfSize n -> WordOfSize n

abs :: WordOfSize n -> WordOfSize n

signum :: WordOfSize n -> WordOfSize n

fromInteger :: Integer -> WordOfSize n

KnownNat n => Ord (WordOfSize n)

Methods

compare :: WordOfSize n -> WordOfSize n -> Ordering

(<) :: WordOfSize n -> WordOfSize n -> Bool

(<=) :: WordOfSize n -> WordOfSize n -> Bool

(>) :: WordOfSize n -> WordOfSize n -> Bool

(>=) :: WordOfSize n -> WordOfSize n -> Bool

max :: WordOfSize n -> WordOfSize n -> WordOfSize n

min :: WordOfSize n -> WordOfSize n -> WordOfSize n

KnownNat n => Real (WordOfSize n)

Methods

toRational :: WordOfSize n -> Rational

KnownNat n => Show (WordOfSize n)

Methods

showsPrec :: Int -> WordOfSize n -> ShowS

show :: WordOfSize n -> String

showList :: [WordOfSize n] -> ShowS

KnownNat n => Ix (WordOfSize n)

Methods

range :: (WordOfSize n, WordOfSize n) -> [WordOfSize n]

index :: (WordOfSize n, WordOfSize n) -> WordOfSize n -> Int

unsafeIndex :: (WordOfSize n, WordOfSize n) -> WordOfSize n -> Int

inRange :: (WordOfSize n, WordOfSize n) -> WordOfSize n -> Bool

rangeSize :: (WordOfSize n, WordOfSize n) -> Int

unsafeRangeSize :: (WordOfSize n, WordOfSize n) -> Int

Generic (WordOfSize n)

Associated Types

type Rep (WordOfSize n) :: * -> *

Methods

from :: WordOfSize n -> Rep (WordOfSize n) x

to :: Rep (WordOfSize n) x -> WordOfSize n

KnownNat n => Bits (WordOfSize n)

Methods

(.&.) :: WordOfSize n -> WordOfSize n -> WordOfSize n

(.|.) :: WordOfSize n -> WordOfSize n -> WordOfSize n

xor :: WordOfSize n -> WordOfSize n -> WordOfSize n

complement :: WordOfSize n -> WordOfSize n

shift :: WordOfSize n -> Int -> WordOfSize n

rotate :: WordOfSize n -> Int -> WordOfSize n

zeroBits :: WordOfSize n

bit :: Int -> WordOfSize n

setBit :: WordOfSize n -> Int -> WordOfSize n

clearBit :: WordOfSize n -> Int -> WordOfSize n

complementBit :: WordOfSize n -> Int -> WordOfSize n

testBit :: WordOfSize n -> Int -> Bool

bitSizeMaybe :: WordOfSize n -> Maybe Int

bitSize :: WordOfSize n -> Int

isSigned :: WordOfSize n -> Bool

shiftL :: WordOfSize n -> Int -> WordOfSize n

unsafeShiftL :: WordOfSize n -> Int -> WordOfSize n

shiftR :: WordOfSize n -> Int -> WordOfSize n

unsafeShiftR :: WordOfSize n -> Int -> WordOfSize n

rotateL :: WordOfSize n -> Int -> WordOfSize n

rotateR :: WordOfSize n -> Int -> WordOfSize n

popCount :: WordOfSize n -> Int

KnownNat n => FiniteBits (WordOfSize n)

Methods

finiteBitSize :: WordOfSize n -> Int

countLeadingZeros :: WordOfSize n -> Int

countTrailingZeros :: WordOfSize n -> Int

type Rep (WordOfSize n)

type Rep (WordOfSize n) = D1 (MetaData "WordOfSize" "Numeric.Sized.WordOfSize" "nat-sized-numbers-0.2.0.0-G32RKoDML39HRDzfqWsuNm" True) (C1 (MetaCons "WordOfSize" PrefixI True) (S1 (MetaSel (Just Symbol "getWordOfSize") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Natural)))

allWordsOfSize :: KnownNat n => [WordOfSize n]

Generates all words of a given size

>>> allWordOfSize :: [WordOfSize 3]
[0,1,2,3,4,5,6,7]