search

xtensor-stack / xtensor-fftw

FFTW bindings for the xtensor C++14 multi-dimensional array library
BSD 3-Clause "New" or "Revised" License
48 stars 16 forks source link

Document destructive inverse real FFTs #12

Open egpbos opened 7 years ago

egpbos commented 7 years ago

The default behavior for inverse real FFT functions (c2r) in FFTW is to destroy the input arrays during the calculation. This is probably very unexpected for most users.

We should add this to the documentation, probably multiple times (in the general howtos, and in the function docs). Maybe we should even print run-time warnings.

egpbos commented 7 years ago

Todo: add notes to function documentation.