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)
else throw runtime_error("unsupported data type");
}
const char *pypocketfft_DS = R"DELIM(
Fast Fourier and Hartley transforms.
const char *pypocketfft_DS = R"DELIM(Fast Fourier and Hartley transforms.
This module supports
- single and double precision
......@@ -2623,7 +2622,7 @@ axes : list of integers
The axes on which the FFT is carried out.
If not set, all axes will be transformed.
fct : float
normalization factor
Normalization factor
Returns
-------
......@@ -2631,8 +2630,7 @@ np.ndarray (same shape and data type as a)
the transformed data
)DELIM";
const char *ifftn_DS = R"DELIM(
Performs a backward complex FFT.
const char *ifftn_DS = R"DELIM(Performs a backward complex FFT.
Parameters
----------
......@@ -2642,16 +2640,15 @@ axes : list of integers
The axes on which the FFT is carried out.
If not set, all axes will be transformed.
fct : float
normalization factor
Normalization factor
Returns
-------
np.ndarray (same shape and data type as a)
the transformed data
The transformed data
)DELIM";
const char *rfftn_DS = R"DELIM(
Performs a forward real-valued FFT.
const char *rfftn_DS = R"DELIM(Performs a forward real-valued FFT.
Parameters
----------
......@@ -2661,18 +2658,17 @@ axes : list of integers
The axes on which the FFT is carried out.
If not set, all axes will be transformed in ascending order.
fct : float
normalization factor
Normalization factor
Returns
-------
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
was n on input, it is n//2+1 on output.
)DELIM";
const char *irfftn_DS = R"DELIM(
Performs a backward real-valued FFT.
const char *irfftn_DS = R"DELIM(Performs a backward real-valued FFT.
Parameters
----------
......@@ -2684,18 +2680,17 @@ axes : list of integers
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.
fct : float
normalization factor
Normalization factor
Returns
-------
np.ndarray (np.float32 or np.float64)
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
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`
entries.
)DELIM";
const char *hartley_DS = R"DELIM(
Performs a Hartley FFT.
const char *hartley_DS = R"DELIM(Performs a Hartley FFT.
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
array.
......@@ -2708,12 +2703,12 @@ axes : list of integers
The axes on which the transform is carried out.
If not set, all axes will be transformed.
fct : float
normalization factor
Normalization factor
Returns
-------
np.ndarray (same shape and data type as a)
the transformed data
The transformed data
)DELIM";
} // 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