np.var.cs

using System;
using NumSharp.Backends;

namespace NumSharp
{
    public static partial class np
    {
        /// <summary>
        ///     Compute the variance of the flattened array.
        ///     Returns the variance, a measure of the spread of a distribution, of the array elements.
        /// </summary>
        /// <param name="a">Calculate the variance of these values.</param>
        /// <param name="keepdims">If true, the reduced axes are left in the result as size-one dimensions.</param>
        /// <param name="ddof">Delta Degrees of Freedom. The divisor used is N - ddof (default 0).</param>
        /// <param name="dtype">The <see cref="DType"/> the computation/result should use (a C# <see cref="System.Type"/>, an <see cref="NPTypeCode"/> or a NumPy dtype string all convert implicitly).</param>
        /// <returns>A new array containing the variance values, or a reference to the output array.</returns>
        /// <remarks>https://numpy.org/doc/stable/reference/generated/numpy.var.html</remarks>
        public static NDArray var(NDArray a, bool keepdims = false, int? ddof = null, DType dtype = null)
            => a.TensorEngine.ReduceVar(a, null, keepdims, ddof, dtype);

        /// <summary>
        ///     Compute the variance along the specified axis.
        /// </summary>
        /// <param name="a">Calculate the variance of these values.</param>
        /// <param name="axis">Axis along which the variance is computed.</param>
        /// <param name="keepdims">If true, the reduced axes are left in the result as size-one dimensions.</param>
        /// <param name="ddof">Delta Degrees of Freedom. The divisor used is N - ddof (default 0).</param>
        /// <param name="dtype">The <see cref="DType"/> the computation/result should use (implicit from <see cref="System.Type"/> / <see cref="NPTypeCode"/> / NumPy dtype string).</param>
        /// <returns>A new array containing the variance values, or a reference to the output array.</returns>
        /// <remarks>https://numpy.org/doc/stable/reference/generated/numpy.var.html</remarks>
        public static NDArray var(NDArray a, int axis, bool keepdims = false, int? ddof = null, DType dtype = null)
            => a.TensorEngine.ReduceVar(a, axis, keepdims, ddof, dtype);
    }
}