Skip to content

Commit 6bd5d2f

Browse files
committed
fixups
1 parent 2fb33b0 commit 6bd5d2f

File tree

4 files changed

+32
-42
lines changed

4 files changed

+32
-42
lines changed

quaddtype/docs/api/constants_api.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,49 +7,49 @@ Pre-defined mathematical constants with quad precision accuracy.
77
```{eval-rst}
88
.. data:: numpy_quaddtype.pi
99
10-
The mathematical constant :math:`pi` (pi).
10+
The mathematical constant :math:`\pi` (pi).
1111
12-
Value: 3.14159265358979323846264338327950288...
12+
:value: 3.14159265358979323846264338327950288...
1313
1414
:type: QuadPrecision
1515
1616
.. data:: numpy_quaddtype.e
1717
1818
Euler's number :math:`e`, the base of natural logarithms.
1919
20-
Value: 2.71828182845904523536028747135266249...
20+
:value: 2.71828182845904523536028747135266249...
2121
2222
:type: QuadPrecision
2323
2424
.. data:: numpy_quaddtype.log2e
2525
2626
The base-2 logarithm of :math:`e`: :math:`\log_{2}{e}`.
2727
28-
Value: 1.44269504088896340735992468100189213...
28+
:value: 1.44269504088896340735992468100189213...
2929
3030
:type: QuadPrecision
3131
3232
.. data:: numpy_quaddtype.log10e
3333
3434
The base-10 logarithm of :math:`e`: :math:`\log_{10}{e}`.
3535
36-
Value: 0.43429448190325182765112891891660508...
36+
:value: 0.43429448190325182765112891891660508...
3737
3838
:type: QuadPrecision
3939
4040
.. data:: numpy_quaddtype.ln2
4141
42-
The natural logarithm of 2: :math:`\ln(2)`.
42+
The natural logarithm of 2: :math:`\log_{e}{2}`.
4343
44-
Value: 0.69314718055994530941723212145817656...
44+
:value: 0.69314718055994530941723212145817656...
4545
4646
:type: QuadPrecision
4747
4848
.. data:: numpy_quaddtype.ln10
4949
50-
The natural logarithm of 10: :math:`\ln(10)`.
50+
The natural logarithm of 10: :math:`\log_{e}{10}`.
5151
52-
Value: 2.30258509299404568401799145468436420...
52+
:value: 2.30258509299404568401799145468436420...
5353
5454
:type: QuadPrecision
5555
```
@@ -61,41 +61,41 @@ Pre-defined mathematical constants with quad precision accuracy.
6161
6262
Machine epsilon: the smallest positive number such that :math:`1.0 + \epsilon \neq 1.0`.
6363
64-
:math:`2^{-112}` or approximately :math:`1.93 \cdot 10^{-34}`.
64+
:value: :math:`2^{-112}` or approximately :math:`1.93 \cdot 10^{-34}`
6565
6666
:type: QuadPrecision
6767
6868
.. data:: numpy_quaddtype.max_value
6969
7070
The largest representable finite quad-precision value.
7171
72-
:math:`216383 \cdot (2 - 2^{-112})` or approximately :math:`1.19 \cdot 10^{4932}`.
72+
The largest negative representable finite quad-precision value is ``-numpy_quaddtype.max_value``.
7373
74-
The largest negative representable finite quad-precision value is `-numpy_quaddtype.max_value`.
74+
:value: :math:`216383 \cdot (2 - 2^{-112})` or approximately :math:`1.19 \cdot 10^{4932}`
7575
7676
:type: QuadPrecision
7777
7878
.. data:: numpy_quaddtype.smallest_normal
7979
8080
The smallest positive normal (normalized, mantissa has a leading 1 bit) quad-precision value.
8181
82-
:math:`2^{-16382} \cdot (1 - 2^{-112})` or approximately :math:`3.36 \cdot 10^{-4932}`.
82+
:value: :math:`2^{-16382} \cdot (1 - 2^{-112})` or approximately :math:`3.36 \cdot 10^{-4932}`
8383
8484
:type: QuadPrecision
8585
8686
.. data:: numpy_quaddtype.smallest_subnormal
8787
8888
The smallest positive subnormal (denormalized, mantissa has a leading 0 bit) quad-precision value.
8989
90-
:math:`2^{-16494}` or approximately :math:`6.48 \cdot 10^{-4966}`.
90+
:value: :math:`2^{-16494}` or approximately :math:`6.48 \cdot 10^{-4966}`
9191
9292
:type: QuadPrecision
9393
9494
.. data:: numpy_quaddtype.resolution
9595
9696
The approximate decimal resolution of quad precision, i.e. `10 ** (-precision)`.
9797
98-
:math:`10^{-33}`.
98+
:value: :math:`10^{-33}`
9999
100100
:type: QuadPrecision
101101
```

quaddtype/docs/api/core.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The fundamental types provided by NumPy QuadDType.
44

5-
## QuadPrecision
5+
## Quad Precision Value
66

77
```{eval-rst}
88
.. class:: numpy_quaddtype.QuadPrecision(value, backend="sleef")
@@ -63,7 +63,7 @@ The fundamental types provided by NumPy QuadDType.
6363
The imaginary part (always zero for QuadPrecision).
6464
```
6565

66-
## QuadPrecDType
66+
## Quad Precision DType
6767

6868
```{eval-rst}
6969
.. class:: numpy_quaddtype.QuadPrecDType(backend="sleef")
@@ -92,7 +92,7 @@ The fundamental types provided by NumPy QuadDType.
9292
.. attribute:: backend
9393
:type: QuadBackend
9494
95-
The computation backend (``QuadBackend.SLEEF`` or ``QuadBackend.LONGDOUBLE``).
95+
The computation backend (``SLEEF`` or ``LONGDOUBLE``).
9696
9797
.. attribute:: itemsize
9898
:type: int
@@ -110,8 +110,6 @@ The fundamental types provided by NumPy QuadDType.
110110
The string name of the dtype (``"QuadPrecDType128"``).
111111
```
112112

113-
## QuadBackend
114-
115113
```{eval-rst}
116114
.. class:: numpy_quaddtype.QuadBackend
117115
@@ -140,8 +138,6 @@ The fundamental types provided by NumPy QuadDType.
140138

141139
## Convenience Functions
142140

143-
### SleefQuadPrecision
144-
145141
```{eval-rst}
146142
.. function:: numpy_quaddtype.SleefQuadPrecision(value)
147143
@@ -154,8 +150,6 @@ The fundamental types provided by NumPy QuadDType.
154150
:rtype: QuadPrecision
155151
```
156152

157-
### LongDoubleQuadPrecision
158-
159153
```{eval-rst}
160154
.. function:: numpy_quaddtype.LongDoubleQuadPrecision(value)
161155
@@ -168,8 +162,6 @@ The fundamental types provided by NumPy QuadDType.
168162
:rtype: QuadPrecision
169163
```
170164

171-
### SleefQuadPrecDType
172-
173165
```{eval-rst}
174166
.. function:: numpy_quaddtype.SleefQuadPrecDType()
175167
@@ -181,8 +173,6 @@ The fundamental types provided by NumPy QuadDType.
181173
:rtype: QuadPrecDType
182174
```
183175

184-
### LongDoubleQuadPrecDType
185-
186176
```{eval-rst}
187177
.. function:: numpy_quaddtype.LongDoubleQuadPrecDType()
188178

quaddtype/docs/api/functions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ NumPy QuadDType supports a comprehensive set of NumPy universal functions (ufunc
6060

6161
| Function | Description |
6262
|----------|-------------|
63-
| `np.exp` | Exponential (:math:`e^x`) |
64-
| `np.exp2` | Base-2 exponential (:math:`2^x`) |
63+
| `np.exp` | Exponential ({math}`e^x`) |
64+
| `np.exp2` | Base-2 exponential ({math}`2^x`) |
6565
| `np.expm1` | `exp(x) - 1` (accurate for small x) |
6666

6767
## Element-wise Logarithmic Functions
@@ -77,10 +77,10 @@ NumPy QuadDType supports a comprehensive set of NumPy universal functions (ufunc
7777

7878
| Function | Description |
7979
|----------|-------------|
80-
| `np.square` | Square (:math:`x^2`) |
80+
| `np.square` | Square ({math}`x^2`) |
8181
| `np.sqrt` | Square root |
8282
| `np.cbrt` | Cube root |
83-
| `np.hypot` | Hypotenuse (:math:`\sqrt{x^2 + y^2}`) |
83+
| `np.hypot` | Hypotenuse ({math}`\sqrt{x^2 + y^2}`) |
8484

8585
## Element-wise Rounding Functions
8686

quaddtype/docs/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,22 @@ NumPy QuadDType provides IEEE 754 quadruple-precision (binary128) floating-point
1818
:gutter: 2
1919

2020
:::{grid-item-card} 🎯 True Quad Precision
21-
:link: user_guide/precision
22-
:link-type: doc
21+
<!--- :link: user_guide/precision
22+
:link-type: doc -->
2323

2424
128-bit floating point with ~34 decimal digits of precision
2525
:::
2626

2727
:::{grid-item-card} 🔌 NumPy Integration
28-
:link: user_guide/arrays
29-
:link-type: doc
28+
<!--- :link: user_guide/arrays
29+
:link-type: doc -->
3030

3131
Works seamlessly with NumPy arrays, ufuncs, and broadcasting.
3232
:::
3333

3434
:::{grid-item-card} ⚡ SIMD Optimized
35-
:link: user_guide/performance
36-
:link-type: doc
35+
<!--- :link: user_guide/performance
36+
:link-type: doc -->
3737

3838
Vectorization-friendly design that can leverage SIMD acceleration where supported.
3939
:::
@@ -46,15 +46,15 @@ Full suite of math functions: trigonometric, exponential, logarithmic, and more.
4646
:::
4747

4848
:::{grid-item-card} 🔀 Dual Backend
49-
:link: user_guide/backends
50-
:link-type: doc
49+
<!--- :link: user_guide/backends
50+
:link-type: doc -->
5151

5252
Choose between SLEEF (default) or native longdouble backends.
5353
:::
5454

5555
:::{grid-item-card} 🧵 Thread-Safe
56-
:link: user_guide/threading
57-
:link-type: doc
56+
<!--- :link: user_guide/threading
57+
:link-type: doc -->
5858

5959
Full support for Python's free-threading (GIL-free) mode.
6060
:::

0 commit comments

Comments
 (0)