Skip to content

GitLab

Commit a386e0d0 authored by Martin Reinecke's avatar Martin Reinecke
Browse files

update documentation

parent 21e390b1
Hide whitespace changes
Inline Side-by-side
pypocketfft.cc
View file @ a386e0d0
...@@ -269,6 +269,9 @@ fct : float ...@@ -269,6 +269,9 @@ fct : float
inplace : bool inplace : bool
if False, returns the result in a new array and leaves the input unchanged. if False, returns the result in a new array and leaves the input unchanged.
if True, stores the result in the input array and returns a handle to it. if True, stores the result in the input array and returns a handle to it.
nthreads : int
Number of threads to use. If 0, use the system default (typically governed
by the `OMP_NUM_THREADS` environment variable).
Returns Returns
------- -------
...@@ -290,6 +293,9 @@ fct : float ...@@ -290,6 +293,9 @@ fct : float
inplace : bool inplace : bool
if False, returns the result in a new array and leaves the input unchanged. if False, returns the result in a new array and leaves the input unchanged.
if True, stores the result in the input array and returns a handle to it. if True, stores the result in the input array and returns a handle to it.
nthreads : int
Number of threads to use. If 0, use the system default (typically governed
by the `OMP_NUM_THREADS` environment variable).
Returns Returns
------- -------
...@@ -308,6 +314,9 @@ axes : list of integers ...@@ -308,6 +314,9 @@ axes : list of integers
If not set, all axes will be transformed in ascending order. If not set, all axes will be transformed in ascending order.
fct : float fct : float
Normalization factor Normalization factor
nthreads : int
Number of threads to use. If 0, use the system default (typically governed
by the `OMP_NUM_THREADS` environment variable).
Returns Returns
------- -------
...@@ -330,6 +339,9 @@ fct : float ...@@ -330,6 +339,9 @@ fct : float
inplace : bool inplace : bool
if False, returns the result in a new array and leaves the input unchanged. if False, returns the result in a new array and leaves the input unchanged.
if True, stores the result in the input array and returns a handle to it. if True, stores the result in the input array and returns a handle to it.
nthreads : int
Number of threads to use. If 0, use the system default (typically governed
by the `OMP_NUM_THREADS` environment variable).
Returns Returns
------- -------
...@@ -352,6 +364,9 @@ lastsize : the output size of the last axis to be transformed. ...@@ -352,6 +364,9 @@ lastsize : the output size of the last axis to be transformed.
If the corresponding input axis has size n, this can be 2*n-2 or 2*n-1. If the corresponding input axis has size n, this can be 2*n-2 or 2*n-1.
fct : float fct : float
Normalization factor Normalization factor
nthreads : int
Number of threads to use. If 0, use the system default (typically governed
by the `OMP_NUM_THREADS` environment variable).
Returns Returns
------- -------
...@@ -375,6 +390,9 @@ fct : float ...@@ -375,6 +390,9 @@ fct : float
inplace : bool inplace : bool
if False, returns the result in a new array and leaves the input unchanged. if False, returns the result in a new array and leaves the input unchanged.
if True, stores the result in the input array and returns a handle to it. if True, stores the result in the input array and returns a handle to it.
nthreads : int
Number of threads to use. If 0, use the system default (typically governed
by the `OMP_NUM_THREADS` environment variable).
Returns Returns
------- -------
...@@ -399,6 +417,9 @@ fct : float ...@@ -399,6 +417,9 @@ fct : float
inplace : bool inplace : bool
if False, returns the result in a new array and leaves the input unchanged. if False, returns the result in a new array and leaves the input unchanged.
if True, stores the result in the input array and returns a handle to it. if True, stores the result in the input array and returns a handle to it.
nthreads : int
Number of threads to use. If 0, use the system default (typically governed
by the `OMP_NUM_THREADS` environment variable).
Returns Returns
------- -------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment