Skip to content

Commit 560afd3

Browse files
committed
update formatting CHANGE.rst
1 parent 1a9e5d0 commit 560afd3

File tree

1 file changed

+28
-24
lines changed

1 file changed

+28
-24
lines changed

CHANGES.rst

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,20 @@ mkl_fft changelog
55
1.3.13
66
======
77

8-
migrate from `setup.py` to `pyproject.toml`
8+
migrate from :code:`setup.py` to :code:`pyproject.toml`
99

1010
includes support in virtual environment out of the box
1111

12-
the original `mkl_fft.rfft` and `mkl_fft.irfft` are renamed to `mkl_fft.rfftpack` and `mkl_fft.irfftpack`, since they
13-
replicate the behavior from the deprectaed `scipy.fftpack` module.
12+
the original :code:`mkl_fft.rfft` and :code:`mkl_fft.irfft` are renamed to :code:`mkl_fft.rfftpack` and :code:`mkl_fft.irfftpack`,
13+
since they replicate the behavior from the deprectaed :code:`scipy.fftpack` module.
1414

15-
`mkl_fft.rfft_numpy`, `mkl_fft.irfft_numpy`, `mkl_fft.rfft2_numpy`, `mkl_fft.irfft2_numpy`, `mkl_fft.rfftn_numpy`
16-
and `mkl_fft.irfftn_numpy` are renamed to `mkl_fft.rfft`, `mkl_fft.irfft`, `mkl_fft.rfft2`, `mkl_fft.irfft2`, `mkl_fft.rfftn`
17-
and `mkl_fft.irfftn`, respectively. (consistent with `numpy.fft` and `scipy.fft` modules)
15+
:code:`mkl_fft.rfft_numpy`, :code:`mkl_fft.irfft_numpy`, :code:`mkl_fft.rfft2_numpy`, :code:`mkl_fft.irfft2_numpy`,
16+
:code:`mkl_fft.rfftn_numpy`, and :code:`mkl_fft.irfftn_numpy` are renamed to :code:`mkl_fft.rfft`, :code:`mkl_fft.irfft`,
17+
:code:`mkl_fft.rfft2`, :code:`mkl_fft.irfft2`, `mkl_fft.rfftn`, and :code:`mkl_fft.irfftn`, respectively.
18+
(consistent with :code:`numpy.fft` and :code:`scipy.fft` modules)
1819

19-
file `_scipy_fft_backend.py` is renamed to `_scipy_fft.py` since it replicates `scipy.fft` module (similar to file
20-
`_numpy_fft.py` which replicates `numpy.fft` module)
20+
file :code:`_scipy_fft_backend.py` is renamed to :code:`_scipy_fft.py` since it replicates :code:`scipy.fft` module
21+
(similar to file :code:`_numpy_fft.py` which replicates :code:`numpy.fft` module)
2122

2223
1.3.11
2324
======
@@ -39,7 +40,7 @@ Updated code and build system to support NumPy 2.0
3940
1.3.8
4041
=====
4142

42-
Added vendored `conv_template.py` from NumPy's distutils submodule to enable building of `mkl_fft` with
43+
Added vendored :code:`conv_template.py` from NumPy's distutils submodule to enable building of :code:`mkl_fft` with
4344
NumPy >=1.25 and Python 3.12
4445

4546
1.3.7
@@ -54,7 +55,7 @@ Transitioned to Cython 3.0.
5455
=====
5556

5657
Updated numpy interface to support new in NumPy 1.20 supported values of norm keyword, such as "forward" and "backward".
57-
To enable this, `mkl_fft` functions now support `forward_scale` parameter that defaults to 1.
58+
To enable this, :code:`mkl_fft` functions now support `forward_scale` parameter that defaults to 1.
5859

5960
Fixed issue #48.
6061

@@ -66,16 +67,17 @@ Includes bug fix #54
6667
1.2.0
6768
=====
6869

69-
Due to removal of deprecated real-to-real FFT with `DFTI_CONJUGATE_EVEN_STORAGE=DFTI_COMPLEX_REAL` and `DFTI_PACKED_FORMAT=DFTI_PACK`
70-
from Intel(R) Math Kernel Library, reimplemented `mkl_fft.rfft` and `mkl_fft.irfft` to use real-to-complex functionality with subsequent
71-
copying to rearange the transform as expected of `mkl_fft.rfft`, with the associated performance penalty. The use of the real-to-complex
70+
Due to removal of deprecated real-to-real FFT with :code:`DFTI_CONJUGATE_EVEN_STORAGE=DFTI_COMPLEX_REAL` and
71+
:code:`DFTI_PACKED_FORMAT=DFTI_PACK` from Intel(R) Math Kernel Library, reimplemented :code:`mkl_fft.rfft` and
72+
:code:`mkl_fft.irfft` to use real-to-complex functionality with subsequent copying to rearange the transform as expected
73+
of :code:`mkl_fft.rfft`, with the associated performance penalty. The use of the real-to-complex
7274
transform improves multi-core utilization which may offset the performance loss incurred due to copying.
7375

7476

7577
1.1.0
7678
=====
7779

78-
Added `scipy.fft` backend, see #42. Fixed #46.
80+
Added :code:`scipy.fft` backend, see #42. Fixed #46.
7981

8082
```
8183
Python 3.7.5 (default, Nov 23 2019, 04:02:01)
@@ -102,16 +104,16 @@ Out[4]: True
102104
1.0.15
103105
======
104106

105-
Changed tests to not compare against numpy fft, as this broke due to renaming of `np.fft.pocketfft` to
106-
`np.fft._pocketfft`. Instead compare against naive realization of 1D FFT as a sum.
107+
Changed tests to not compare against numpy fft, as this broke due to renaming of :code:`np.fft.pocketfft` to
108+
:code:`np.fft._pocketfft`. Instead compare against naive realization of 1D FFT as a sum.
107109

108-
Setup script is now aware of `MKLROOT` environment variable. If unset, NumPy's mkl_info will be queried.
110+
Setup script is now aware of :code:`MKLROOT` environment variable. If unset, NumPy's mkl_info will be queried.
109111

110112

111113
1.0.14
112114
======
113115

114-
Fixed unreferenced bug in `irfftn_numpy`, and adjusted NumPy interfaces to change to pocketfft in NumPy 1.17
116+
Fixed unreferenced bug in :code:`irfftn_numpy`, and adjusted NumPy interfaces to change to pocketfft in NumPy 1.17
115117

116118

117119
1.0.13
@@ -124,8 +126,8 @@ Issue #39 fixed (memory leak with complex FFT on real arrays)
124126
======
125127
Issue #37 fixed.
126128

127-
Inhibited vectorization of short loops computing pointer to memory referenced by a multi-iterator by Intel (R) C Compiler, improving
128-
performance of ND `fft` and `ifft` on real input arrays.
129+
Inhibited vectorization of short loops computing pointer to memory referenced by a multi-iterator by Intel (R) C Compiler,
130+
improving performance of ND :code:`fft` and :code:`ifft` on real input arrays.
129131

130132

131133
1.0.11
@@ -155,7 +157,7 @@ Fixed issues #21, and addressed NumPy 1.15 deprecation warnings from using lists
155157
=====
156158

157159
Fixed issues #7, #17, #18.
158-
Consolidated version specification into a single file `mkl_fft/_version.py`.
160+
Consolidated version specification into a single file :code:`mkl_fft/_version.py`.
159161

160162
1.0.4
161163
=====
@@ -169,13 +171,15 @@ This is a bug fix release.
169171

170172
It fixes issues #9, and #13.
171173

172-
As part of fixing issue #13, out-of-place 1D FFT calls such as `fft`, `ifft`, `rfft_numpy` and `irfftn_numpy` will allocate Fortran layout array for the output is the input is a Fotran array.
174+
As part of fixing issue #13, out-of-place 1D FFT calls such as :code:`fft`, :code:`ifft`, :code:`rfft_numpy`
175+
and :code:`irfftn_numpy` will allocate Fortran layout array for the output is the input is a Fotran array.
173176

174177

175178
1.0.2
176179
=====
177180

178-
Minor update of `mkl_fft`, reflecting renaming of `numpy.core.multiarray_tests` module to `numpy.core._multiarray_tests` as well as fixing #4.
181+
Minor update of :code:`mkl_fft`, reflecting renaming of :code:`numpy.core.multiarray_tests` module to
182+
:code:`numpy.core._multiarray_tests` as well as fixing #4.
179183

180184

181185
1.0.1
@@ -186,4 +190,4 @@ Bug fix release.
186190
1.0.0
187191
=====
188192

189-
Initial release of `mkl_fft`.
193+
Initial release of :code:`mkl_fft`.

0 commit comments

Comments
 (0)