Metadata-Version: 2.1
Name: pcomp
Version: 1.3
Summary: Possible permutations with repetition - Python Library
Home-page: https://github.com/AntonisPilo/pcomp
Author: Antonis Piloridis
Author-email: antonispiloridis@gmail.com
License: MIT
Description: pcomp-1.3:
        A simple library that calculates all possible permutations (with repetition) from an iterator and a length.
        
        Functions:
        valid_arguments:
        
        Check if the arguments are valid.
        
        Parameters:
            iterable (Iterable): The iterable object to be checked.
            length (int): The length to be checked.
        
        Raises:
            TypeError: If iterable is not an Iterable or length is not an Integer or length is not greater than 0.
        
        area:
        
        Calculate the area for permutation computation.
        
        Parameters:
            iterable (Iterable): The iterable object.
            length (int): The length for permutation computation.
        
        Returns:
            int: The area for permutation computation.
        
        pcomp:
        
        Generate permutations of given iterable with specified length.
        
        Parameters:
            iterable (Iterable): The iterable object.
            length (int): The length for permutation computation.
        
        Returns:
            list: List of permutations of the given iterable with the specified length.
        
        Example(hex to binnary):
        Code:
        import pcomp
        print("Area:", pcomp.area(range(2), 4))  # it returns: 16
        print("Permutations with repetition:", pcomp.pc(range(2), 4))  # it returns: [[0, 0, 0, 0], [0, 0, 0, 1], ..., [1, 1, 1, 1]]
        
        The area function returns the total number of possible permutations with repetition.
        And the pcomp function returns a list where each sublist represents one permutation.
        
        Change Log
        ==========
        
        1.3 (18/3/2024)
        -----------------
        - Improved code readability and readme
        
        1.2.1 (28/11/2022)
        -----------------
        - typo
        
        1.2 (28/11/2022)
        -----------------
        - Added error exception for invaide arguments
        
        1.1.1 (22/8/2022)
        -----------------
        - combinations --> permutations with repetition (word replacement due to typo) 
        (I might add combinations in the future + repetition True-False) (The package name will remain the same)
        
        - Version 1.0.2 in the changelog was 2 times (typo)
        
        1.1.0 (19/8/2022)
        -----------------
        - New return form
        - The all function has been renamed to pc
        - Better file organization and function syntax
        
        1.0.2 (10/7/2022)
        -----------------
        - Added github
        
        1.0.1 (10/7/2022)
        -----------------
        - Fixed a problem
        
        1.0.0 (10/7/2022)
        -----------------
        - First Release
Keywords: permutations,permutations with repetition
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: Microsoft :: Windows :: Windows 11
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.3
Description-Content-Type: text/markdown
