Skip to content

Software101DotNet/PrimeFactor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Prime Factor

A command line tool for assisting number theory research, teaching and cryptography subjects.
Runs on Windows, macOS and Linux. Native support for x64 and ARM platforms

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Prime Factor

A command line tool for assisting number theory research, teaching and cryptography subjects:

  • Factoring a composite given number into its prime factors
  • Generating a series of prime numbers of a given range from 1 to 18,446,744,073,709,551,616.
  • Calculate the Greatest Common Divisor for a given series of numbers

Built With

  • Dot Net 9
  • VS Code

Getting Started

  • Install DotNet if your platform does not already have it.
  • Clone this repo.
  • Build the project.
  • Run "./PrimeFactor --help" for usage instructions.

Prerequisites

Install DotNet 9.0 for the platform Windows, macOS or Linux. Intel x64 and Apple Silicon support.

If unsure if Dot Net is install or which version you already have, then open a terminal and run the following command.

dotnet --version

Download and install from:

https://dotnet.microsoft.com/en-us/download

Installation

  1. Clone the project's repository
    git clone https://github.com/Software101DotNet/PrimeFactor.git
  2. Build the project
    dotnet build -c Release PrimeFactor/PrimeFactor.csproj
  3. Optionally, run the project's unit tests. Optionally, build the debug version and run the project's unit tests. Depending on the computer, these tests can take a few seconds to several minutes. In the unlikely event that any tests fail, please create a new issue ticket.
    dotnet build -c debug PrimeFactor.sln
    dotnet test xUnitTests/bin/Debug/net9.0/xUnitTests.dll

Usage

For upto date usage, Run

./PrimeFactor --help 

Roadmap

  • [completed v1.0] Prime factoring of given number
  • [completed v1.0] Prime number series generation
    • [Complated v1.0] support for directing output to a file stream. Usesful for very large series generation.
  • [ v2 ] Support for Greatest Common Divisor
  • [ v3 ] Support for Perfect Numbers
  • [ v4 ] Support for number range 1 to 340,282,366,920,938,463,463,374,607,431,768,211,455 (2^128 bits)

See the open issues for a full list of proposed features (and known issues).

Contributing

If you have any additions or improvements that would make this project better, please fork the repository and create a pull request. You can also simply open an issue with the tag "enhancement". Thanks.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Anthony Ransley - software101.net@gmail.com

Project Link: https://github.com/Software101DotNet/PrimeFactor

Acknowledgments

About

A command line tool for factorising composite numbers into primes.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages