base-4.8.1.0: Basic libraries

Copyright(c) The University of Glasgow 2001
LicenseBSD-style (see the file libraries/base/LICENSE)
Maintainerlibraries@haskell.org
Stabilityexperimental
Portabilityportable
Safe HaskellSafe
LanguageHaskell2010

Data.Word

Contents

Description

Unsigned integer types.

Synopsis

Unsigned integral types

data Word :: *

A Word is an unsigned integral type, with the same size as Int.

Instances

Bounded Word Source 
Enum Word Source 
Eq Word 

Methods

(==) :: Word -> Word -> Bool

(/=) :: Word -> Word -> Bool

Integral Word Source 
Data Word Source 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Word -> c Word Source

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Word Source

toConstr :: Word -> Constr Source

dataTypeOf :: Word -> DataType Source

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Word) Source

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Word) Source

gmapT :: (forall b. Data b => b -> b) -> Word -> Word Source

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Word -> r Source

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Word -> r Source

gmapQ :: (forall d. Data d => d -> u) -> Word -> [u] Source

gmapQi :: Int -> (forall d. Data d => d -> u) -> Word -> u Source

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Word -> m Word Source

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Word -> m Word Source

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Word -> m Word Source

Num Word Source 
Ord Word 

Methods

compare :: Word -> Word -> Ordering

(<) :: Word -> Word -> Bool

(<=) :: Word -> Word -> Bool

(>) :: Word -> Word -> Bool

(>=) :: Word -> Word -> Bool

max :: Word -> Word -> Word

min :: Word -> Word -> Word

Read Word Source 
Real Word Source 
Show Word Source 
Ix Word Source 
FiniteBits Word Source 
Bits Word Source 
Storable Word Source 
PrintfArg Word Source 

data Word8 Source

8-bit unsigned integer type

Instances

Bounded Word8 Source 
Enum Word8 Source 
Eq Word8 Source 

Methods

(==) :: Word8 -> Word8 -> Bool

(/=) :: Word8 -> Word8 -> Bool

Integral Word8 Source 
Data Word8 Source 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Word8 -> c Word8 Source

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Word8 Source

toConstr :: Word8 -> Constr Source

dataTypeOf :: Word8 -> DataType Source

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Word8) Source

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Word8) Source

gmapT :: (forall b. Data b => b -> b) -> Word8 -> Word8 Source

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Word8 -> r Source

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Word8 -> r Source

gmapQ :: (forall d. Data d => d -> u) -> Word8 -> [u] Source

gmapQi :: Int -> (forall d. Data d => d -> u) -> Word8 -> u Source

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Word8 -> m Word8 Source

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Word8 -> m Word8 Source

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Word8 -> m Word8 Source

Num Word8 Source 
Ord Word8 Source 

Methods

compare :: Word8 -> Word8 -> Ordering

(<) :: Word8 -> Word8 -> Bool

(<=) :: Word8 -> Word8 -> Bool

(>) :: Word8 -> Word8 -> Bool

(>=) :: Word8 -> Word8 -> Bool

max :: Word8 -> Word8 -> Word8

min :: Word8 -> Word8 -> Word8

Read Word8 Source 
Real Word8 Source 
Show Word8 Source 
Ix Word8 Source 
FiniteBits Word8 Source 
Bits Word8 Source 
Storable Word8 Source 
PrintfArg Word8 Source 

data Word16 Source

16-bit unsigned integer type

Instances

Bounded Word16 Source 
Enum Word16 Source 
Eq Word16 Source 

Methods

(==) :: Word16 -> Word16 -> Bool

(/=) :: Word16 -> Word16 -> Bool

Integral Word16 Source 
Data Word16 Source 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Word16 -> c Word16 Source

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Word16 Source

toConstr :: Word16 -> Constr Source

dataTypeOf :: Word16 -> DataType Source

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Word16) Source

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Word16) Source

gmapT :: (forall b. Data b => b -> b) -> Word16 -> Word16 Source

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Word16 -> r Source

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Word16 -> r Source

gmapQ :: (forall d. Data d => d -> u) -> Word16 -> [u] Source

gmapQi :: Int -> (forall d. Data d => d -> u) -> Word16 -> u Source

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Word16 -> m Word16 Source

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Word16 -> m Word16 Source

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Word16 -> m Word16 Source

Num Word16 Source 
Ord Word16 Source 
Read Word16 Source 
Real Word16 Source 
Show Word16 Source 
Ix Word16 Source 
FiniteBits Word16 Source 
Bits Word16 Source 
Storable Word16 Source 
PrintfArg Word16 Source 

data Word32 Source

32-bit unsigned integer type

Instances

Bounded Word32 Source 
Enum Word32 Source 
Eq Word32 Source 

Methods

(==) :: Word32 -> Word32 -> Bool

(/=) :: Word32 -> Word32 -> Bool

Integral Word32 Source 
Data Word32 Source 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Word32 -> c Word32 Source

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Word32 Source

toConstr :: Word32 -> Constr Source

dataTypeOf :: Word32 -> DataType Source

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Word32) Source

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Word32) Source

gmapT :: (forall b. Data b => b -> b) -> Word32 -> Word32 Source

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Word32 -> r Source

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Word32 -> r Source

gmapQ :: (forall d. Data d => d -> u) -> Word32 -> [u] Source

gmapQi :: Int -> (forall d. Data d => d -> u) -> Word32 -> u Source

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Word32 -> m Word32 Source

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Word32 -> m Word32 Source

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Word32 -> m Word32 Source

Num Word32 Source 
Ord Word32 Source 
Read Word32 Source 
Real Word32 Source 
Show Word32 Source 
Ix Word32 Source 
FiniteBits Word32 Source 
Bits Word32 Source 
Storable Word32 Source 
PrintfArg Word32 Source 

data Word64 Source

64-bit unsigned integer type

Instances

Bounded Word64 Source 
Enum Word64 Source 
Eq Word64 Source 

Methods

(==) :: Word64 -> Word64 -> Bool

(/=) :: Word64 -> Word64 -> Bool

Integral Word64 Source 
Data Word64 Source 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Word64 -> c Word64 Source

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Word64 Source

toConstr :: Word64 -> Constr Source

dataTypeOf :: Word64 -> DataType Source

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Word64) Source

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Word64) Source

gmapT :: (forall b. Data b => b -> b) -> Word64 -> Word64 Source

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Word64 -> r Source

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Word64 -> r Source

gmapQ :: (forall d. Data d => d -> u) -> Word64 -> [u] Source

gmapQi :: Int -> (forall d. Data d => d -> u) -> Word64 -> u Source

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Word64 -> m Word64 Source

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Word64 -> m Word64 Source

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Word64 -> m Word64 Source

Num Word64 Source 
Ord Word64 Source 
Read Word64 Source 
Real Word64 Source 
Show Word64 Source 
Ix Word64 Source 
FiniteBits Word64 Source 
Bits Word64 Source 
Storable Word64 Source 
PrintfArg Word64 Source 

byte swapping

byteSwap16 :: Word16 -> Word16 Source

Swap bytes in Word16.

Since: 4.7.0.0

byteSwap32 :: Word32 -> Word32 Source

Reverse order of bytes in Word32.

Since: 4.7.0.0

byteSwap64 :: Word64 -> Word64 Source

Reverse order of bytes in Word64.

Since: 4.7.0.0

Notes

  • All arithmetic is performed modulo 2^n, where n is the number of bits in the type. One non-obvious consequence of this is that negate should not raise an error on negative arguments.
  • For coercing between any two integer types, use fromIntegral, which is specialized for all the common cases so should be fast enough. Coercing word types to and from integer types preserves representation, not sign.
  • An unbounded size unsigned integer type is available with Natural.
  • The rules that hold for Enum instances over a bounded type such as Int (see the section of the Haskell report dealing with arithmetic sequences) also hold for the Enum instances over the various Word types defined here.
  • Right and left shifts by amounts greater than or equal to the width of the type result in a zero result. This is contrary to the behaviour in C, which is undefined; a common interpretation is to truncate the shift count to the width of the type, for example 1 << 32 == 1 in some C implementations.