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-2025. 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, FactoringMethod

to_factor = 1000

factor = find_a_factor(
    to_factor,
    method=FactoringMethod.PRIME_SOLVER,
    node_count=1, node_id=0,
    trial_division_level=2**20,
    gear_factorization_level=11,
    wheel_factorization_level=11,
    smoothness_bound_multiplier=1.0,
    batch_size_multiplier=256.0,
    batch_size_variance=3,
    ladder_multiple=5
)

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.

  • method (default value: PRIME_SOLVER/0): PRIME_SOLVER/0 will prove that a number is prime (by failing to find any factors with wheel and gear factorization). FACTOR_FINDER/1 is optimized for the assumption that the number has at least two nontrivial factors.
  • 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).
  • trial_division_level (default value: 2**20): Trial division is carried out as a preliminary round for all primes up this number. If you need more primes for your smoothness bound, increase this level.
  • 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: 11): "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) has a "smoothness bound" unit with as many distinct prime numbers as bits in the number to factor (for 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: 256.0): For FACTOR_FINDER/1 method, each 1.0 increment of the multiplier adds k ln k Markov mixing replacement steps for k count of smooth primes, before reseeding Monte Carlo.
  • batch_size_variance (default value: 3): For FACTOR_FINDER/1 method, k ln k is the right proportionality for a Markov mixing process, but a linear factor in front is hard to predict. As such, it can be useful to dynamically vary the batch size, as if to cover and amortize the cost of several different batch sizes at once. In sequence, each batch size will be multiplied by 2 ** i for i in range(batch_size_variance), repeating from 0.
  • ladder_multiple (default value: 5): Controls how many times randomly-selected square prime multiplication is repeated with the same square prime per random selection, in ascending a "ladder" of smooth perfect squares. (Any smooth perfect square can be multiplied by any square prime in the factor base, or any other smooth perfect square, and produce a different smooth perfect square.)

All variables defaults can also be controlled by environment variables:

  • FINDAFACTOR_METHOD (integer value)
  • FINDAFACTOR_NODE_COUNT
  • FINDAFACTOR_NODE_ID
  • FINDAFACTOR_TRIAL_DIVISION_LEVEL
  • FINDAFACTOR_GEAR_FACTORIZATION_LEVEL
  • FINDAFACTOR_WHEEL_FACTORIZATION_LEVEL
  • FINDAFACTOR_SMOOTHNESS_BOUND_MULTIPLIER
  • FINDAFACTOR_BATCH_SIZE_MULTIPLIER
  • FINDAFACTOR_BATCH_SIZE_VARIANCE

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

Download files

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

Source Distribution

findafactor-4.7.6.tar.gz (7.3 kB view details)

Uploaded Source

Built Distributions

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

FindAFactor-4.7.6-cp313-cp313-macosx_15_0_arm64.whl (109.5 kB view details)

Uploaded CPython 3.13macOS 15.0+ ARM64

FindAFactor-4.7.6-cp313-cp313-macosx_14_0_arm64.whl (110.2 kB view details)

Uploaded CPython 3.13macOS 14.0+ ARM64

FindAFactor-4.7.6-cp313-cp313-macosx_13_0_x86_64.whl (124.5 kB view details)

Uploaded CPython 3.13macOS 13.0+ x86-64

FindAFactor-4.7.6-cp312-cp312-win_amd64.whl (144.8 kB view details)

Uploaded CPython 3.12Windows x86-64

FindAFactor-4.7.6-cp312-cp312-manylinux_2_39_x86_64.whl (133.0 kB view details)

Uploaded CPython 3.12manylinux: glibc 2.39+ x86-64

FindAFactor-4.7.6-cp310-cp310-manylinux_2_35_x86_64.whl (142.7 kB view details)

Uploaded CPython 3.10manylinux: glibc 2.35+ x86-64

FindAFactor-4.7.6-cp38-cp38-manylinux_2_31_x86_64.whl (134.4 kB view details)

Uploaded CPython 3.8manylinux: glibc 2.31+ x86-64

File details

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

File metadata

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

File hashes

Hashes for findafactor-4.7.6.tar.gz
Algorithm Hash digest
SHA256 31959232176801f64b14ca54326ee999e78578876eeffe2ab4820dbc77731836
MD5 523d7e484078bbadabb70e621ce08da9
BLAKE2b-256 cdcea97f145ecf56e8649bd1df812f9d8ca4adeef6f63883b318b1905cd9c7e5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for FindAFactor-4.7.6-cp313-cp313-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 27588e0fd187a2011c2cf7534bfeac819bbf9e7acb912f9496cfb939b69fecf4
MD5 cfc552553040b370d9375b424d18af40
BLAKE2b-256 043696973f87dd64197075eb0b1cab4d58eac0c48f473ced799ff3753e63991d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for FindAFactor-4.7.6-cp313-cp313-macosx_14_0_arm64.whl
Algorithm Hash digest
SHA256 e3c4edd88b331274d41945b9acc076345397cec912c47a60ce142fbece1fdd7d
MD5 18b9d4f2e0f108223579fb4e506664c1
BLAKE2b-256 a9c83315590d9510e790a487bc86b973734ae8fb3da7d777db71c8e7b4cefc8b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for FindAFactor-4.7.6-cp313-cp313-macosx_13_0_x86_64.whl
Algorithm Hash digest
SHA256 3b91e5850a171fbac49e65a49566bb2357908bcad4a6f6bfd24dc9e2ac19ee6d
MD5 a821be6a36808ea6c75dbe279a4a46b7
BLAKE2b-256 341307ce0e733bedceff2c4f921ecd2bcfb22416ef54b0628b1ceaa8c498c6d1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for FindAFactor-4.7.6-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 d6109b90c002d9949333ec5842e8d9f9915fae00f381192beadfe7e2a27cbda3
MD5 ed8938b1237f6079b9f0d746dbbdae87
BLAKE2b-256 bf2030572667c5128a82adc8dc383de0f4c1af090103dbbd79ecb6c2b4bc70e0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for FindAFactor-4.7.6-cp312-cp312-manylinux_2_39_x86_64.whl
Algorithm Hash digest
SHA256 e819071737fd29019a40eb87d6663a165a2e2d3ff01323670fc1d2c561fa50ec
MD5 cca62c92996192317a08a7abe2d23bb7
BLAKE2b-256 f9c6bd93dc40c9ca10ea02852857746870da38252328a6a3b75ce3866f0f5352

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for FindAFactor-4.7.6-cp310-cp310-manylinux_2_35_x86_64.whl
Algorithm Hash digest
SHA256 bbc18d4258d8d896c6ea001cc06cdd1034ea267d6d1d0a2a36ddedeec29ac308
MD5 b59c95f9ee4fec3aee5ca0964f5a7bc3
BLAKE2b-256 3ecdf081fe14599f808091f7c3b68d8fdb3c9198527acaec1e6349974c56a2d7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for FindAFactor-4.7.6-cp38-cp38-manylinux_2_31_x86_64.whl
Algorithm Hash digest
SHA256 735eb5260447bb9e6293d9ca9493d71496dc912a94c58d339ca4d71ab1d50641
MD5 dff9bd462a4070090d49c8c1874553ce
BLAKE2b-256 292fd2dbc4767560f09764ee09fec7a64dfb722c0bf3560560c210b93c50ccfd

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