Documentation of cross function
@@ -71,11 +71,26 @@ def cross(a, b, axisa = -1, axisb = -1, axisc = -1, axis = None):
have dimension 2, the z-component of the cross product is returned.
Args:
- a (cupy.ndarray): The first argument.
- b (cupy.ndarray): The second argument.
+ a : cupy.ndarray
+ Components of the first vector(s).
+ b : cupy.ndarray
+ Components of the second vector(s).
+ axisa : int, optional
+ Axis of `a` that defines the vector(s). By default, the last axis.
+ axisb : int, optional
+ Axis of `b` that defines the vector(s). By default, the last axis.
+ axisc : int, optional
+ Axis of `c` containing the cross product vector(s). Ignored if
+ both input vectors have dimension 2, as the return is scalar.
+ By default, the last axis.
+ axis : int, optional
+ If defined, the axis of `a`, `b` and `c` that defines the vector(s)
+ and cross product(s). Overrides `axisa`, `axisb` and `axisc`.
Returns:
- cupy.ndarray: Returns ndarray of cross product result.
+ c : cupy.ndarray
+ Vector cross product(s).
+
.. seealso:: :func:`numpy.cross`
