bit_manipulation.single_bit_manipulation_operations
===================================================

.. py:module:: bit_manipulation.single_bit_manipulation_operations

.. autoapi-nested-parse::

   Provide the functionality to manipulate a single bit.



Functions
---------

.. autoapisummary::

   bit_manipulation.single_bit_manipulation_operations.clear_bit
   bit_manipulation.single_bit_manipulation_operations.flip_bit
   bit_manipulation.single_bit_manipulation_operations.get_bit
   bit_manipulation.single_bit_manipulation_operations.is_bit_set
   bit_manipulation.single_bit_manipulation_operations.set_bit


Module Contents
---------------

.. py:function:: clear_bit(number: int, position: int) -> int

   Set the bit at position to 0.

   Details: perform bitwise and for given number and X.
   Where X is a number with all the bits - ones and bit on given
   position - zero.

   >>> clear_bit(0b10010, 1) # 0b10000
   16
   >>> clear_bit(0b0, 5) # 0b0
   0


.. py:function:: flip_bit(number: int, position: int) -> int

   Flip the bit at position.

   Details: perform bitwise xor for given number and X.
   Where X is a number with all the bits - zeroes and bit on given
   position - one.

   >>> flip_bit(0b101, 1) # 0b111
   7
   >>> flip_bit(0b101, 0) # 0b100
   4


.. py:function:: get_bit(number: int, position: int) -> int

   Get the bit at the given position

   Details: perform bitwise and for the given number and X,
   Where X is a number with all the bits - zeroes and bit on given position - one.
   If the result is not equal to 0, then the bit on the given position is 1, else 0.

   >>> get_bit(0b1010, 0)
   0
   >>> get_bit(0b1010, 1)
   1
   >>> get_bit(0b1010, 2)
   0
   >>> get_bit(0b1010, 3)
   1


.. py:function:: is_bit_set(number: int, position: int) -> bool

   Is the bit at position set?

   Details: Shift the bit at position to be the first (smallest) bit.
   Then check if the first bit is set by anding the shifted number with 1.

   >>> is_bit_set(0b1010, 0)
   False
   >>> is_bit_set(0b1010, 1)
   True
   >>> is_bit_set(0b1010, 2)
   False
   >>> is_bit_set(0b1010, 3)
   True
   >>> is_bit_set(0b0, 17)
   False


.. py:function:: set_bit(number: int, position: int) -> int

   Set the bit at position to 1.

   Details: perform bitwise or for given number and X.
   Where X is a number with all the bits - zeroes and bit on given
   position - one.

   >>> set_bit(0b1101, 1) # 0b1111
   15
   >>> set_bit(0b0, 5) # 0b100000
   32
   >>> set_bit(0b1111, 1) # 0b1111
   15