/PrimePy

Just fooling around with prime numbers.

Primary LanguagePython

#PrimePy

This is just a repository for me to mess around with prime numbers.

##Documentation

It is extremely easy to use PrimePy.

First make sure you import PrimePy:

# To put all PrimePy variables in global scope (dangerous)
from prime import *

# To keep everything namespaced under prime (safe)
import prime

isPrime

Used to check if a number is prime or not.

Args: (num)

ArgsType: (int)

  • @num: The number you want to check.
>>> isPrime(4)
False
>>> isPrime(7)
True

checkAll

Runs the isPrime method on every number in the specified range. Be careful not to put a range too large or your terminal/application may crash.

Args: (start, finish, [watch])

ArgsType: (int, int, [bool])

  • @start: The starting number for your check. (included)
  • @finish: The ending number for your checks. (included)
  • @watch: Set to true if you'd like to watch the process in the terminal window. Defaults to False.
>>> checkAll(3,5)
[[3, true], [4, false], [5, true]]

primeChoice

Returns a prime number which matches the size specified by the user. Really large numbers return a long integer which is denoted by an uppercase L at the end of the returned number. You can see an example below.

Args: (size=[default 5])

ArgsType: (int)

  • @size: The length you want your prime number to be. (default is 5)
>>>primeChoice(10)
3038527469

>>>primeChoice(100)
6103143511541228984402255519885099367572625065625579423598295162581554697203955830436556551892238347L

display

Accepts a checkAll formatted list and beautifies it for the terminal.

>>> check = checkAll(3,5)
>>> display(check) # Check output in terminal window

bigPrime

Returns a large prime number.

>>> bigPrime()
208076533816577

##Tests

To run tests, navigate to the prime directory in your terminal and execute the following command:

$ python tests.py