scipy.sparse.spmatrix.mean

spmatrix.mean(axis=None, dtype=None, out=None)

Compute the arithmetic mean along the specified axis.

Returns the average of the matrix elements. The average is taken over all elements in the matrix by default, otherwise over the specified axis. float64 intermediate and return values are used for integer inputs.

Parameters:

axis : {-2, -1, 0, 1, None} optional

Axis along which the mean is computed. The default is to compute the mean of all elements in the matrix (i.e. axis = None).

dtype : data-type, optional

Type to use in computing the mean. For integer inputs, the default is float64; for floating point inputs, it is the same as the input dtype.

out : np.matrix, optional

Alternative output matrix in which to place the result. It must have the same shape as the expected output, but the type of the output values will be cast if necessary.

Returns:

m : np.matrix

See also

np.matrix.mean

NumPy’s implementation of ‘mean’ for matrices