StandardDeviation.cs

using System;
using System.Numerics;
using Waher.Script.Abstraction.Elements;
using Waher.Script.Exceptions;
using Waher.Script.Model;
using Waher.Script.Objects;
using Waher.Script.Objects.VectorSpaces;
 
namespace Waher.Script.Functions.Vectors
{
    public class StandardDeviation : FunctionOneVectorVariable
    {
        public StandardDeviation(ScriptNode Argument, int Start, int Length, Expression Expression)
            : base(Argument, Start, Length, Expression)
        {
        }
 
        public override string FunctionName => nameof(StandardDeviation);
 
        public override string[] Aliases
        {
            get { return new string[] { "stddev" }; }
        }
 
        public override IElement EvaluateVector(DoubleVector Argument, Variables Variables)
        {
            return new DoubleNumber(CalcStandardDeviation(Argument.Values, this));
        }
 
        public static double CalcStandardDeviation(double[] Values, ScriptNode Node)
        {
            double Avg = Average.CalcAverage(Values, Node);
            double Result = 0;
            double d;
            int i, c = Values.Length;
 
            if (c == 1)
                return 0;
 
            for (i = 0; i < c; i++)
            {
                d = (Values[i] - Avg);
                Result += d * d;
            }
 
            Result /= (c - 1);
 
            return Math.Sqrt(Result);
        }
 
        public override IElement EvaluateVector(ComplexVector Argument, Variables Variables)
        {
            return new ComplexNumber(CalcStandardDeviation(Argument.Values, this));
        }
 
        public static Complex CalcStandardDeviation(Complex[] Values, ScriptNode Node)
        {
            Complex Avg = Average.CalcAverage(Values, Node);
            Complex Result = 0;
            Complex d;
            int i, c = Values.Length;
 
            if (c == 1)
                return Complex.Zero;
 
            for (i = 0; i < c; i++)
            {
                d = (Values[i] - Avg);
                Result += d * d;
            }
 
            Result /= (c - 1);
 
            return Complex.Sqrt(Result);
        }
 
        public override IElement EvaluateVector(IVector Argument, Variables Variables)
        {
            throw new ScriptRuntimeException("Expected a numeric vector.", this);
        }
 
    }
}