Skip to content

Commit 5053953

Browse files
committed
address comments
1 parent 151dab8 commit 5053953

File tree

1 file changed

+37
-55
lines changed

1 file changed

+37
-55
lines changed

CHANGELOG.md

Lines changed: 37 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
1-
`mkl_fft` changelog
2-
===================
1+
# changelog
2+
All notable changes to this project will be documented in this file.
33

4-
[dev] (MM/DD/YY)
5-
================
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7-
SciPy interface `mkl_fft.interfaces.scipy_fft` now includes Hermitian FFT functions: `hfft`, `ihfft`, `hfftn`, `ihfftn`, `hfft2`, and `ihfft2`
7+
## [dev] (MM/DD/YY)
88

9-
1.3.14 (04/10/2025)
10-
===================
9+
### Added
10+
* SciPy interface `mkl_fft.interfaces.scipy_fft` now includes Hermitian FFT functions: `hfft`, `ihfft`, `hfftn`, `ihfftn`, `hfft2`, and `ihfft2` [gh-161](https://github.com/IntelPython/mkl_fft/pull/161)
11+
12+
## [1.3.14] (04/10/2025)
1113

1214
resolves gh-152 by adding an explicit `mkl-service` dependency to `mkl-fft` when building the wheel
1315
to ensure the `mkl` Python module is always available at runtime
1416

1517
resolves gh-115, gh-116, gh-119, gh-135
1618

17-
1.3.13 (03/25/2025)
18-
===================
19+
## [1.3.13] (03/25/2025)
1920

2021
Supported python versions are 3.9, 3.10, 3.11, 3.12
2122

@@ -34,59 +35,50 @@ since they replicate the behavior from the deprecated `scipy.fftpack` module.
3435
file `_scipy_fft_backend.py` is renamed to `_scipy_fft.py` since it replicates `scipy.fft` module
3536
(similar to file `_numpy_fft.py` which replicates `numpy.fft` module)
3637

37-
1.3.11
38-
======
38+
## [1.3.11]
3939

4040
Bugfix release, resolving gh-109 and updating installation instructions
4141

42-
1.3.10
43-
======
42+
## [1.3.10]
4443

4544
Bugfix release, resolving leftover uses of NumPy attributes removed in NumPy 2.0 that break
4645
test suite run on Windows.
4746

48-
1.3.9
49-
=====
47+
## [1.3.9]
5048

5149
Updated code and build system to support NumPy 2.0
5250

53-
1.3.8
54-
=====
51+
## [1.3.8]
5552

5653
Added vendored `conv_template.py` from NumPy's distutils submodule to enable building of `mkl_fft` with
5754
NumPy >=1.25 and Python 3.12
5855

59-
1.3.7
60-
=====
56+
## [1.3.7]
6157

6258
Updated build system away from removed in NumPy 1.25 numpy.distutils module.
6359

6460
Transitioned to Cython 3.0.
6561

66-
1.3.0
67-
=====
62+
## [1.3.0]
6863

6964
Updated numpy interface to support new in NumPy 1.20 supported values of norm keyword, such as "forward" and "backward".
7065
To enable this, `mkl_fft` functions now support `forward_scale` parameter that defaults to 1.
7166

7267
Fixed issue #48.
7368

74-
1.2.1
75-
=====
69+
## [1.2.1]
7670

7771
Includes bug fix #54
7872

79-
1.2.0
80-
=====
73+
## [1.2.0]
8174

8275
Due to removal of deprecated real-to-real FFT with `DFTI_CONJUGATE_EVEN_STORAGE=DFTI_COMPLEX_REAL` and
8376
`DFTI_PACKED_FORMAT=DFTI_PACK` from Intel(R) Math Kernel Library, reimplemented `mkl_fft.rfft` and
8477
`mkl_fft.irfft` to use real-to-complex functionality with subsequent copying to rearange the transform as expected
8578
of `mkl_fft.rfft`, with the associated performance penalty. The use of the real-to-complex
8679
transform improves multi-core utilization which may offset the performance loss incurred due to copying.
8780

88-
1.1.0
89-
=====
81+
## [1.1.0]
9082

9183
Added `scipy.fft` backend, see #42. Fixed #46.
9284

@@ -108,65 +100,58 @@ Added `scipy.fft` backend, see #42. Fixed #46.
108100
# True
109101
```
110102

111-
1.0.15
112-
======
103+
## [1.0.15]
113104

114105
Changed tests to not compare against numpy fft, as this broke due to renaming of `np.fft.pocketfft` to
115106
`np.fft._pocketfft`. Instead compare against naive realization of 1D FFT as a sum.
116107

117108
Setup script is now aware of `MKLROOT` environment variable. If unset, NumPy's mkl_info will be queried.
118109

119-
1.0.14
120-
======
110+
## [1.0.14]
121111

122112
Fixed unreferenced bug in `irfftn_numpy`, and adjusted NumPy interfaces to change to pocketfft in NumPy 1.17
123113

124-
1.0.13
125-
======
114+
## [1.0.13]
126115

127116
Issue #39 fixed (memory leak with complex FFT on real arrays)
128117

129-
1.0.12
130-
======
118+
## [1.0.12]
119+
131120
Issue #37 fixed.
132121

133122
Inhibited vectorization of short loops computing pointer to memory referenced by a multi-iterator by Intel (R) C Compiler,
134123
improving performance of ND `fft` and `ifft` on real input arrays.
135124

136-
1.0.11
137-
======
125+
## [1.0.11]
126+
138127
Improvement for performance of ND `fft` on real input arrays by inlining multi-iterators.
139128
This particularly benefits performance of mkl_fft built with Intel (R) C Compiler.
140129

141-
1.0.10
142-
======
130+
## [1.0.10]
131+
143132
Fix for issue #29.
144133

145-
1.0.7
146-
=====
134+
## [1.0.7]
135+
147136
Improved exception message raised if MKL is signalling an error. The message now includes MKL's own description of the exception.
148137
This partially improves #24.
149138

150139
Improved argument validation for ND transforms aligning with scipy 1.2.0
151140

152-
1.0.6
153-
=====
141+
## [1.0.6]
154142

155143
Fixed issues #21, and addressed NumPy 1.15 deprecation warnings from using lists instead of tuples to specify multiple slices.
156144

157-
1.0.5
158-
=====
145+
## [1.0.5]
159146

160147
Fixed issues #7, #17, #18.
161148
Consolidated version specification into a single file `mkl_fft/_version.py`.
162149

163-
1.0.4
164-
=====
150+
## [1.0.4]
165151

166152
Added CHANGES.rst. Fixed issue #11 by using lock around calls to 1D FFT routines.
167153

168-
1.0.3
169-
=====
154+
## [1.0.3]
170155

171156
This is a bug fix release.
172157

@@ -175,18 +160,15 @@ It fixes issues #9, and #13.
175160
As part of fixing issue #13, out-of-place 1D FFT calls such as `fft`, `ifft`, `rfft_numpy`
176161
and `irfftn_numpy` will allocate Fortran layout array for the output is the input is a Fotran array.
177162

178-
1.0.2
179-
=====
163+
## [1.0.2]
180164

181165
Minor update of `mkl_fft`, reflecting renaming of `numpy.core.multiarray_tests` module to
182166
`numpy.core._multiarray_tests` as well as fixing #4.
183167

184-
1.0.1
185-
=====
168+
## [1.0.1]
186169

187170
Bug fix release.
188171

189-
1.0.0
190-
=====
172+
## [1.0.0]
191173

192174
Initial release of `mkl_fft`.

0 commit comments

Comments
 (0)