Dowell Permutation API Python Libray
Project description
DoWell-Permutation Python Library
Welcome to the Permutation API! The Permutation API is a comprehensive tool that enables users to generate permutations of a set of items efficiently. It provides a reliable and high-performance solution for permutation calculations, making it ideal for a wide range of applications such as combinatorial optimization, data analysis, and algorithm design.
Installation
- Installing the library
pip install dowell-permutation
- Create an instance of the API
from permutation import Permutation perm = Pemutation()
Features
The Permutation API offers the following key features:
Total Number of Permutations Possible
: this feature calculates the precise count of all the potential permutations based on the provided values of'n'
and'r'
.Exact Permutations
: this feature allows users to find the precise permutations for any given range of'n'
and'r'
. This feature utilizes a specially designed algorithm that ensures accurate and efficient permutation generation.
Note
: 'n'
is total number of items present and 'r'
is the total number of items to be selected from 'r'
.
The library offers three main methods through the instance
- Find permuation
perm.find(n, r, next_variable) """ Generates permutations based on the given parameters. It sends a JSON payload using the provided params :param n: The total number of elements available for permutation :param r: The number of elements to be selected in each permutation :param next_variable: The next variable to be included in the permutation :return: response returns the generated permutation in JSON format. The response body contains the following information: eventId: An event ID associated with the permutation. n: The total number of elements available for permutation. r: The number of elements selected in each permutation. numberOfPermutations: The total number of possible permutations. permutationVariables: An array of arrays, where each inner array represents a permutation with the selected variables. inserted_id: The ID of the inserted permutation. """
- Save Permutation
perm.save(inserted_id, selected_permutations) """ Saves a selected permutation. It sends a JSON payload with the parameters provided :param id: The ID of the permutation to be saved :param selected_permutation: An array of variables representing the selected permutation :return: The response confirms the successful saving of the permutation. The response body contains a success message. """
- Show Permutaion
perm.retrieve(id) """ Retrieves a specific permutation based on its ID :param id: :return: the requested permutation in JSON format. The response body contains the following information: eventId: An event ID associated with the permutation. n: The total number of elements available for permutation. r: The number of elements selected in each permutation. permutationVariables: An array representing the selected permutation. inserted_id: The ID of the permutation. """
More about the API
To get started with the Permutation API, follow these steps:
-
Review the API Documentation to understand the available endpoints, request parameters, and response formats.
-
Make API requests to calculate the total number of permutations possible and to find the exact permutations by providing the
'n'
,'r'
, and the exact values for each item. -
Analyze the returned results, including the number of permutations and the final permutation.
-
Detailed Library Documentation
Example
Here is an example of how you can use the Permutation Library:
- Imagine you have a set of 5 letters: A, B, C, D, and E. You want to generate all possible permutations of these letters by selecting letters. You can use the Permutations API and provide
'n'
as 5 and'r'
as 3 and the letter with which you want start calculating the permutations.my_permutation = perm.find(5,3,'A')
- Once the request is made, the API will process the data and return a response in JSON format. The response will include the total number of possible permutations, along with the generated permutations.
{"eventId": "FB1010000000000000000000003004", "n": 5, "r": 3, "numberOfPermutations": 60, "permutationsVariables": ["A"], "inserted_id": "648963a70d4d6ccff1a7b4a0"}
- You will now need to select one permuation from the generated permutations and call the API again by providing the next letter that you want to include in the permutation.
- Repeat the steps until the 3 letters are selected and permutation for 3 letters is generated.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dowell_permutation-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ecece34e325992ffc57442371443a94fe95cb9417bdeac973f53c231c11f7898 |
|
MD5 | 833b49f4a498453bdf072d01352dd581 |
|
BLAKE2b-256 | d604e9140ee8393fa6d46305b5fe4bdf0bb6e63b0bb2f974b9dc86dd2395dcf4 |