StatSumOfSquaredDeviations(DoubleMatrix, DataOperation) Method

Returns the sum of squared deviations of each row or column in the specified data.

Definition

Namespace: Novacta.Analytics
Assembly: Novacta.Analytics (in Novacta.Analytics.dll) Version: 2.1.0+428f3840cfab98dda567bb0ed350b302533e273a

C#

public static DoubleMatrix SumOfSquaredDeviations(
	DoubleMatrix data,
	DataOperation dataOperation
)

VB

Public Shared Function SumOfSquaredDeviations ( 
	data As DoubleMatrix,
	dataOperation As DataOperation
) As DoubleMatrix

C++

public:
static DoubleMatrix^ SumOfSquaredDeviations(
	DoubleMatrix^ data, 
	DataOperation dataOperation
)

F#

static member SumOfSquaredDeviations : 
        data : DoubleMatrix * 
        dataOperation : DataOperation -> DoubleMatrix

Parameters

data DoubleMatrix: The data.
dataOperation DataOperation: A constant to specify if the sum of squared deviations is to be computed for rows or columns.

Return Value

DoubleMatrix
The sum of squared deviations of each row or column in the specified data.

Remarks

This method returns the sum of squared deviations of rows or columns of data from their arithmetic means. Let LaTeX equation and be the data number of rows and columns, respectively, and define

Operating on rows

If dataOperation is OnRows, then the method returns a column vector whose length equals the number of rows of data. The i-th entry of such column returns the sum of squared deviations of the i-th data row.

The sum of squared deviations of the i-th row can be represented by the expression

LaTeX equation

where

is the arithmetic mean of the i-th row.

Operating on columns

If dataOperation is OnColumns, then the method returns a row vector whose length is the data number of columns. The j-th entry of the returned row exposes the sum of squared deviations of the j-th data column.

The sum of squared deviations of the j-th column can be represented by the expression

LaTeX equation

where

is the arithmetic mean of the j-th column.

Example

In the following example, row and column sums of squared deviations in a data matrix are computed.

C#

using System;

namespace Novacta.Analytics.CodeExamples
{
    public class SumOfSquaredDeviationsExample0  
    {
        public void Main()
        {
            // Create a matrix.
            var data = new double[6] {
                1, 2,
                2, 3,
                3, 4
            };
            var matrix = DoubleMatrix.Dense(3, 2, data, StorageOrder.RowMajor);
            Console.WriteLine("The data matrix:");
            Console.WriteLine(matrix);

            // Compute the sum of squared deviations on columns.
            var sumOfSquaredDevsOnColumns = Stat.SumOfSquaredDeviations(matrix, DataOperation.OnColumns);

            Console.WriteLine();
            Console.WriteLine("SumOfSquaredDeviations on columns:");
            Console.WriteLine(sumOfSquaredDevsOnColumns);

            // SumOfSquaredDeviations is overloaded to accept data as a read-only matrix:
            // compute the sum of squared deviations on rows using a read-only wrapper of the data matrix.
            ReadOnlyDoubleMatrix readOnlyMatrix = matrix.AsReadOnly();
            var sumOfSquaredDevsOnRows = Stat.SumOfSquaredDeviations(readOnlyMatrix, DataOperation.OnRows);

            Console.WriteLine();
            Console.WriteLine("SumOfSquaredDeviations on rows:");
            Console.WriteLine(sumOfSquaredDevsOnRows);
        }
    }
}

// Executing method Main() produces the following output:
// 
// The data matrix:
// 1                2                
// 2                3                
// 3                4                
// 
// 
// 
// SumOfSquaredDeviations on columns:
// 2                2                
// 
// 
// 
// SumOfSquaredDeviations on rows:
// 0.5              
// 0.5              
// 0.5              
// 
//

Exceptions

ArgumentNullException	data is null.
ArgumentException	dataOperation is not a field of DataOperation.