Commit 5705b6a5 authored by Martin Reinecke's avatar Martin Reinecke

clarify documentation

parent ab552715
...@@ -347,7 +347,7 @@ inorm : int ...@@ -347,7 +347,7 @@ inorm : int
2 : divide by N 2 : divide by N
where N is the product of the lengths of the transformed axes. where N is the product of the lengths of the transformed axes.
out : numpy.ndarray (same shape as `a`, complex type with same accuracy as `a`) out : numpy.ndarray (same shape as `a`, complex type with same accuracy as `a`)
May be identical to `a`. May be identical to `a`, but if it isn't, it must not overlap with `a`.
If None, a new array is allocated to store the output. If None, a new array is allocated to store the output.
nthreads : int nthreads : int
Number of threads to use. If 0, use the system default (typically governed Number of threads to use. If 0, use the system default (typically governed
...@@ -378,6 +378,7 @@ inorm : int ...@@ -378,6 +378,7 @@ inorm : int
where N is the product of the lengths of the transformed input axes. where N is the product of the lengths of the transformed input axes.
out : numpy.ndarray (complex type with same accuracy as `a`) out : numpy.ndarray (complex type with same accuracy as `a`)
For the required shape, see the `Returns` section. For the required shape, see the `Returns` section.
Must not overlap with `a`.
If None, a new array is allocated to store the output. If None, a new array is allocated to store the output.
nthreads : int nthreads : int
Number of threads to use. If 0, use the system default (typically governed Number of threads to use. If 0, use the system default (typically governed
...@@ -412,6 +413,7 @@ inorm : int ...@@ -412,6 +413,7 @@ inorm : int
where N is the product of the lengths of the transformed output axes. where N is the product of the lengths of the transformed output axes.
out : numpy.ndarray (real type with same accuracy as `a`) out : numpy.ndarray (real type with same accuracy as `a`)
For the required shape, see the `Returns` section. For the required shape, see the `Returns` section.
Must not overlap with `a`.
If None, a new array is allocated to store the output. If None, a new array is allocated to store the output.
nthreads : int nthreads : int
Number of threads to use. If 0, use the system default (typically governed Number of threads to use. If 0, use the system default (typically governed
...@@ -446,7 +448,7 @@ inorm : int ...@@ -446,7 +448,7 @@ inorm : int
2 : divide by N 2 : divide by N
where N is the length of `axis`. where N is the length of `axis`.
out : numpy.ndarray (same shape and data type as `a`) out : numpy.ndarray (same shape and data type as `a`)
May be identical to `a`. May be identical to `a`, but if it isn't, it must not overlap with `a`.
If None, a new array is allocated to store the output. If None, a new array is allocated to store the output.
nthreads : int nthreads : int
Number of threads to use. If 0, use the system default (typically governed Number of threads to use. If 0, use the system default (typically governed
...@@ -477,7 +479,7 @@ inorm : int ...@@ -477,7 +479,7 @@ inorm : int
2 : divide by N 2 : divide by N
where N is the product of the lengths of the transformed axes. where N is the product of the lengths of the transformed axes.
out : numpy.ndarray (same shape and data type as `a`) out : numpy.ndarray (same shape and data type as `a`)
May be identical to `a`. May be identical to `a`, but if it isn't, it must not overlap with `a`.
If None, a new array is allocated to store the output. If None, a new array is allocated to store the output.
nthreads : int nthreads : int
Number of threads to use. If 0, use the system default (typically governed Number of threads to use. If 0, use the system default (typically governed
...@@ -509,7 +511,7 @@ inorm : int ...@@ -509,7 +511,7 @@ inorm : int
2 : divide by N 2 : divide by N
where N is the product of the lengths of the transformed axes. where N is the product of the lengths of the transformed axes.
out : numpy.ndarray (same shape and data type as `a`) out : numpy.ndarray (same shape and data type as `a`)
May be identical to `a`. May be identical to `a`, but if it isn't, it must not overlap with `a`.
If None, a new array is allocated to store the output. If None, a new array is allocated to store the output.
nthreads : int nthreads : int
Number of threads to use. If 0, use the system default (typically governed Number of threads to use. If 0, use the system default (typically governed
......
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