diffsquare 0.2.1

A fast and efficient implementation of Fermat’s Difference of Squares method in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

# diffsquare

[![Crates.io](https://img.shields.io/crates/v/diffsquare.svg)](https://crates.io/crates/diffsquare)
[![Crates.io Downloads](https://img.shields.io/crates/d/diffsquare.svg)](https://crates.io/crates/diffsquare)
[![Docs.rs](https://docs.rs/diffsquare/badge.svg)](https://docs.rs/diffsquare)
[![License](https://img.shields.io/crates/l/diffsquare)](./LICENSE)

---

## From the Author

This project is authored by [Abhrankan Chakrabarti](https://github.com/Abhrankan-Chakrabarti) and showcases an efficient implementation of Fermat’s Difference of Squares method for factoring large integers. Written in Rust, it leverages the [`malachite`](https://docs.rs/malachite/) crate for high-performance arbitrary-precision arithmetic.

### Key Features

* Support for both decimal and hexadecimal input formats.
* Command-line interface with interactive fallback.
* Optional control over iteration starting point and scientific precision.
* Verbose output in scientific notation for readability of large numbers.
* Quiet mode (`-q`) to suppress prompts and reduce output.
* Execution time displayed after successful factorization.

> GitHub Repository: [Abhrankan-Chakrabarti/diffsquare](https://github.com/Abhrankan-Chakrabarti/diffsquare)

---

## Installation

Install via Cargo:

```bash
cargo install diffsquare
```

Ensure `$HOME/.cargo/bin` is in your `PATH`:

```bash
export PATH="$HOME/.cargo/bin:$PATH"
```

---

## Build Instructions

To build from source:

```bash
git clone https://github.com/Abhrankan-Chakrabarti/diffsquare.git
cd diffsquare
cargo build --release
```

---

## Usage Examples

You can run `diffsquare` interactively or provide flags for automation:

```bash
# Fully interactive: enter modulus, iteration, and precision when prompted
diffsquare

# With a specific modulus (decimal)
diffsquare -n 17976931348623159...

# With a hexadecimal modulus
diffsquare -n 0xDEADBEEF1234567890

# Specify starting iteration
diffsquare -i 1000000

# Use custom precision for scientific notation
diffsquare -p 30

# All options combined
diffsquare -n 0xC0FFEE123456789 -i 1000 -p 25 -q
```

### Command-Line Flags

| Short | Long        | Description                                                      |
| ----- | ----------- | ---------------------------------------------------------------- |
| `-n`  | `--mod`     | Number to factor (supports `0x` for hex, or scientific notation) |
| `-i`  | `--iter`    | Starting iteration value                                         |
| `-p`  | `--prec`    | Precision for verbose scientific output                          |
| `-q`  | `--quiet`   | Suppress prompts and intermediate output                         |
| `-h`  | `--help`    | Show help message                                                |
| `-v`  | `--version` | Show version                                                     |

---

## Recent Update

**feat**: Add quiet mode (`-q`) and show execution time after factorization

---

## Tags

`#RustLang` `#NumberTheory` `#OpenSource` `#BigInteger` `#Cryptography` `#Fermat` `#AbhrankanChakrabarti` `#Malachite`