Class DoubleVectorSummary

Implements to collect all entries of a column in a sorted vector. Provides statistical functions that work on this set such as Median, Percentile25, Percentile75, and PercentileQ.

Inheritance

System.Object

SummaryBase

DoubleVectorSummary

Implements

ITreeTableSummary

ICountAggregate

Inherited Members

SummaryBase.Info

SummaryBase.ITreeTableSummary.Combine(ITreeTableSummary)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Syncfusion.Grouping

Assembly: Syncfusion.Grouping.Base.dll

Syntax

public class DoubleVectorSummary : SummaryBase, ITreeTableSummary, ICountAggregate

Constructors

DoubleVectorSummary(Double[], Int32)

Initializes a new instance of DoubleVectorSummary class with the specified values.

Declaration

public DoubleVectorSummary(double[] values, int _length)

Parameters

Type	Name	Description
System.Double[]	values	An object array containing summary values.
System.Int32	_length	Number of values.

Fields

Empty

The initial summary object for empty records or tables.

Declaration

public static readonly DoubleVectorSummary Empty

Field Value

Type
DoubleVectorSummary

Properties

Count

Gets the number of elements in the vector.

Declaration

public int Count { get; }

Property Value

Type
System.Int32

Median

Gets the statistical median.

Declaration

public double Median { get; }

Property Value

Type
System.Double

Percentile25

Gets the statistical Percentile25.

Declaration

public double Percentile25 { get; }

Property Value

Type
System.Double

Percentile75

Gets the statistical Percentile75.

Declaration

public double Percentile75 { get; }

Property Value

Type
System.Double

PercentileQ

Gets the statistical PercentileQ.

Declaration

public double PercentileQ { get; }

Property Value

Type
System.Double

Values

Gets the array with values in the vector.

Declaration

public double[] Values { get; }

Property Value

Type
System.Double[]

Methods

Combine(DoubleVectorSummary)

Combines the values of this summary with another summary and returns a new summary object.

Declaration

public DoubleVectorSummary Combine(DoubleVectorSummary other)

Parameters

Type	Name	Description
DoubleVectorSummary	other	Another summary object (of the same type).

Returns

Type	Description
DoubleVectorSummary	A new summary object with combined values of both summaries.

Combine(SummaryBase)

Combines the values of this summary with another summary and returns a new summary object.

Declaration

public override SummaryBase Combine(SummaryBase other)

Parameters

Type	Name	Description
SummaryBase	other	Another summary object.

Returns

Type	Description
SummaryBase	A new summary object with combined values of both summaries.

Overrides

SummaryBase.Combine(SummaryBase)

CombineHelper(DoubleVectorSummary, Boolean, out Int32)

Combines the values of this summary with another summary and returns a new summary object.

Declaration

protected double[] CombineHelper(DoubleVectorSummary other, bool distinct, out int length)

Parameters

Type	Name	Description
DoubleVectorSummary	other	Another summary object (of the same type).
System.Boolean	distinct	True if vector should only contain unique values; False if duplicates are allowed.
System.Int32	length	The resulting length of the vector.

Returns

Type	Description
System.Double[]	A new summary object with combined values of both summaries.

CreatePageSummaryMethod(SummaryDescriptor, Record)

Used to interface with the page summary .

Declaration

public static ITreeTableSummary CreatePageSummaryMethod(SummaryDescriptor sd, Record record)

Parameters

Type	Name	Description
SummaryDescriptor	sd	Summary descriptor
Record	record	Record values.

Returns

Type	Description
ITreeTableSummary	An instance of the DoubleVectorSummary class.

CreateSummaryMethod(SummaryDescriptor, Record)

Creates a summary object for the specified SummaryDescriptor and Record.

Declaration

public static ITreeTableSummary CreateSummaryMethod(SummaryDescriptor sd, Record record)

Parameters

Type	Name	Description
SummaryDescriptor	sd	The summary descriptor.
Record	record	The record with data.

Returns

Type	Description
ITreeTableSummary	A new summary object.

ToString()

Returns string representation of the summary object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	String representation of the current object.

Overrides

System.Object.ToString()

Implements

ITreeTableSummary

ICountAggregate