Commit 8171d7db authored by Martin Reinecke's avatar Martin Reinecke
Browse files

doc tweaks

parent 287c1d70
...@@ -2599,8 +2599,7 @@ py::array hartley2(const py::array &in, py::object axes_, double fct) ...@@ -2599,8 +2599,7 @@ py::array hartley2(const py::array &in, py::object axes_, double fct)
else throw runtime_error("unsupported data type"); else throw runtime_error("unsupported data type");
} }
const char *pypocketfft_DS = R"DELIM( const char *pypocketfft_DS = R"DELIM(Fast Fourier and Hartley transforms.
Fast Fourier and Hartley transforms.
This module supports This module supports
- single and double precision - single and double precision
...@@ -2623,7 +2622,7 @@ axes : list of integers ...@@ -2623,7 +2622,7 @@ axes : list of integers
The axes on which the FFT is carried out. The axes on which the FFT is carried out.
If not set, all axes will be transformed. If not set, all axes will be transformed.
fct : float fct : float
normalization factor Normalization factor
Returns Returns
------- -------
...@@ -2631,8 +2630,7 @@ np.ndarray (same shape and data type as a) ...@@ -2631,8 +2630,7 @@ np.ndarray (same shape and data type as a)
the transformed data the transformed data
)DELIM"; )DELIM";
const char *ifftn_DS = R"DELIM( const char *ifftn_DS = R"DELIM(Performs a backward complex FFT.
Performs a backward complex FFT.
Parameters Parameters
---------- ----------
...@@ -2642,16 +2640,15 @@ axes : list of integers ...@@ -2642,16 +2640,15 @@ axes : list of integers
The axes on which the FFT is carried out. The axes on which the FFT is carried out.
If not set, all axes will be transformed. If not set, all axes will be transformed.
fct : float fct : float
normalization factor Normalization factor
Returns Returns
------- -------
np.ndarray (same shape and data type as a) np.ndarray (same shape and data type as a)
the transformed data The transformed data
)DELIM"; )DELIM";
const char *rfftn_DS = R"DELIM( const char *rfftn_DS = R"DELIM(Performs a forward real-valued FFT.
Performs a forward real-valued FFT.
Parameters Parameters
---------- ----------
...@@ -2661,18 +2658,17 @@ axes : list of integers ...@@ -2661,18 +2658,17 @@ axes : list of integers
The axes on which the FFT is carried out. The axes on which the FFT is carried out.
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
Returns Returns
------- -------
np.ndarray (np.complex64 or np.complex128) np.ndarray (np.complex64 or np.complex128)
the transformed data. The shape is identical to that of the input array, The transformed data. The shape is identical to that of the input array,
except for the axis that was transformed last. If the length of that axis except for the axis that was transformed last. If the length of that axis
was n on input, it is n//2+1 on output. was n on input, it is n//2+1 on output.
)DELIM"; )DELIM";
const char *irfftn_DS = R"DELIM( const char *irfftn_DS = R"DELIM(Performs a backward real-valued FFT.
Performs a backward real-valued FFT.
Parameters Parameters
---------- ----------
...@@ -2684,18 +2680,17 @@ axes : list of integers ...@@ -2684,18 +2680,17 @@ axes : list of integers
lastsize : the output size of the last axis to be transformed. 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
Returns Returns
------- -------
np.ndarray (np.float32 or np.float64) np.ndarray (np.float32 or np.float64)
the transformed data. The shape is identical to that of the input array, The transformed data. The shape is identical to that of the input array,
except for the axis that was transformed last, which has now lastsize except for the axis that was transformed last, which has now `lastsize`
entries. entries.
)DELIM"; )DELIM";
const char *hartley_DS = R"DELIM( const char *hartley_DS = R"DELIM(Performs a Hartley FFT.
Performs a Hartley FFT.
For every requested axis, a 1D forward Fourier transform is carried out, For every requested axis, a 1D forward Fourier transform is carried out,
and the sum of real and imaginary parts of the result is stored in the output and the sum of real and imaginary parts of the result is stored in the output
array. array.
...@@ -2708,12 +2703,12 @@ axes : list of integers ...@@ -2708,12 +2703,12 @@ axes : list of integers
The axes on which the transform is carried out. The axes on which the transform is carried out.
If not set, all axes will be transformed. If not set, all axes will be transformed.
fct : float fct : float
normalization factor Normalization factor
Returns Returns
------- -------
np.ndarray (same shape and data type as a) np.ndarray (same shape and data type as a)
the transformed data The transformed data
)DELIM"; )DELIM";
} // unnamed namespace } // unnamed namespace
......
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