From 1b5c1b8344107cabcc7702194d37db8aabb6a525 Mon Sep 17 00:00:00 2001
From: Phil Bazun <Phil9lne@gmail.com>
Date: Sun, 25 Oct 2020 10:24:35 +0100
Subject: [PATCH] Add single bit manipulation operations. (#3284)

* Add single bit manipuation operations.

* fixup! Add single bit manipuation operations.

* Change wording.
---
 .../single_bit_manipulation_operations.py     | 80 +++++++++++++++++++
 1 file changed, 80 insertions(+)
 create mode 100644 bit_manipulation/single_bit_manipulation_operations.py

diff --git a/bit_manipulation/single_bit_manipulation_operations.py b/bit_manipulation/single_bit_manipulation_operations.py
new file mode 100644
index 000000000..114eafe32
--- /dev/null
+++ b/bit_manipulation/single_bit_manipulation_operations.py
@@ -0,0 +1,80 @@
+#!/usr/bin/env python3
+
+"""Provide the functionality to manipulate a single bit."""
+
+
+def set_bit(number: int, position: 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
+    """
+    return number | (1 << position)
+
+
+def clear_bit(number: int, position: 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
+    """
+    return number & ~(1 << position)
+
+
+def flip_bit(number: int, position: 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
+    """
+    return number ^ (1 << position)
+
+
+def 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
+    """
+    return ((number >> position) & 1) == 1
+
+
+if __name__ == "__main__":
+    import doctest
+
+    doctest.testmod()