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=2,
    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: 2): 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, while division still occurs 1 square prime multiple at a time. (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.7.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.7-cp313-cp313-macosx_15_0_arm64.whl (109.5 kB view details)

Uploaded CPython 3.13macOS 15.0+ ARM64

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

Uploaded CPython 3.13macOS 14.0+ ARM64

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

Uploaded CPython 3.13macOS 13.0+ x86-64

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

Uploaded CPython 3.12Windows x86-64

FindAFactor-4.7.7-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.7-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.7-cp38-cp38-manylinux_2_31_x86_64.whl (134.5 kB view details)

Uploaded CPython 3.8manylinux: glibc 2.31+ x86-64

File details

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

File metadata

  • Download URL: findafactor-4.7.7.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.7.tar.gz
Algorithm Hash digest
SHA256 ede12f66112acece6418bb475faefcf01563266a2ed2a8b3fc39c6a4fef36ab8
MD5 b68e77d46d8a5908f4799356a9b8a94b
BLAKE2b-256 af6f3fa3144bb0aa58711b7fc0337dc21e94a4cd909419e58053233d5d298e6c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for FindAFactor-4.7.7-cp313-cp313-macosx_15_0_arm64.whl
Algorithm Hash digest
SHA256 a71f94dda898a3f661c916cf3f439d5903ff26e8100a0810e6d4f84569914956
MD5 dee7a4b5f7119e9189676562bfa991dd
BLAKE2b-256 a92d59256af8ce5869816463d7493fe332b239240fcc279b4415733586ce0f59

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for FindAFactor-4.7.7-cp313-cp313-macosx_14_0_arm64.whl
Algorithm Hash digest
SHA256 95620bc87da9f0c85e36cbe123efa4fe771231c0e39999728c029e78842ea240
MD5 042b856f352ee7782d130148db119390
BLAKE2b-256 5ee03482c8aded3cca0a28ad45529efa4948cb5d3e97761d875560ea8f275bb4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for FindAFactor-4.7.7-cp313-cp313-macosx_13_0_x86_64.whl
Algorithm Hash digest
SHA256 b8bdc040fa1ec4e70e431558f14236b89a23709ded5383b31b244ce9a738a734
MD5 eff3027787a9a1d7feb5bf04cdf7c3df
BLAKE2b-256 7107ff92da58ea6f7f1043cfd4f87f2f2c5ab357858994a5821074bea9fc2c1b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for FindAFactor-4.7.7-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 706725467da9c7e0646ecb499f13f557dabeda022cf2a53e9eef63c8fbb3a73d
MD5 68b0eef6a44f7774e526491f249e9851
BLAKE2b-256 0f133acd0b4a0c1dc4cb978521017027920da19788005f4e82b30c786ef91b5c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for FindAFactor-4.7.7-cp312-cp312-manylinux_2_39_x86_64.whl
Algorithm Hash digest
SHA256 fd473574aaa80e504bb671ead24238655152569e4ab4be228959eb18c036ae25
MD5 6f671a72cd00953fbbac039f3868ee78
BLAKE2b-256 dfc13821a3df23f8b411677567ebef53067f2347b00bbdb8edc705e8ae697565

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for FindAFactor-4.7.7-cp310-cp310-manylinux_2_35_x86_64.whl
Algorithm Hash digest
SHA256 390582209af0e407086b0a309d94b272c57efc99e6b75f144ab3df5b8d2f8185
MD5 0e96c09a276a4a74801975f2ea8e516e
BLAKE2b-256 a6e98cf6943040e9a76549ca6ebf0d46ea9d3a88978dd6c7cff6c2972889818f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for FindAFactor-4.7.7-cp38-cp38-manylinux_2_31_x86_64.whl
Algorithm Hash digest
SHA256 f329c6a13473f7e6f3507c5c382157fb1769ff7b35fd656563979ad35e135f85
MD5 3c60381f982ab9a7b81bad8025ad2421
BLAKE2b-256 8744bdec9e4ac8d458a89d031f4019cf48cfdb8328b3a4e18036c350d59c3546

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