NumSharp/src/NumSharp.Core/Statistics/NDArray.mean.cs at master · SciSharp/NumSharp · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
using System;
using NumSharp.Backends;

namespace NumSharp
{
    public partial class NDArray
    {
        /// <summary>
        ///     Compute the arithmetic mean along the specified axis.
        ///     Returns the average of the array elements.
        ///     The average is taken over the flattened array by default, otherwise over the specified axis.
        ///     float64 intermediate and return values are used for integer inputs.
        /// </summary>
        /// <param name="nd">Array containing numbers whose mean is desired. If a is not an array, a conversion is attempted.</param>
        /// <param name="axis">Axis or axes along which the means are computed. The default is to compute the mean of the flattened array.</param>
        /// <param name="type">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.</param>
        /// <param name="keepdims">
        ///     If this is set to True, the axes which are reduced are left in the result as dimensions with size one. With this option, the result will broadcast correctly against the input array.
        ///     If the default value is passed, then keepdims will not be passed through to the mean method of sub-classes of ndarray, however any non-default value will be.If the sub-class’ method does not implement keepdims any exceptions will be raised.
        /// </param>
        /// <returns> returns a new array containing the mean values, otherwise a reference to the output array is returned.</returns>
        /// <remarks>https://numpy.org/doc/stable/reference/generated/numpy.mean.html</remarks>
        public NDArray mean()
            => TensorEngine.Mean(this);

        /// <summary>
        ///     Compute the arithmetic mean along the specified axis.
        ///     Returns the average of the array elements.
        ///     The average is taken over the flattened array by default, otherwise over the specified axis.
        ///     float64 intermediate and return values are used for integer inputs.
        /// </summary>
        /// <param name="nd">Array containing numbers whose mean is desired. If a is not an array, a conversion is attempted.</param>
        /// <param name="axis">Axis or axes along which the means are computed. The default is to compute the mean of the flattened array.</param>
        /// <param name="type">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.</param>
        /// <param name="keepdims">
        ///     If this is set to True, the axes which are reduced are left in the result as dimensions with size one. With this option, the result will broadcast correctly against the input array.
        ///     If the default value is passed, then keepdims will not be passed through to the mean method of sub-classes of ndarray, however any non-default value will be.If the sub-class’ method does not implement keepdims any exceptions will be raised.
        /// </param>
        /// <returns> returns a new array containing the mean values, otherwise a reference to the output array is returned.</returns>
        /// <remarks>https://numpy.org/doc/stable/reference/generated/numpy.mean.html</remarks>
        public NDArray mean(int axis)
            => TensorEngine.Mean(this, axis);

        /// <summary>
        ///     Compute the arithmetic mean along the specified axis.
        ///     Returns the average of the array elements.
        ///     The average is taken over the flattened array by default, otherwise over the specified axis.
        ///     float64 intermediate and return values are used for integer inputs.
        /// </summary>
        /// <param name="nd">Array containing numbers whose mean is desired. If a is not an array, a conversion is attempted.</param>
        /// <param name="axis">Axis or axes along which the means are computed. The default is to compute the mean of the flattened array.</param>
        /// <param name="type">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.</param>
        /// <param name="keepdims">
        ///     If this is set to True, the axes which are reduced are left in the result as dimensions with size one. With this option, the result will broadcast correctly against the input array.
        ///     If the default value is passed, then keepdims will not be passed through to the mean method of sub-classes of ndarray, however any non-default value will be.If the sub-class’ method does not implement keepdims any exceptions will be raised.
        /// </param>
        /// <returns> returns a new array containing the mean values, otherwise a reference to the output array is returned.</returns>
        /// <remarks>https://numpy.org/doc/stable/reference/generated/numpy.mean.html</remarks>
        public NDArray mean(int axis, DType dtype, bool keepdims = false)
            => TensorEngine.Mean(this, axis, dtype, keepdims);

        /// <summary>
        ///     Compute the arithmetic mean along the specified axis.
        ///     Returns the average of the array elements.
        ///     The average is taken over the flattened array by default, otherwise over the specified axis.
        ///     float64 intermediate and return values are used for integer inputs.
        /// </summary>
        /// <param name="nd">Array containing numbers whose mean is desired. If a is not an array, a conversion is attempted.</param>
        /// <param name="axis">Axis or axes along which the means are computed. The default is to compute the mean of the flattened array.</param>
        /// <param name="type">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.</param>
        /// <param name="keepdims">
        ///     If this is set to True, the axes which are reduced are left in the result as dimensions with size one. With this option, the result will broadcast correctly against the input array.
        ///     If the default value is passed, then keepdims will not be passed through to the mean method of sub-classes of ndarray, however any non-default value will be.If the sub-class’ method does not implement keepdims any exceptions will be raised.
        /// </param>
        /// <returns> returns a new array containing the mean values, otherwise a reference to the output array is returned.</returns>
        public NDArray mean(int axis, bool keepdims)
            => TensorEngine.Mean(this, axis, null, keepdims);

    }
}