openGPMP
Open Source Mathematics Package
__init__.py
Go to the documentation of this file.
1 """
2 /*************************************************************************
3  *
4  * Project
5  * __ __ _______ _____ _ __
6  * | \/ |__ __| __ \| |/ /
7  * ___ _ __ ___ _ __ | \ / | | | | |__) | ' /
8  * / _ \| '_ \ / _ \ '_ \| |\/| | | | | ___/| <
9  *| (_) | |_) | __/ | | | | | | | | | | | . \
10  * \___/| .__/ \___|_| |_|_| |_| |_| |_| |_|\_\
11  * | |
12  * |_|
13  *
14  *
15  * Copyright (C) Akiel Aries, <akiel@akiel.org>, et al.
16  *
17  * This software is licensed as described in the file LICENSE, which
18  * you should have received as part of this distribution. The terms
19  * among other details are referenced in the official documentation
20  * seen here : https://akielaries.github.io/openGPMP/ along with
21  * important files seen in this project.
22  *
23  * You may opt to use, copy, modify, merge, publish, distribute
24  * and/or sell copies of the Software, and permit persons to whom
25  * the Software is furnished to do so, under the terms of the
26  * LICENSE file. As this is an Open Source effort, all implementations
27  * must be of the same methodology.
28  *
29  *
30  *
31  * This software is distributed on an AS IS basis, WITHOUT
32  * WARRANTY OF ANY KIND, either express or implied.
33  *
34  ************************************************************************/
35 
36 openGPMP Number Theory Module
37 =============================
38 The Number Theory Module encapsulates methods related to prime numbers as
39 well as cryptography/encryption algorithms.
40 
41 FEATURES :
42  CLASS : Primality
43  - Features methods related to prime numbers
44  METHODS :
45  is_prime
46  miller_rabin
47  jacobian_number
48  solovoy_strassen
49  mod_pow
50  carmichael_num
51  sieve_of_eratosthenes
52  pollard_rho
53  ETF
54 
55  CLASS : RC4
56  - Contains methods related to the Rivest-Cipher encryption algo
57  METHODS :
58  byte_swap
59  trad_swap
60  XOR_swap
61  KSA
62  PRGA
63  store_hash
64  compute
65 
66  CLASS : Cipher
67  - Contains methods related to Caesar Cipher and a Keyword Swap Cipher
68 
69  USAGE :
70  >> import pygpmp
71  >> prime_num = pygpmp.nt.primality.is_prime(2999)
72  OR
73  >> from pygpmp import nt
74 """
75 
76 from pygpmp.nt.nt import (
77  PrimalityTest,
78  PrimalityGen,
79  Factorization,
80  Logarithms,
81  RC4,
82  Cipher,
83 )
84 
85 __all__: list[str]
86 __path__: list[str]
Generated by doxygen 1.9.1