overfloat 0.1.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- overfloat-0.1.2/LICENSE +201 -0
- overfloat-0.1.2/PKG-INFO +159 -0
- overfloat-0.1.2/README.md +132 -0
- overfloat-0.1.2/native-src/Overfloat.csproj +37 -0
- overfloat-0.1.2/native-src/VERSION +1 -0
- overfloat-0.1.2/native-src/include/overfloat.h +46 -0
- overfloat-0.1.2/native-src/src/Overfloat/BigIntegerExtensions.cs +44 -0
- overfloat-0.1.2/native-src/src/Overfloat/Native/OverfloatExports.cs +306 -0
- overfloat-0.1.2/native-src/src/Overfloat/OverfloatBitConverter.cs +162 -0
- overfloat-0.1.2/native-src/src/Overfloat/OverfloatClassification.cs +10 -0
- overfloat-0.1.2/native-src/src/Overfloat/OverfloatEnvironment.cs +16 -0
- overfloat-0.1.2/native-src/src/Overfloat/OverfloatExceptionFlags.cs +12 -0
- overfloat-0.1.2/native-src/src/Overfloat/OverfloatFormatting.cs +62 -0
- overfloat-0.1.2/native-src/src/Overfloat/OverfloatHandleHelpers.cs +36 -0
- overfloat-0.1.2/native-src/src/Overfloat/OverfloatInfo.cs +36 -0
- overfloat-0.1.2/native-src/src/Overfloat/OverfloatMath.cs +374 -0
- overfloat-0.1.2/native-src/src/Overfloat/OverfloatNumber.cs +158 -0
- overfloat-0.1.2/native-src/src/Overfloat/OverfloatParsing.cs +145 -0
- overfloat-0.1.2/native-src/src/Overfloat/OverfloatRoundingMode.cs +10 -0
- overfloat-0.1.2/native-src/src/Overfloat/OverfloatSpecification.cs +97 -0
- overfloat-0.1.2/native-src/src/Overfloat/OverfloatStatus.cs +11 -0
- overfloat-0.1.2/native-src/src/Overfloat/OverfloatValidation.cs +19 -0
- overfloat-0.1.2/native-src/src/Overfloat/Rational.cs +63 -0
- overfloat-0.1.2/native-src/src/Overfloat/Utf8Helpers.cs +38 -0
- overfloat-0.1.2/overfloat/__init__.py +383 -0
- overfloat-0.1.2/overfloat.egg-info/PKG-INFO +159 -0
- overfloat-0.1.2/overfloat.egg-info/SOURCES.txt +11 -0
- overfloat-0.1.2/overfloat.egg-info/dependency_links.txt +1 -0
- overfloat-0.1.2/overfloat.egg-info/top_level.txt +1 -0
- overfloat-0.1.2/pyproject.toml +40 -0
- overfloat-0.1.2/setup.cfg +4 -0
- overfloat-0.1.2/setup.py +151 -0
overfloat-0.1.2/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
overfloat-0.1.2/PKG-INFO
ADDED
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: overfloat
|
|
3
|
+
Version: 0.1.2
|
|
4
|
+
Summary: Python bindings for the Overfloat native floating-point runtime
|
|
5
|
+
Author: Overfloat Contributors
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/overfloat/overfloat
|
|
8
|
+
Project-URL: Repository, https://github.com/overfloat/overfloat
|
|
9
|
+
Project-URL: Issues, https://github.com/overfloat/overfloat/issues
|
|
10
|
+
Keywords: floating-point,ieee-754,native,ctypes,arbitrary-precision
|
|
11
|
+
Classifier: Development Status :: 3 - Alpha
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Operating System :: Microsoft :: Windows
|
|
14
|
+
Classifier: Operating System :: MacOS
|
|
15
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
22
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
23
|
+
Requires-Python: >=3.9
|
|
24
|
+
Description-Content-Type: text/markdown
|
|
25
|
+
License-File: LICENSE
|
|
26
|
+
Dynamic: license-file
|
|
27
|
+
|
|
28
|
+
# overfloat
|
|
29
|
+
|
|
30
|
+
Overfloat is an IEEE 754-oriented arbitrary-precision floating-point runtime with Python bindings. The Python package installs like a normal Python dependency while loading a bundled native library through `ctypes`.
|
|
31
|
+
|
|
32
|
+
Use it when you want custom floating-point formats without manually wiring up a native shared library.
|
|
33
|
+
|
|
34
|
+
Highlights:
|
|
35
|
+
|
|
36
|
+
- install with `pip install overfloat`
|
|
37
|
+
- native library bundled in the wheel
|
|
38
|
+
- custom exponent and mantissa widths
|
|
39
|
+
- convenient IEEE-style presets for 16, 32, 64, and 128 total bits
|
|
40
|
+
- decimal parsing, exact formatting, arithmetic, comparisons, classifications, and bit-pattern round trips
|
|
41
|
+
|
|
42
|
+
## Install
|
|
43
|
+
|
|
44
|
+
Install from PyPI:
|
|
45
|
+
|
|
46
|
+
```powershell
|
|
47
|
+
pip install overfloat
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
If `pip` is not on `PATH`, use `python -m pip install overfloat` instead.
|
|
51
|
+
|
|
52
|
+
The PyPI wheels bundle the native Overfloat shared library for the target platform.
|
|
53
|
+
|
|
54
|
+
Use the wheel files attached to GitHub Releases only when you need manual downloads, offline installation, or release troubleshooting. The release workflow builds wheels for Python 3.9, 3.10, 3.11, 3.12, and 3.13.
|
|
55
|
+
|
|
56
|
+
Typical wheel names:
|
|
57
|
+
|
|
58
|
+
- Windows: `overfloat-<version>-cp<python>-cp<python>-win_amd64.whl`
|
|
59
|
+
- Linux: `overfloat-<version>-cp<python>-cp<python>-manylinux_..._x86_64.whl`
|
|
60
|
+
- macOS: `overfloat-<version>-cp<python>-cp<python>-macosx_11_0_arm64.whl`
|
|
61
|
+
|
|
62
|
+
For example, Python 3.9 uses `cp39`, Python 3.10 uses `cp310`, Python 3.11 uses `cp311`, Python 3.12 uses `cp312`, and Python 3.13 uses `cp313`.
|
|
63
|
+
|
|
64
|
+
## Usage
|
|
65
|
+
|
|
66
|
+
The default path is intentionally simple: import the library, create a format, then create numbers from strings or Python numeric values.
|
|
67
|
+
|
|
68
|
+
```python
|
|
69
|
+
from overfloat import OverfloatLibrary
|
|
70
|
+
|
|
71
|
+
lib = OverfloatLibrary()
|
|
72
|
+
spec = lib.create_spec_from_total_bits(32)
|
|
73
|
+
|
|
74
|
+
a = spec("1.5")
|
|
75
|
+
b = spec("2.25")
|
|
76
|
+
|
|
77
|
+
print(a + b)
|
|
78
|
+
print(a * b)
|
|
79
|
+
print(spec("1") / spec("10"))
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
`OverfloatLibrary()` loads the bundled native library by default. You can also pass an explicit shared library path.
|
|
83
|
+
|
|
84
|
+
The Python package version is exposed as `overfloat.__version__`.
|
|
85
|
+
|
|
86
|
+
## Advanced Usage
|
|
87
|
+
|
|
88
|
+
```python
|
|
89
|
+
import overfloat
|
|
90
|
+
from overfloat import OverfloatLibrary
|
|
91
|
+
|
|
92
|
+
lib = OverfloatLibrary()
|
|
93
|
+
spec = lib.create_spec_from_total_bits(4096)
|
|
94
|
+
manual_spec = lib.create_spec(43, 4048)
|
|
95
|
+
|
|
96
|
+
a = spec("1.5")
|
|
97
|
+
b = spec("2.25")
|
|
98
|
+
manual_value = manual_spec("1.5")
|
|
99
|
+
|
|
100
|
+
print(lib.version)
|
|
101
|
+
print(overfloat.__version__)
|
|
102
|
+
print(spec.exponent_bits)
|
|
103
|
+
print(spec.mantissa_bits)
|
|
104
|
+
print(a + b)
|
|
105
|
+
print(a * b)
|
|
106
|
+
print(spec("1") / spec("10"))
|
|
107
|
+
print(manual_spec.exponent_bits)
|
|
108
|
+
print(manual_spec.mantissa_bits)
|
|
109
|
+
print(manual_value)
|
|
110
|
+
print(a.to_bits_hex())
|
|
111
|
+
print(spec.from_bits_hex(a.to_bits_hex()))
|
|
112
|
+
print(a.compare(b))
|
|
113
|
+
print(a.compare_total(b))
|
|
114
|
+
print(lib.exception_flags)
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
`create_spec_from_total_bits(total_bits)` is the convenient preset form.
|
|
118
|
+
|
|
119
|
+
`create_spec(exponent_bits, mantissa_bits)` is the manual form when the exponent width and mantissa width need to be set directly.
|
|
120
|
+
|
|
121
|
+
Built-in preset formats:
|
|
122
|
+
|
|
123
|
+
- `16` -> exponent `5`, mantissa `10`
|
|
124
|
+
- `32` -> exponent `8`, mantissa `23`
|
|
125
|
+
- `64` -> exponent `11`, mantissa `52`
|
|
126
|
+
- `128` -> exponent `15`, mantissa `112`
|
|
127
|
+
|
|
128
|
+
These preset values match the IEEE 754 standard formats. For IEEE 754-2008 interchange-style formats with `k >= 128` and `k` a multiple of `32`, `create_spec_from_total_bits(k)` follows the standard width derivation.
|
|
129
|
+
|
|
130
|
+
For explicit lifetime management:
|
|
131
|
+
|
|
132
|
+
```python
|
|
133
|
+
from overfloat import OverfloatLibrary
|
|
134
|
+
|
|
135
|
+
lib = OverfloatLibrary()
|
|
136
|
+
|
|
137
|
+
with lib.create_spec_from_total_bits(4096) as spec:
|
|
138
|
+
with spec("1.5") as value:
|
|
139
|
+
print(value)
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
## Manual Builds
|
|
143
|
+
|
|
144
|
+
The prebuilt wheels are the recommended installation path. The source distribution can also build a platform native library during installation, but that path requires the .NET 8 SDK and a platform toolchain supported by .NET Native AOT.
|
|
145
|
+
|
|
146
|
+
If you are building this repository manually, build or copy the platform native library into `overfloat/` before creating a wheel or loading the package with `OverfloatLibrary()`.
|
|
147
|
+
|
|
148
|
+
Windows example:
|
|
149
|
+
|
|
150
|
+
```powershell
|
|
151
|
+
dotnet publish .\Overfloat.csproj -c Release -r win-x64
|
|
152
|
+
Copy-Item .\bin\Release\net8.0\win-x64\publish\Overfloat.dll .\python\overfloat\overfloat.dll -Force
|
|
153
|
+
Set-Location .\python
|
|
154
|
+
python -m build --wheel --outdir dist .
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
## License
|
|
158
|
+
|
|
159
|
+
Apache-2.0
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
# overfloat
|
|
2
|
+
|
|
3
|
+
Overfloat is an IEEE 754-oriented arbitrary-precision floating-point runtime with Python bindings. The Python package installs like a normal Python dependency while loading a bundled native library through `ctypes`.
|
|
4
|
+
|
|
5
|
+
Use it when you want custom floating-point formats without manually wiring up a native shared library.
|
|
6
|
+
|
|
7
|
+
Highlights:
|
|
8
|
+
|
|
9
|
+
- install with `pip install overfloat`
|
|
10
|
+
- native library bundled in the wheel
|
|
11
|
+
- custom exponent and mantissa widths
|
|
12
|
+
- convenient IEEE-style presets for 16, 32, 64, and 128 total bits
|
|
13
|
+
- decimal parsing, exact formatting, arithmetic, comparisons, classifications, and bit-pattern round trips
|
|
14
|
+
|
|
15
|
+
## Install
|
|
16
|
+
|
|
17
|
+
Install from PyPI:
|
|
18
|
+
|
|
19
|
+
```powershell
|
|
20
|
+
pip install overfloat
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
If `pip` is not on `PATH`, use `python -m pip install overfloat` instead.
|
|
24
|
+
|
|
25
|
+
The PyPI wheels bundle the native Overfloat shared library for the target platform.
|
|
26
|
+
|
|
27
|
+
Use the wheel files attached to GitHub Releases only when you need manual downloads, offline installation, or release troubleshooting. The release workflow builds wheels for Python 3.9, 3.10, 3.11, 3.12, and 3.13.
|
|
28
|
+
|
|
29
|
+
Typical wheel names:
|
|
30
|
+
|
|
31
|
+
- Windows: `overfloat-<version>-cp<python>-cp<python>-win_amd64.whl`
|
|
32
|
+
- Linux: `overfloat-<version>-cp<python>-cp<python>-manylinux_..._x86_64.whl`
|
|
33
|
+
- macOS: `overfloat-<version>-cp<python>-cp<python>-macosx_11_0_arm64.whl`
|
|
34
|
+
|
|
35
|
+
For example, Python 3.9 uses `cp39`, Python 3.10 uses `cp310`, Python 3.11 uses `cp311`, Python 3.12 uses `cp312`, and Python 3.13 uses `cp313`.
|
|
36
|
+
|
|
37
|
+
## Usage
|
|
38
|
+
|
|
39
|
+
The default path is intentionally simple: import the library, create a format, then create numbers from strings or Python numeric values.
|
|
40
|
+
|
|
41
|
+
```python
|
|
42
|
+
from overfloat import OverfloatLibrary
|
|
43
|
+
|
|
44
|
+
lib = OverfloatLibrary()
|
|
45
|
+
spec = lib.create_spec_from_total_bits(32)
|
|
46
|
+
|
|
47
|
+
a = spec("1.5")
|
|
48
|
+
b = spec("2.25")
|
|
49
|
+
|
|
50
|
+
print(a + b)
|
|
51
|
+
print(a * b)
|
|
52
|
+
print(spec("1") / spec("10"))
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
`OverfloatLibrary()` loads the bundled native library by default. You can also pass an explicit shared library path.
|
|
56
|
+
|
|
57
|
+
The Python package version is exposed as `overfloat.__version__`.
|
|
58
|
+
|
|
59
|
+
## Advanced Usage
|
|
60
|
+
|
|
61
|
+
```python
|
|
62
|
+
import overfloat
|
|
63
|
+
from overfloat import OverfloatLibrary
|
|
64
|
+
|
|
65
|
+
lib = OverfloatLibrary()
|
|
66
|
+
spec = lib.create_spec_from_total_bits(4096)
|
|
67
|
+
manual_spec = lib.create_spec(43, 4048)
|
|
68
|
+
|
|
69
|
+
a = spec("1.5")
|
|
70
|
+
b = spec("2.25")
|
|
71
|
+
manual_value = manual_spec("1.5")
|
|
72
|
+
|
|
73
|
+
print(lib.version)
|
|
74
|
+
print(overfloat.__version__)
|
|
75
|
+
print(spec.exponent_bits)
|
|
76
|
+
print(spec.mantissa_bits)
|
|
77
|
+
print(a + b)
|
|
78
|
+
print(a * b)
|
|
79
|
+
print(spec("1") / spec("10"))
|
|
80
|
+
print(manual_spec.exponent_bits)
|
|
81
|
+
print(manual_spec.mantissa_bits)
|
|
82
|
+
print(manual_value)
|
|
83
|
+
print(a.to_bits_hex())
|
|
84
|
+
print(spec.from_bits_hex(a.to_bits_hex()))
|
|
85
|
+
print(a.compare(b))
|
|
86
|
+
print(a.compare_total(b))
|
|
87
|
+
print(lib.exception_flags)
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
`create_spec_from_total_bits(total_bits)` is the convenient preset form.
|
|
91
|
+
|
|
92
|
+
`create_spec(exponent_bits, mantissa_bits)` is the manual form when the exponent width and mantissa width need to be set directly.
|
|
93
|
+
|
|
94
|
+
Built-in preset formats:
|
|
95
|
+
|
|
96
|
+
- `16` -> exponent `5`, mantissa `10`
|
|
97
|
+
- `32` -> exponent `8`, mantissa `23`
|
|
98
|
+
- `64` -> exponent `11`, mantissa `52`
|
|
99
|
+
- `128` -> exponent `15`, mantissa `112`
|
|
100
|
+
|
|
101
|
+
These preset values match the IEEE 754 standard formats. For IEEE 754-2008 interchange-style formats with `k >= 128` and `k` a multiple of `32`, `create_spec_from_total_bits(k)` follows the standard width derivation.
|
|
102
|
+
|
|
103
|
+
For explicit lifetime management:
|
|
104
|
+
|
|
105
|
+
```python
|
|
106
|
+
from overfloat import OverfloatLibrary
|
|
107
|
+
|
|
108
|
+
lib = OverfloatLibrary()
|
|
109
|
+
|
|
110
|
+
with lib.create_spec_from_total_bits(4096) as spec:
|
|
111
|
+
with spec("1.5") as value:
|
|
112
|
+
print(value)
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
## Manual Builds
|
|
116
|
+
|
|
117
|
+
The prebuilt wheels are the recommended installation path. The source distribution can also build a platform native library during installation, but that path requires the .NET 8 SDK and a platform toolchain supported by .NET Native AOT.
|
|
118
|
+
|
|
119
|
+
If you are building this repository manually, build or copy the platform native library into `overfloat/` before creating a wheel or loading the package with `OverfloatLibrary()`.
|
|
120
|
+
|
|
121
|
+
Windows example:
|
|
122
|
+
|
|
123
|
+
```powershell
|
|
124
|
+
dotnet publish .\Overfloat.csproj -c Release -r win-x64
|
|
125
|
+
Copy-Item .\bin\Release\net8.0\win-x64\publish\Overfloat.dll .\python\overfloat\overfloat.dll -Force
|
|
126
|
+
Set-Location .\python
|
|
127
|
+
python -m build --wheel --outdir dist .
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
## License
|
|
131
|
+
|
|
132
|
+
Apache-2.0
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
<Project Sdk="Microsoft.NET.Sdk">
|
|
2
|
+
|
|
3
|
+
<PropertyGroup>
|
|
4
|
+
<TargetFramework>net8.0</TargetFramework>
|
|
5
|
+
<ImplicitUsings>enable</ImplicitUsings>
|
|
6
|
+
<Nullable>enable</Nullable>
|
|
7
|
+
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
|
|
8
|
+
<EnableDefaultCompileItems>false</EnableDefaultCompileItems>
|
|
9
|
+
<EnableDefaultEmbeddedResourceItems>false</EnableDefaultEmbeddedResourceItems>
|
|
10
|
+
<PublishAot>true</PublishAot>
|
|
11
|
+
<NativeLib>Shared</NativeLib>
|
|
12
|
+
<SelfContained>true</SelfContained>
|
|
13
|
+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
|
|
14
|
+
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
|
|
15
|
+
<NoWarn>$(NoWarn);CS1591</NoWarn>
|
|
16
|
+
<Version>$([System.String]::Copy($([System.IO.File]::ReadAllText('VERSION'))).Trim())</Version>
|
|
17
|
+
<AssemblyName>Overfloat</AssemblyName>
|
|
18
|
+
<PackageId>Overfloat</PackageId>
|
|
19
|
+
<Authors>Overfloat Contributors</Authors>
|
|
20
|
+
<Description>IEEE 754-oriented arbitrary precision floating-point runtime with a native C ABI.</Description>
|
|
21
|
+
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
|
|
22
|
+
<PackageReadmeFile>README.md</PackageReadmeFile>
|
|
23
|
+
<RepositoryType>git</RepositoryType>
|
|
24
|
+
<RepositoryUrl>https://github.com/overfloat/overfloat</RepositoryUrl>
|
|
25
|
+
<Company>Overfloat</Company>
|
|
26
|
+
<Product>Overfloat</Product>
|
|
27
|
+
</PropertyGroup>
|
|
28
|
+
|
|
29
|
+
<ItemGroup>
|
|
30
|
+
<Compile Include="src/Overfloat/**/*.cs" />
|
|
31
|
+
<None Include="include/**/*.h" Pack="true" PackagePath="include/" />
|
|
32
|
+
<None Include="README.md" Pack="true" PackagePath="" />
|
|
33
|
+
<None Include="LICENSE" Pack="true" PackagePath="" />
|
|
34
|
+
</ItemGroup>
|
|
35
|
+
|
|
36
|
+
</Project>
|
|
37
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
0.1.2
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
#pragma once
|
|
2
|
+
|
|
3
|
+
#include <stdint.h>
|
|
4
|
+
|
|
5
|
+
#ifdef _WIN32
|
|
6
|
+
#define OVERFLOAT_API __declspec(dllimport)
|
|
7
|
+
#else
|
|
8
|
+
#define OVERFLOAT_API __attribute__((visibility("default")))
|
|
9
|
+
#endif
|
|
10
|
+
|
|
11
|
+
#ifdef __cplusplus
|
|
12
|
+
extern "C" {
|
|
13
|
+
#endif
|
|
14
|
+
|
|
15
|
+
OVERFLOAT_API int overfloat_version_major(void);
|
|
16
|
+
OVERFLOAT_API int overfloat_version_minor(void);
|
|
17
|
+
OVERFLOAT_API int overfloat_exception_flags_get(void);
|
|
18
|
+
OVERFLOAT_API void overfloat_exception_flags_clear(void);
|
|
19
|
+
OVERFLOAT_API void* overfloat_spec_create(int exponent_bits, int mantissa_bits, int rounding_mode);
|
|
20
|
+
OVERFLOAT_API void* overfloat_spec_create_from_total_bits(int total_bits, int rounding_mode);
|
|
21
|
+
OVERFLOAT_API void overfloat_spec_free(void* spec_handle);
|
|
22
|
+
OVERFLOAT_API int overfloat_spec_exponent_bits(void* spec_handle);
|
|
23
|
+
OVERFLOAT_API int overfloat_spec_mantissa_bits(void* spec_handle);
|
|
24
|
+
OVERFLOAT_API int overfloat_spec_rounding_mode(void* spec_handle);
|
|
25
|
+
OVERFLOAT_API int overfloat_spec_validate(void* spec_handle);
|
|
26
|
+
|
|
27
|
+
OVERFLOAT_API void* overfloat_number_parse(void* spec_handle, const char* text_utf8);
|
|
28
|
+
OVERFLOAT_API void* overfloat_number_from_bits_hex(void* spec_handle, const char* hex_utf8);
|
|
29
|
+
OVERFLOAT_API void overfloat_number_free(void* number_handle);
|
|
30
|
+
OVERFLOAT_API void* overfloat_number_add(void* left_handle, void* right_handle);
|
|
31
|
+
OVERFLOAT_API void* overfloat_number_subtract(void* left_handle, void* right_handle);
|
|
32
|
+
OVERFLOAT_API void* overfloat_number_multiply(void* left_handle, void* right_handle);
|
|
33
|
+
OVERFLOAT_API void* overfloat_number_divide(void* left_handle, void* right_handle);
|
|
34
|
+
OVERFLOAT_API int overfloat_number_compare(void* left_handle, void* right_handle);
|
|
35
|
+
OVERFLOAT_API int overfloat_number_compare_total(void* left_handle, void* right_handle);
|
|
36
|
+
OVERFLOAT_API int overfloat_number_classification(void* number_handle);
|
|
37
|
+
OVERFLOAT_API int overfloat_number_is_negative(void* number_handle);
|
|
38
|
+
OVERFLOAT_API int overfloat_number_is_signaling_nan(void* number_handle);
|
|
39
|
+
OVERFLOAT_API int overfloat_number_binary_exponent(void* number_handle);
|
|
40
|
+
OVERFLOAT_API int overfloat_number_format(void* number_handle, char* buffer_utf8, int buffer_length);
|
|
41
|
+
OVERFLOAT_API int overfloat_number_nan_payload_format(void* number_handle, char* buffer_utf8, int buffer_length);
|
|
42
|
+
OVERFLOAT_API int overfloat_number_to_bits_hex(void* number_handle, char* buffer_utf8, int buffer_length);
|
|
43
|
+
|
|
44
|
+
#ifdef __cplusplus
|
|
45
|
+
}
|
|
46
|
+
#endif
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
using System.Numerics;
|
|
2
|
+
|
|
3
|
+
namespace Overfloat;
|
|
4
|
+
|
|
5
|
+
internal static class BigIntegerExtensions
|
|
6
|
+
{
|
|
7
|
+
public static int GetBitLength(this BigInteger value)
|
|
8
|
+
{
|
|
9
|
+
if (value.Sign == 0)
|
|
10
|
+
{
|
|
11
|
+
return 0;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
var bytes = value.ToByteArray(isUnsigned: true, isBigEndian: true);
|
|
15
|
+
var bits = (bytes.Length - 1) * 8;
|
|
16
|
+
var msb = bytes[0];
|
|
17
|
+
while (msb > 0)
|
|
18
|
+
{
|
|
19
|
+
bits++;
|
|
20
|
+
msb >>= 1;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
return bits;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
public static BigInteger PowerOfTwo(int exponent)
|
|
27
|
+
=> exponent < 0 ? throw new ArgumentOutOfRangeException(nameof(exponent)) : BigInteger.One << exponent;
|
|
28
|
+
|
|
29
|
+
public static BigInteger PowerOfFive(int exponent)
|
|
30
|
+
{
|
|
31
|
+
if (exponent < 0)
|
|
32
|
+
{
|
|
33
|
+
throw new ArgumentOutOfRangeException(nameof(exponent));
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
var result = BigInteger.One;
|
|
37
|
+
for (var i = 0; i < exponent; i++)
|
|
38
|
+
{
|
|
39
|
+
result *= 5;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
return result;
|
|
43
|
+
}
|
|
44
|
+
}
|