Merge pull request #1 from LuciaHarcekova/lz77

Add LZ77 compression algorithm

Author: LuciaHarcekova

compression/lz77.py

@@ -0,0 +1,197 @@
+"""
+LZ77 compression algorithm
+- lossless data compression published in papers by Abraham Lempel and Jacob Ziv in 1977
+- also known as LZ1 or sliding-window compression
+- form the basis for many variations including LZW, LZSS, LZMA and others
+
+It uses a “sliding window” method. Within the sliding window we have:
+  - search buffer
+  - look ahead buffer
+len(sliding_window) = len(search_buffer) + len(look_ahead_buffer)
+
+LZ77 manages a dictionary that uses triples composed of:
+    - Offset into search buffer, it's the distance between the start of a phrase and
+      the beginning of a file.
+    - Length of the match, it's the number of characters that make up a phrase.
+    - The indicator is represented by a character that is going to be encoded next.
+
+As a file is parsed, the dictionary is dynamically updated to reflect the compressed
+data contents and size.
+
+Examples:
+"cabracadabrarrarrad" <-> [(0, 0, 'c'), (0, 0, 'a'), (0, 0, 'b'), (0, 0, 'r'),
+                           (3, 1, 'c'), (2, 1, 'd'), (7, 4, 'r'), (3, 5, 'd')]
+"ababcbababaa" <-> [(0, 0, 'a'), (0, 0, 'b'), (2, 2, 'c'), (4, 3, 'a'), (2, 2, 'a')]
+"aacaacabcabaaac" <-> [(0, 0, 'a'), (1, 1, 'c'), (3, 4, 'b'), (3, 3, 'a'), (1, 2, 'c')]
+
+Sources:
+en.wikipedia.org/wiki/LZ77_and_LZ78
+"""
+
+from typing import List, Tuple
+
+__version__ = '0.1'
+__author__ = 'Lucia Harcekova'
+
+
+class LZ77Compressor:
+    """
+    Class containg compress and decompress methods using LZ77 compression algorithm.
+    """
+
+    def __init__(self, window_size=13, lookahead_buffer_size=6):
+        self.window_size = window_size
+        self.lookahead_buffer_size = lookahead_buffer_size
+        self.search_buffer_size = self.window_size - self.lookahead_buffer_size
+
+    def compress(self, text: str) -> List[Tuple[int, int, str]]:
+        """This method compresses given string text using LZ77 compression algorithm.
+
+        Args:
+            text (str): string that's going to be compressed
+
+        Returns:
+            output (List[Tuple[int, int, str]]): the compressed text
+
+        Tests:
+            >>> lz77_compressor = LZ77Compressor(13, 6)
+            >>> lz77_compressor.compress("ababcbababaa")
+            [(0, 0, 'a'), (0, 0, 'b'), (2, 2, 'c'), (4, 3, 'a'), (2, 2, 'a')]
+            >>> lz77_compressor.compress("aacaacabcabaaac")
+            [(0, 0, 'a'), (1, 1, 'c'), (3, 4, 'b'), (3, 3, 'a'), (1, 2, 'c')]
+        """
+
+        output = []
+        search_buffer = ""
+
+        # while there are still characters in text to compress
+        while text:
+
+            # find the next encoding phrase
+            # - triplet with offset, length, indicator (the next encoding character)
+            (offset, length, indicator) = self._find_encoding_token(
+                text, search_buffer)
+
+            # update the search buffer:
+            # - add new characters from text into it
+            # - check if size exceed the max search buffer size, if so, drop the
+            #   oldest elements
+            search_buffer += text[:length+1]
+            if len(search_buffer) > self.search_buffer_size:
+                search_buffer = search_buffer[-self.search_buffer_size:]
+
+            # update the text
+            text = text[length+1:]
+
+            # append the token to output
+            output.append((offset, length, indicator))
+
+        return output
+
+    def decompress(self, tokens: List[Tuple[int, int, str]]) -> str:
+        """This method turns the list of tokens consisting of triplets of the form
+        (offset, length, char), into an output string.
+
+        Args:
+            tokens (List[Tuple[int, int, str]]): Tokens (offset, length, char)
+
+        Returns:
+            output (str): The decompressed text
+
+        Tests:
+            >>> lz77_compressor = LZ77Compressor(13, 6)
+            >>> lz77_compressor.decompress([(0, 0, 'c'), (0, 0, 'a'), (0, 0, 'b'), \
+                    (0, 0, 'r'), (3, 1, 'c'), (2, 1, 'd'), (7, 4, 'r'), (3, 5, 'd')])
+            'cabracadabrarrarrad'
+            >>> lz77_compressor.decompress([(0, 0, 'a'), (0, 0, 'b'), (2, 2, 'c'), \
+                    (4, 3, 'a'), (2, 2, 'a')])
+            'ababcbababaa'
+            >>> lz77_compressor.decompress([(0, 0, 'a'), (1, 1, 'c'), (3, 4, 'b'), \
+                    (3, 3, 'a'), (1, 2, 'c')])
+            'aacaacabcabaaac'
+        """
+
+        output = ""
+
+        for (offset, length, indicator) in tokens:
+            for _ in range(length):
+                output += output[-offset]
+            output += indicator
+
+        return output
+
+    def _find_encoding_token(self, text: str, search_buffer: str) \
+        -> Tuple[int, int, str]:
+        """Finds the encoding token for the first character in the text.
+
+        Args:
+            text (str)
+            search_buffer (str)
+
+        Returns:
+            Tuple[int, int, str]: Token
+
+        Tests:
+            >>> lz77_compressor = LZ77Compressor(13, 6)
+            >>> lz77_compressor._find_encoding_token("abrarrarrad", "abracad")
+            (7, 4, 'r')
+            >>> lz77_compressor._find_encoding_token("adabrarrarrad", "cabrac")
+            (2, 1, 'd')
+        """
+
+        # Initialise result parameters to default values
+        length, offset = 0, 0
+
+        if search_buffer == "":
+            return offset, length, text[length]
+
+        for i, character in enumerate(search_buffer):
+            found_offset = len(search_buffer) - i
+            if character == text[0]:
+                found_length = self._match_length_from_index(
+                    text, search_buffer, 0, i)
+                # if the found length is bigger than the current or if it's equal,
+                # which means it's offset is smaller: update offset and length
+                if found_length >= length:
+                    offset, length = found_offset, found_length
+
+        return offset, length, text[length]
+
+    def _match_length_from_index(self, text: str,
+        window: str, text_index: int, window_index: int) -> int:
+        """Calculate the longest possible match of text and window characters from
+        text_index in text and window_index in window.
+
+        Args:
+            text (str): _description_
+            window (str): sliding window
+            text_index (int): index of character in text
+            window_index (int): index of character in sliding window
+
+        Returns:
+            int: The maximum match between text and window, from given indexes.
+
+        Tests:
+            >>> lz77_compressor = LZ77Compressor(13, 6)
+            >>> lz77_compressor._match_length_from_index("rarrad", "adabrar", 0, 4)
+            5
+            >>> lz77_compressor._match_length_from_index("adabrarrarrad", \
+                    "cabrac", 0, 1)
+            1
+        """
+        if text == "" or text[text_index] != window[window_index]:
+            return 0
+        return 1 + self._match_length_from_index(text,
+            window + text[text_index], text_index + 1, window_index + 1)
+
+
+if __name__ == '__main__':
+
+    # Initialize compressor class
+    lz77_compressor = LZ77Compressor(window_size=13, lookahead_buffer_size=6)
+
+    # Example
+    TEXT = "cabracadabrarrarrad"
+    compressed_text = lz77_compressor.compress(TEXT)
+    decompressed_text = lz77_compressor.decompress(compressed_text)
+    assert decompressed_text == TEXT, "The LZ77 agirithm returned the invalid result."