ghc-internal-9.1001.0: Basic libraries
Copyright (c) The University of Glasgow 2001 BSD-style (see the file libraries/base/LICENSE) libraries@haskell.org stable portable Trustworthy Haskell2010

GHC.Internal.Bits

Description

This module defines bitwise operations for signed and unsigned integers. Instances of the class Bits for the Int and Integer types are available from this module, and instances for explicitly sized integral types are available from the Data.Int and Data.Word modules.

Synopsis

# Documentation

class Eq a => Bits a where Source #

The Bits class defines bitwise operations over integral types.

• Bits are numbered from 0 with bit 0 being the least significant bit.

Minimal complete definition

Methods

(.&.) :: a -> a -> a infixl 7 Source #

Bitwise "and"

(.|.) :: a -> a -> a infixl 5 Source #

Bitwise "or"

xor :: a -> a -> a infixl 6 Source #

Bitwise "xor"

complement :: a -> a Source #

Reverse all the bits in the argument

shift :: a -> Int -> a infixl 8 Source #

shift x i shifts x left by i bits if i is positive, or right by -i bits otherwise. Right shifts perform sign extension on signed number types; i.e. they fill the top bits with 1 if the x is negative and with 0 otherwise.

An instance can define either this unified shift or shiftL and shiftR, depending on which is more convenient for the type in question.

rotate :: a -> Int -> a infixl 8 Source #

rotate x i rotates x left by i bits if i is positive, or right by -i bits otherwise.

For unbounded types like Integer, rotate is equivalent to shift.

An instance can define either this unified rotate or rotateL and rotateR, depending on which is more convenient for the type in question.

zeroBits :: a Source #

zeroBits is the value with all bits unset.

The following laws ought to hold (for all valid bit indices n):

• clearBit zeroBits n == zeroBits
• setBit   zeroBits n == bit n
• testBit  zeroBits n == False
• popCount zeroBits   == 0

This method uses clearBit (bit 0) 0 as its default implementation (which ought to be equivalent to zeroBits for types which possess a 0th bit).

@since base-4.7.0.0

bit :: Int -> a Source #

bit i is a value with the ith bit set and all other bits clear.

Can be implemented using bitDefault if a is also an instance of Num.

See also zeroBits.

setBit :: a -> Int -> a Source #

x setBit i is the same as x .|. bit i

clearBit :: a -> Int -> a Source #

x clearBit i is the same as x .&. complement (bit i)

complementBit :: a -> Int -> a Source #

x complementBit i is the same as x xor bit i

testBit :: a -> Int -> Bool Source #

x testBit i is the same as x .&. bit n /= 0

In other words it returns True if the bit at offset @n is set.

Can be implemented using testBitDefault if a is also an instance of Num.

bitSizeMaybe :: a -> Maybe Int Source #

Return the number of bits in the type of the argument. The actual value of the argument is ignored. Returns Nothing for types that do not have a fixed bitsize, like Integer.

@since base-4.7.0.0

bitSize :: a -> Int Source #

Deprecated: Use bitSizeMaybe or finiteBitSize instead

Return the number of bits in the type of the argument. The actual value of the argument is ignored. The function bitSize is undefined for types that do not have a fixed bitsize, like Integer.

Default implementation based upon bitSizeMaybe provided since 4.12.0.0.

isSigned :: a -> Bool Source #

Return True if the argument is a signed type. The actual value of the argument is ignored

shiftL :: a -> Int -> a infixl 8 Source #

Shift the argument left by the specified number of bits (which must be non-negative). Some instances may throw an Overflow exception if given a negative input.

An instance can define either this and shiftR or the unified shift, depending on which is more convenient for the type in question.

unsafeShiftL :: a -> Int -> a Source #

Shift the argument left by the specified number of bits. The result is undefined for negative shift amounts and shift amounts greater or equal to the bitSize.

Defaults to shiftL unless defined explicitly by an instance.

@since base-4.5.0.0

shiftR :: a -> Int -> a infixl 8 Source #

Shift the first argument right by the specified number of bits. The result is undefined for negative shift amounts and shift amounts greater or equal to the bitSize. Some instances may throw an Overflow exception if given a negative input.

Right shifts perform sign extension on signed number types; i.e. they fill the top bits with 1 if the x is negative and with 0 otherwise.

An instance can define either this and shiftL or the unified shift, depending on which is more convenient for the type in question.

unsafeShiftR :: a -> Int -> a Source #

Shift the first argument right by the specified number of bits, which must be non-negative and smaller than the number of bits in the type.

Right shifts perform sign extension on signed number types; i.e. they fill the top bits with 1 if the x is negative and with 0 otherwise.

Defaults to shiftR unless defined explicitly by an instance.

@since base-4.5.0.0

rotateL :: a -> Int -> a infixl 8 Source #

Rotate the argument left by the specified number of bits (which must be non-negative).

An instance can define either this and rotateR or the unified rotate, depending on which is more convenient for the type in question.

rotateR :: a -> Int -> a infixl 8 Source #

Rotate the argument right by the specified number of bits (which must be non-negative).

An instance can define either this and rotateL or the unified rotate, depending on which is more convenient for the type in question.

popCount :: a -> Int Source #

Return the number of set bits in the argument. This number is known as the population count or the Hamming weight.

Can be implemented using popCountDefault if a is also an instance of Num.

@since base-4.5.0.0

#### Instances

Instances details
 Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods(.&.) :: CInt -> CInt -> CInt Source #(.|.) :: CInt -> CInt -> CInt Source #xor :: CInt -> CInt -> CInt Source #shift :: CInt -> Int -> CInt Source #rotate :: CInt -> Int -> CInt Source #setBit :: CInt -> Int -> CInt Source #shiftL :: CInt -> Int -> CInt Source #shiftR :: CInt -> Int -> CInt Source # Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.Ptr Methods Source # Instance detailsDefined in GHC.Internal.Foreign.Ptr Methods Source # @since base-2.01 Instance detailsDefined in GHC.Internal.Int Methods Source # @since base-2.01 Instance detailsDefined in GHC.Internal.Int Methods Source # @since base-2.01 Instance detailsDefined in GHC.Internal.Int Methods Source # @since base-2.01 Instance detailsDefined in GHC.Internal.Int Methods(.&.) :: Int8 -> Int8 -> Int8 Source #(.|.) :: Int8 -> Int8 -> Int8 Source #xor :: Int8 -> Int8 -> Int8 Source #shift :: Int8 -> Int -> Int8 Source #rotate :: Int8 -> Int -> Int8 Source #setBit :: Int8 -> Int -> Int8 Source #shiftL :: Int8 -> Int -> Int8 Source #shiftR :: Int8 -> Int -> Int8 Source # Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods(.&.) :: CDev -> CDev -> CDev Source #(.|.) :: CDev -> CDev -> CDev Source #xor :: CDev -> CDev -> CDev Source #shift :: CDev -> Int -> CDev Source #rotate :: CDev -> Int -> CDev Source #setBit :: CDev -> Int -> CDev Source #shiftL :: CDev -> Int -> CDev Source #shiftR :: CDev -> Int -> CDev Source # Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods(.&.) :: CGid -> CGid -> CGid Source #(.|.) :: CGid -> CGid -> CGid Source #xor :: CGid -> CGid -> CGid Source #shift :: CGid -> Int -> CGid Source #rotate :: CGid -> Int -> CGid Source #setBit :: CGid -> Int -> CGid Source #shiftL :: CGid -> Int -> CGid Source #shiftR :: CGid -> Int -> CGid Source # Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods(.&.) :: CId -> CId -> CId Source #(.|.) :: CId -> CId -> CId Source #xor :: CId -> CId -> CId Source #shift :: CId -> Int -> CId Source #rotate :: CId -> Int -> CId Source #bit :: Int -> CId Source #setBit :: CId -> Int -> CId Source #clearBit :: CId -> Int -> CId Source #testBit :: CId -> Int -> Bool Source #shiftL :: CId -> Int -> CId Source #shiftR :: CId -> Int -> CId Source #rotateL :: CId -> Int -> CId Source #rotateR :: CId -> Int -> CId Source # Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods(.&.) :: CIno -> CIno -> CIno Source #(.|.) :: CIno -> CIno -> CIno Source #xor :: CIno -> CIno -> CIno Source #shift :: CIno -> Int -> CIno Source #rotate :: CIno -> Int -> CIno Source #setBit :: CIno -> Int -> CIno Source #shiftL :: CIno -> Int -> CIno Source #shiftR :: CIno -> Int -> CIno Source # Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods(.&.) :: CKey -> CKey -> CKey Source #(.|.) :: CKey -> CKey -> CKey Source #xor :: CKey -> CKey -> CKey Source #shift :: CKey -> Int -> CKey Source #rotate :: CKey -> Int -> CKey Source #setBit :: CKey -> Int -> CKey Source #shiftL :: CKey -> Int -> CKey Source #shiftR :: CKey -> Int -> CKey Source # Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods(.&.) :: COff -> COff -> COff Source #(.|.) :: COff -> COff -> COff Source #xor :: COff -> COff -> COff Source #shift :: COff -> Int -> COff Source #rotate :: COff -> Int -> COff Source #setBit :: COff -> Int -> COff Source #shiftL :: COff -> Int -> COff Source #shiftR :: COff -> Int -> COff Source # Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods(.&.) :: CPid -> CPid -> CPid Source #(.|.) :: CPid -> CPid -> CPid Source #xor :: CPid -> CPid -> CPid Source #shift :: CPid -> Int -> CPid Source #rotate :: CPid -> Int -> CPid Source #setBit :: CPid -> Int -> CPid Source #shiftL :: CPid -> Int -> CPid Source #shiftR :: CPid -> Int -> CPid Source # Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods(.&.) :: CUid -> CUid -> CUid Source #(.|.) :: CUid -> CUid -> CUid Source #xor :: CUid -> CUid -> CUid Source #shift :: CUid -> Int -> CUid Source #rotate :: CUid -> Int -> CUid Source #setBit :: CUid -> Int -> CUid Source #shiftL :: CUid -> Int -> CUid Source #shiftR :: CUid -> Int -> CUid Source # Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods(.&.) :: Fd -> Fd -> Fd Source #(.|.) :: Fd -> Fd -> Fd Source #xor :: Fd -> Fd -> Fd Source #shift :: Fd -> Int -> Fd Source #rotate :: Fd -> Int -> Fd Source #bit :: Int -> Fd Source #setBit :: Fd -> Int -> Fd Source #clearBit :: Fd -> Int -> Fd Source #testBit :: Fd -> Int -> Bool Source #shiftL :: Fd -> Int -> Fd Source #shiftR :: Fd -> Int -> Fd Source #rotateL :: Fd -> Int -> Fd Source #rotateR :: Fd -> Int -> Fd Source # Source # @since base-2.01 Instance detailsDefined in GHC.Internal.Word Methods Source # @since base-2.01 Instance detailsDefined in GHC.Internal.Word Methods Source # @since base-2.01 Instance detailsDefined in GHC.Internal.Word Methods Source # @since base-2.01 Instance detailsDefined in GHC.Internal.Word Methods Source # @since base-2.01 Instance detailsDefined in GHC.Internal.Bits Methods Source # @since base-4.8.0 Instance detailsDefined in GHC.Internal.Bits Methods Source # Interpret Bool as 1-bit bit-field@since base-4.7.0.0 Instance detailsDefined in GHC.Internal.Bits Methods(.&.) :: Bool -> Bool -> Bool Source #(.|.) :: Bool -> Bool -> Bool Source #xor :: Bool -> Bool -> Bool Source #shift :: Bool -> Int -> Bool Source #rotate :: Bool -> Int -> Bool Source #setBit :: Bool -> Int -> Bool Source #shiftL :: Bool -> Int -> Bool Source #shiftR :: Bool -> Int -> Bool Source # Source # @since base-2.01 Instance detailsDefined in GHC.Internal.Bits Methods(.&.) :: Int -> Int -> Int Source #(.|.) :: Int -> Int -> Int Source #xor :: Int -> Int -> Int Source #shift :: Int -> Int -> Int Source #rotate :: Int -> Int -> Int Source #bit :: Int -> Int Source #setBit :: Int -> Int -> Int Source #clearBit :: Int -> Int -> Int Source #testBit :: Int -> Int -> Bool Source #shiftL :: Int -> Int -> Int Source #shiftR :: Int -> Int -> Int Source #rotateL :: Int -> Int -> Int Source #rotateR :: Int -> Int -> Int Source # Source # @since base-2.01 Instance detailsDefined in GHC.Internal.Bits Methods(.&.) :: Word -> Word -> Word Source #(.|.) :: Word -> Word -> Word Source #xor :: Word -> Word -> Word Source #shift :: Word -> Int -> Word Source #rotate :: Word -> Int -> Word Source #setBit :: Word -> Int -> Word Source #shiftL :: Word -> Int -> Word Source #shiftR :: Word -> Int -> Word Source # Bits a => Bits (And a) Source # @since base-4.16 Instance detailsDefined in GHC.Internal.Data.Bits Methods(.&.) :: And a -> And a -> And a Source #(.|.) :: And a -> And a -> And a Source #xor :: And a -> And a -> And a Source #complement :: And a -> And a Source #shift :: And a -> Int -> And a Source #rotate :: And a -> Int -> And a Source #bit :: Int -> And a Source #setBit :: And a -> Int -> And a Source #clearBit :: And a -> Int -> And a Source #complementBit :: And a -> Int -> And a Source #testBit :: And a -> Int -> Bool Source #bitSize :: And a -> Int Source #isSigned :: And a -> Bool Source #shiftL :: And a -> Int -> And a Source #unsafeShiftL :: And a -> Int -> And a Source #shiftR :: And a -> Int -> And a Source #unsafeShiftR :: And a -> Int -> And a Source #rotateL :: And a -> Int -> And a Source #rotateR :: And a -> Int -> And a Source #popCount :: And a -> Int Source # Bits a => Bits (Iff a) Source # @since base-4.16 Instance detailsDefined in GHC.Internal.Data.Bits Methods(.&.) :: Iff a -> Iff a -> Iff a Source #(.|.) :: Iff a -> Iff a -> Iff a Source #xor :: Iff a -> Iff a -> Iff a Source #complement :: Iff a -> Iff a Source #shift :: Iff a -> Int -> Iff a Source #rotate :: Iff a -> Int -> Iff a Source #bit :: Int -> Iff a Source #setBit :: Iff a -> Int -> Iff a Source #clearBit :: Iff a -> Int -> Iff a Source #complementBit :: Iff a -> Int -> Iff a Source #testBit :: Iff a -> Int -> Bool Source #bitSize :: Iff a -> Int Source #isSigned :: Iff a -> Bool Source #shiftL :: Iff a -> Int -> Iff a Source #unsafeShiftL :: Iff a -> Int -> Iff a Source #shiftR :: Iff a -> Int -> Iff a Source #unsafeShiftR :: Iff a -> Int -> Iff a Source #rotateL :: Iff a -> Int -> Iff a Source #rotateR :: Iff a -> Int -> Iff a Source #popCount :: Iff a -> Int Source # Bits a => Bits (Ior a) Source # @since base-4.16 Instance detailsDefined in GHC.Internal.Data.Bits Methods(.&.) :: Ior a -> Ior a -> Ior a Source #(.|.) :: Ior a -> Ior a -> Ior a Source #xor :: Ior a -> Ior a -> Ior a Source #complement :: Ior a -> Ior a Source #shift :: Ior a -> Int -> Ior a Source #rotate :: Ior a -> Int -> Ior a Source #bit :: Int -> Ior a Source #setBit :: Ior a -> Int -> Ior a Source #clearBit :: Ior a -> Int -> Ior a Source #complementBit :: Ior a -> Int -> Ior a Source #testBit :: Ior a -> Int -> Bool Source #bitSize :: Ior a -> Int Source #isSigned :: Ior a -> Bool Source #shiftL :: Ior a -> Int -> Ior a Source #unsafeShiftL :: Ior a -> Int -> Ior a Source #shiftR :: Ior a -> Int -> Ior a Source #unsafeShiftR :: Ior a -> Int -> Ior a Source #rotateL :: Ior a -> Int -> Ior a Source #rotateR :: Ior a -> Int -> Ior a Source #popCount :: Ior a -> Int Source # Bits a => Bits (Xor a) Source # @since base-4.16 Instance detailsDefined in GHC.Internal.Data.Bits Methods(.&.) :: Xor a -> Xor a -> Xor a Source #(.|.) :: Xor a -> Xor a -> Xor a Source #xor :: Xor a -> Xor a -> Xor a Source #complement :: Xor a -> Xor a Source #shift :: Xor a -> Int -> Xor a Source #rotate :: Xor a -> Int -> Xor a Source #bit :: Int -> Xor a Source #setBit :: Xor a -> Int -> Xor a Source #clearBit :: Xor a -> Int -> Xor a Source #complementBit :: Xor a -> Int -> Xor a Source #testBit :: Xor a -> Int -> Bool Source #bitSize :: Xor a -> Int Source #isSigned :: Xor a -> Bool Source #shiftL :: Xor a -> Int -> Xor a Source #unsafeShiftL :: Xor a -> Int -> Xor a Source #shiftR :: Xor a -> Int -> Xor a Source #unsafeShiftR :: Xor a -> Int -> Xor a Source #rotateL :: Xor a -> Int -> Xor a Source #rotateR :: Xor a -> Int -> Xor a Source #popCount :: Xor a -> Int Source # Bits a => Bits (Identity a) Source # @since base-4.9.0.0 Instance detailsDefined in GHC.Internal.Data.Functor.Identity Methods(.&.) :: Identity a -> Identity a -> Identity a Source #(.|.) :: Identity a -> Identity a -> Identity a Source #xor :: Identity a -> Identity a -> Identity a Source #shift :: Identity a -> Int -> Identity a Source #rotate :: Identity a -> Int -> Identity a Source #setBit :: Identity a -> Int -> Identity a Source #clearBit :: Identity a -> Int -> Identity a Source #testBit :: Identity a -> Int -> Bool Source #shiftL :: Identity a -> Int -> Identity a Source #shiftR :: Identity a -> Int -> Identity a Source #rotateL :: Identity a -> Int -> Identity a Source #rotateR :: Identity a -> Int -> Identity a Source # Bits a => Bits (Down a) Source # @since base-4.14.0.0 Instance detailsDefined in GHC.Internal.Data.Ord Methods(.&.) :: Down a -> Down a -> Down a Source #(.|.) :: Down a -> Down a -> Down a Source #xor :: Down a -> Down a -> Down a Source #complement :: Down a -> Down a Source #shift :: Down a -> Int -> Down a Source #rotate :: Down a -> Int -> Down a Source #bit :: Int -> Down a Source #setBit :: Down a -> Int -> Down a Source #clearBit :: Down a -> Int -> Down a Source #complementBit :: Down a -> Int -> Down a Source #testBit :: Down a -> Int -> Bool Source #bitSize :: Down a -> Int Source #isSigned :: Down a -> Bool Source #shiftL :: Down a -> Int -> Down a Source #unsafeShiftL :: Down a -> Int -> Down a Source #shiftR :: Down a -> Int -> Down a Source #unsafeShiftR :: Down a -> Int -> Down a Source #rotateL :: Down a -> Int -> Down a Source #rotateR :: Down a -> Int -> Down a Source #popCount :: Down a -> Int Source # Bits a => Bits (Const a b) Source # @since base-4.9.0.0 Instance detailsDefined in GHC.Internal.Data.Functor.Const Methods(.&.) :: Const a b -> Const a b -> Const a b Source #(.|.) :: Const a b -> Const a b -> Const a b Source #xor :: Const a b -> Const a b -> Const a b Source #complement :: Const a b -> Const a b Source #shift :: Const a b -> Int -> Const a b Source #rotate :: Const a b -> Int -> Const a b Source #zeroBits :: Const a b Source #bit :: Int -> Const a b Source #setBit :: Const a b -> Int -> Const a b Source #clearBit :: Const a b -> Int -> Const a b Source #complementBit :: Const a b -> Int -> Const a b Source #testBit :: Const a b -> Int -> Bool Source #bitSizeMaybe :: Const a b -> Maybe Int Source #bitSize :: Const a b -> Int Source #isSigned :: Const a b -> Bool Source #shiftL :: Const a b -> Int -> Const a b Source #unsafeShiftL :: Const a b -> Int -> Const a b Source #shiftR :: Const a b -> Int -> Const a b Source #unsafeShiftR :: Const a b -> Int -> Const a b Source #rotateL :: Const a b -> Int -> Const a b Source #rotateR :: Const a b -> Int -> Const a b Source #popCount :: Const a b -> Int Source #

class Bits b => FiniteBits b where Source #

The FiniteBits class denotes types with a finite, fixed number of bits.

@since base-4.7.0.0

Minimal complete definition

finiteBitSize

Methods

finiteBitSize :: b -> Int Source #

Return the number of bits in the type of the argument. The actual value of the argument is ignored. Moreover, finiteBitSize is total, in contrast to the deprecated bitSize function it replaces.

finiteBitSize = bitSize
bitSizeMaybe = Just . finiteBitSize


@since base-4.7.0.0

countLeadingZeros :: b -> Int Source #

Count number of zero bits preceding the most significant set bit.

countLeadingZeros (zeroBits :: a) = finiteBitSize (zeroBits :: a)


countLeadingZeros can be used to compute log base 2 via

logBase2 x = finiteBitSize x - 1 - countLeadingZeros x


Note: The default implementation for this method is intentionally naive. However, the instances provided for the primitive integral types are implemented using CPU specific machine instructions.

@since base-4.8.0.0

countTrailingZeros :: b -> Int Source #

Count number of zero bits following the least significant set bit.

countTrailingZeros (zeroBits :: a) = finiteBitSize (zeroBits :: a)
countTrailingZeros . negate = countTrailingZeros


The related find-first-set operation can be expressed in terms of countTrailingZeros as follows

findFirstSet x = 1 + countTrailingZeros x


Note: The default implementation for this method is intentionally naive. However, the instances provided for the primitive integral types are implemented using CPU specific machine instructions.

@since base-4.8.0.0

#### Instances

Instances details
 Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.C.Types Methods Source # Instance detailsDefined in GHC.Internal.Foreign.Ptr Methods Source # Instance detailsDefined in GHC.Internal.Foreign.Ptr Methods Source # @since base-4.6.0.0 Instance detailsDefined in GHC.Internal.Int Methods Source # @since base-4.6.0.0 Instance detailsDefined in GHC.Internal.Int Methods Source # @since base-4.6.0.0 Instance detailsDefined in GHC.Internal.Int Methods Source # @since base-4.6.0.0 Instance detailsDefined in GHC.Internal.Int Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # Instance detailsDefined in GHC.Internal.System.Posix.Types Methods Source # @since base-4.6.0.0 Instance detailsDefined in GHC.Internal.Word Methods Source # @since base-4.6.0.0 Instance detailsDefined in GHC.Internal.Word Methods Source # @since base-4.6.0.0 Instance detailsDefined in GHC.Internal.Word Methods Source # @since base-4.6.0.0 Instance detailsDefined in GHC.Internal.Word Methods Source # @since base-4.7.0.0 Instance detailsDefined in GHC.Internal.Bits Methods Source # @since base-4.6.0.0 Instance detailsDefined in GHC.Internal.Bits Methods Source # @since base-4.6.0.0 Instance detailsDefined in GHC.Internal.Bits Methods FiniteBits a => FiniteBits (And a) Source # @since base-4.16 Instance detailsDefined in GHC.Internal.Data.Bits Methods FiniteBits a => FiniteBits (Iff a) Source # @since base-4.16 Instance detailsDefined in GHC.Internal.Data.Bits Methods FiniteBits a => FiniteBits (Ior a) Source # @since base-4.16 Instance detailsDefined in GHC.Internal.Data.Bits Methods FiniteBits a => FiniteBits (Xor a) Source # @since base-4.16 Instance detailsDefined in GHC.Internal.Data.Bits Methods FiniteBits a => FiniteBits (Identity a) Source # @since base-4.9.0.0 Instance detailsDefined in GHC.Internal.Data.Functor.Identity Methods FiniteBits a => FiniteBits (Down a) Source # @since base-4.14.0.0 Instance detailsDefined in GHC.Internal.Data.Ord Methods FiniteBits a => FiniteBits (Const a b) Source # @since base-4.9.0.0 Instance detailsDefined in GHC.Internal.Data.Functor.Const MethodsfiniteBitSize :: Const a b -> Int Source #countLeadingZeros :: Const a b -> Int Source #

bitDefault :: (Bits a, Num a) => Int -> a Source #

Default implementation for bit.

Note that: bitDefault i = 1 shiftL i

@since base-4.6.0.0

testBitDefault :: (Bits a, Num a) => a -> Int -> Bool Source #

Default implementation for testBit.

Note that: testBitDefault x i = (x .&. bit i) /= 0

@since base-4.6.0.0

popCountDefault :: (Bits a, Num a) => a -> Int Source #

Default implementation for popCount.

This implementation is intentionally naive. Instances are expected to provide an optimized implementation for their size.

@since base-4.6.0.0

toIntegralSized :: (Integral a, Integral b, Bits a, Bits b) => a -> Maybe b Source #

Attempt to convert an Integral type a to an Integral type b using the size of the types as measured by Bits methods.

A simpler version of this function is:

toIntegral :: (Integral a, Integral b) => a -> Maybe b
toIntegral x
| toInteger x == toInteger y = Just y
| otherwise                  = Nothing
where
y = fromIntegral x

This version requires going through Integer, which can be inefficient. However, toIntegralSized is optimized to allow GHC to statically determine the relative type sizes (as measured by bitSizeMaybe and isSigned) and avoid going through Integer for many types. (The implementation uses fromIntegral, which is itself optimized with rules for base types but may go through Integer for some type pairs.)

@since base-4.8.0.0