Skip to main content

Find any nontrivial factor of a number

Project description

FindAFactor

Find any nontrivial factor of a number

Copyright and license

(c) Daniel Strano and the Qrack contributors 2017-2024. All rights reserved.

Installation

From PyPi:

pip3 install FindAFactor

From Source: install pybind11, then

pip3 install .

in the root source directory (with setup.py).

Windows users might find Windows Subsystem Linux (WSL) to be the easier and preferred choice for installation.

Usage

from FindAFactor import find_a_factor

to_factor = 1000

factor = find_a_factor(
    to_factor,
    use_congruence_of_squares=False,
    node_count=1, node_id=0,
    gear_factorization_level=11,
    wheel_factorization_level=7,
    smoothness_bound_multiplier=1.0,
    batch_size_multiplier=0.75
)

The find_a_factor() function should return any nontrivial factor of to_factor (that is, any factor besides 1 or to_factor) if it exists. If a nontrivial factor does not exist (i.e., the number to factor is prime), the function will return 1 or the original to_factor.

  • use_congruence_of_squares (default value: False): This attempts to check congruence of squares with Gaussian elimination for Quadratic Sieve.
  • node_count (default value: 1): FindAFactor can perform factorization in a distributed manner, across nodes, without network communication! When node_count is set higher than 1, the search space for factors is segmented equally per node. If the number to factor is semiprime, and brute-force search is used instead of congruence of squares, for example, all nodes except the one that happens to contain the (unknown) prime factor less than the square root of to_factor will ultimately return 1, while one node will find and return this factor. For best performance, every node involved in factorization should have roughly the same CPU throughput capacity.
  • node_id (default value: 0): This is the identifier of this node, when performing distributed factorization with node_count higher than 1. node_id values start at 0 and go as high as (node_count - 1).
  • gear_factorization_level (default value: 11): This is the value up to which "wheel (and gear) factorization" and trial division are used to check factors and optimize "brute force," in general. The default value of 11 includes all prime factors of 11 and below and works well in general, though significantly higher might be preferred in certain cases.
  • wheel_factorization_level (default value: 7): "Wheel" vs. "gear" factorization balances two types of factorization wheel ("wheel" vs. "gear" design) that often work best when the "wheel" is only a few prime number levels lower than gear factorization. Optimized implementation for wheels is only available up to 13. The primes above "wheel" level, up to "gear" level, are the primes used specifically for "gear" factorization.
  • smoothness_bound_multiplier (default value: 1.0): starting with the first prime number after wheel factorization, the congruence of squares approach (with Quadratic Sieve) takes a default "smoothness bound" with as many distinct prime numbers as bits in the number to factor (for default argument of 1.0 multiplier). To increase or decrease this number, consider it multiplied by the value of smoothness_bound_multiplier.
  • batch_size_multiplier (default value: 0.75): Each 1.0 increment of the multiplier is 2 cycles of gear and wheel factorization, alternating every other cycle between bottom of guessing range and top of guessing range, for every thread in use. However, more than 1.0 batch scale of numbers are processed to produce a 1.0 batch size, so set this close to but somewhat less than a whole number value.

All variables defaults can also be controlled by environment variables:

  • FINDAFACTOR_USE_CONGRUENCE_OF_SQUARES (any value makes True, while default is False)
  • FINDAFACTOR_NODE_COUNT
  • FINDAFACTOR_NODE_ID
  • FINDAFACTOR_GEAR_FACTORIZATION_LEVEL
  • FINDAFACTOR_WHEEL_FACTORIZATION_LEVEL
  • FINDAFACTOR_SMOOTHNESS_BOUND_MULTIPLIER
  • FINDAFACTOR_BATCH_SIZE_MULTIPLIER

Factoring parameter strategy

The developer anticipates this single-function set of parameters, as API, is the absolutely most complicated FindAFactor likely ever needs to get. The only required argument is to_factor, and it just works, for any number that should reasonably take about less than a second to a few minutes. However, if you're running larger numbers for longer than that, of course, it's worth investing 15 to 30 minutes to read the explanation above in the README of every argument and play with the settings, a little. But, with these options, you have total control to tune the algorithm in any all ways necessary to adapt to system resource footprint.

Advantage for use_congruence_of_squares is beyond the hardware scale of the developer's experiments, in practicality, but it can be shown to work correctly (at disadvantage, at small factoring bit-width scales). The anticipated use case is to turn this option on when approaching the size of modern-day RSA semiprimes in use.

If this is your use case, you want to specifically consider smoothness_bound_multiplier, batch_size_multiplier, and potentially thread_count for managing memory. By default, as many primes are kept for "smooth" number sieving as bits in the number to factor. This is multiplied by smooth_bound_multiplier (and cast to a discrete number of primes in total). This multiplier tends to predominate memory, but batch_size_multiplier can also cause problems if set too high or low, as a high value might exhaust memory, while a low value increases potentially nonproductive Gaussian elimination checks, which might be more efficient if batched higher. Our expectation is that most systems will benefit from setting batch_size_multiplier much higher than default, potentially to the point of using about half of available memory, but this will require user experimentation to determine.

wheel_factorization_level and gear_factorization_level are common to both use_congruence_of_squares (i.e., Gaussian elimination for perfect squares) and "brute force." 11 for gear and 5 for wheel limit works well for small numbers. You'll definitely want to consider (gear/wheel) 13/7 or 17/11 (or even other values, maybe system-dependent) as your numbers to factor approach cryptographic relevance.

As for node_count and node_id, believe it or not, factoring parallelism can truly be that simple: just run different node IDs in the set on different (roughly homogenous) isolated CPUs, without networking. The only caveat is that you must manually detect when any single node has found an answer (which is trivial to verify) and manually interrupt other nodes still working (or leave them to complete on their own).

About

This library was originally called "Qimcifa" and demonstrated a (Shor's-like) "quantum-inspired" algorithm for integer factoring. It has since been developed into a general factoring algorithm and tool.

FindAFactor uses heavily wheel-factorized brute-force "exhaust" numbers as "smooth" inputs to Quadratic Sieve, widely regarded as the asymptotically second fastest algorithm class known for cryptographically relevant semiprime factoring. Actually, the primary difference between Quadratic Sieve (QS, regarded second-fastest) and General Number Field Sieve (GNFS, fastest) is based in how "smooth" numbers are generated as intermediate inputs to Gaussian elimination, and the "brute-force exhaust" of Qimcifa provides smooth numbers rather than canonical polynomial generators for QS or GNFS, so whether FindAFactor is theoretically fastest depends on how good its smooth number generation is (which is an open question). FindAFactor is C++ based, with pybind11, which tends to make it faster than pure Python approaches. For the quick-and-dirty application of finding any single nontrivial factor, something like at least 80% of positive integers will factorize in a fraction of a second, but the most interesting cases to consider are semiprime numbers, for which FindAFactor should be about as asymptotically competitive as similar Quadratic Sieve implementations.

Our original contribution to Quadratic Sieve seems to be wheel factorization to 13 or 17 and maybe the idea of using the "exhaust" of a brute-force search for smooth number inputs for Quadratic Sieve. For wheel factorization (or "gear factorization"), we collect a short list of the first primes and remove all of their multiples from a "brute-force" guessing range by mapping a dense contiguous integer set, to a set without these multiples, relying on both a traditional "wheel," up to a middle prime number (of 11), and a "gear-box" that stores increment values per prime according to the principles of wheel factorization, but operating semi-independently, to reduce space of storing the full wheel.

Beyond this, we gain a functional advantage of a square-root over a more naive approach, by setting the brute force guessing range only between the highest prime in wheel factorization and the (modular) square root of the number to factor: if the number is semiprime, there is exactly one correct answer in this range, but including both factors in the range to search would cost us the square root advantage.

Factoring this way is surprisingly easy to distribute: basically 0 network communication is needed to coordinate an arbitrarily high amount of parallelism to factor a single number. Each brute-force trial division instance is effectively 100% independent of all others (i.e. entirely "embarrassingly parallel"), and these guesses can seed independent Gaussian elimination matrices, so FindAFactor offers an extremely simply interface that allows work to be split between an arbitrarily high number of nodes with absolutely no network communication at all. In terms of incentives of those running different, cooperating nodes in the context of this specific number of integer factoring, all one ultimately cares about is knowing the correct factorization answer by any means. For pratical applications, there is no point at all in factoring a number whose factors are already known. When a hypothetical answer is forwarded to the (0-communication) "network" of collaborating nodes, it is trivial to check whether the answer is correct (such as by simply entering the multiplication and equality check with the original number into a Python shell console)! Hence, collaborating node operators only need to trust that all participants in the "network" are actually performing their alloted segment of guesses and would actually communicate the correct answer to the entire group of collaborating nodes if any specific invidual happened to find the answer, but any purported answer is still trivial to verify.

Special thanks to OpenAI GPT "Elara," for indicated region of contributed code!

Project details


Release history Release notifications | RSS feed

This version

3.2.4

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

findafactor-3.2.4.tar.gz (38.2 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

FindAFactor-3.2.4-cp313-cp313-macosx_15_0_arm64.whl (311.0 kB view details)

Uploaded CPython 3.13macOS 15.0+ ARM64

FindAFactor-3.2.4-cp313-cp313-macosx_14_0_arm64.whl (315.7 kB view details)

Uploaded CPython 3.13macOS 14.0+ ARM64

FindAFactor-3.2.4-cp313-cp313-macosx_13_0_x86_64.whl (317.9 kB view details)

Uploaded CPython 3.13macOS 13.0+ x86-64

FindAFactor-3.2.4-cp312-cp312-win_amd64.whl (154.3 kB view details)

Uploaded CPython 3.12Windows x86-64

FindAFactor-3.2.4-cp312-cp312-manylinux_2_39_x86_64.whl (1.8 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.39+ x86-64

FindAFactor-3.2.4-cp310-cp310-manylinux_2_35_x86_64.whl (1.8 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.35+ x86-64

FindAFactor-3.2.4-cp38-cp38-manylinux_2_31_x86_64.whl (2.0 MB view details)

Uploaded CPython 3.8manylinux: glibc 2.31+ x86-64

File details

Details for the file findafactor-3.2.4.tar.gz.

File metadata

  • Download URL: findafactor-3.2.4.tar.gz
  • Upload date:
  • Size: 38.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.3

File hashes

Hashes for findafactor-3.2.4.tar.gz
Algorithm Hash digest
SHA256 d9fac935cd34864618a4031783b83c57565c202bda631fb08dfe2d53b7403635
MD5 a51a09fec4a6e242de42295092bc6bb1
BLAKE2b-256 f56ece91cd16f6a5facfcf07b322e9c04efaba56a6ebe75f2b81ae95a9df5345

See more details on using hashes here.

File details

Details for the file FindAFactor-3.2.4-cp313-cp313-macosx_15_0_arm64.whl.

File metadata

File hashes

Hashes for FindAFactor-3.2.4-cp313-cp313-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 fdbd547b18060e5d0590f868f1a6e7ca3ff54230c48e3d90180da01522213b67
MD5 72c3fe22e84e117960937bed98fcfc0c
BLAKE2b-256 bb773f84ff3d6dd4e7c9d67116050afd77eac1d13c01413a04ec7237b1bbceb5

See more details on using hashes here.

File details

Details for the file FindAFactor-3.2.4-cp313-cp313-macosx_14_0_arm64.whl.

File metadata

File hashes

Hashes for FindAFactor-3.2.4-cp313-cp313-macosx_14_0_arm64.whl
Algorithm Hash digest
SHA256 cf4917ba28ae7462e5bdeb34d185eeed731ac0e64f04362e50c0ab9173da7761
MD5 13d90dc1f5e525fefc33205bf9e8aeec
BLAKE2b-256 f9ced7a68fe076c28d7884c718c03fd81c4efe847c555b2c502bd6fe22691ae4

See more details on using hashes here.

File details

Details for the file FindAFactor-3.2.4-cp313-cp313-macosx_13_0_x86_64.whl.

File metadata

File hashes

Hashes for FindAFactor-3.2.4-cp313-cp313-macosx_13_0_x86_64.whl
Algorithm Hash digest
SHA256 f4838bd2d68cf451f0e2f2977842f99d6233936b6e256a884efb8438b64a5fa4
MD5 3ae51190aec004a4ff08425ab9a2dcd6
BLAKE2b-256 07b97939cc8b9007e395dac884c606d4a2f52f2102a60072bc94b06e4cb6c110

See more details on using hashes here.

File details

Details for the file FindAFactor-3.2.4-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for FindAFactor-3.2.4-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 1ee3f6392faa6d361d919af45bb08f868d131e7dfe382e38c21b75874dae78ca
MD5 5e733c50805fb8f61f0e43af91dcdc43
BLAKE2b-256 964a9da01a54bee660832792c82144b652026d37dee612c9801b9ca345d51e3a

See more details on using hashes here.

File details

Details for the file FindAFactor-3.2.4-cp312-cp312-manylinux_2_39_x86_64.whl.

File metadata

File hashes

Hashes for FindAFactor-3.2.4-cp312-cp312-manylinux_2_39_x86_64.whl
Algorithm Hash digest
SHA256 5e918fd9d9861360d13e4b95e29424518f4e002d100a77356881a887573a18ac
MD5 3c8e122d261a4da92a553813af923160
BLAKE2b-256 ec938bad4336886270bb6ac3dfd6ead15edf7119bb3deca66432f4eec5c8ea20

See more details on using hashes here.

File details

Details for the file FindAFactor-3.2.4-cp310-cp310-manylinux_2_35_x86_64.whl.

File metadata

File hashes

Hashes for FindAFactor-3.2.4-cp310-cp310-manylinux_2_35_x86_64.whl
Algorithm Hash digest
SHA256 9b33aefd614936f5bf0afcbaba2e9fd70820717197f90d59fa09cb6a41b25206
MD5 0fcdcdfb4efee556a6793331a492ae95
BLAKE2b-256 526ebcb8b57e35680ad953f3496033b292287e3ee742df05f5948913474c0056

See more details on using hashes here.

File details

Details for the file FindAFactor-3.2.4-cp38-cp38-manylinux_2_31_x86_64.whl.

File metadata

File hashes

Hashes for FindAFactor-3.2.4-cp38-cp38-manylinux_2_31_x86_64.whl
Algorithm Hash digest
SHA256 08fa0be82b903d530dc568169a898d47fe62445d111053d82ab37cce5402ebd4
MD5 29017df64ea87f6035000667b8395a2d
BLAKE2b-256 baef2a02c9e6a40f08141036b7c726d5f7166008565849b99c32636b84dd9813

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page