Skip to content

Commit 17dc8ff

Browse files
committed
Update readme
1 parent 8e72262 commit 17dc8ff

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ This package can be installed from source using ``python setup.py install`` or `
2828
Examples
2929
--------
3030

31-
The simplest way to use pyvkfft is to use the pyvkfft.fft interface, which will
31+
The simplest way to use pyvkfft is to use the ``pyvkfft.fft`` interface, which will
3232
automatically create the VkFFTApp (the FFT plans) according to the type of GPU
3333
arrays (pycuda, pyopencl or cupy), and also cache these apps:
3434

@@ -43,6 +43,12 @@ arrays (pycuda, pyopencl or cupy), and also cache these apps:
4343
# This will compute the fft to a new GPU array
4444
d1 = fftn(d0)
4545
46+
# An in-place transform can also be done by specifying the destination
47+
d0 = fftn(d0, d0)
48+
49+
# Or an out-of-place transform to an existing array (the destination array is always returned)
50+
d1 = fftn(d0, d1)
51+
4652
See the scripts and notebooks in the examples directory.
4753
An example notebook is also `available on google colab
4854
<https://colab.research.google.com/drive/1YJKtIwM3ZwyXnMZfgFVcpbX7H-h02Iej?usp=sharing>`_.

0 commit comments

Comments
 (0)