Class Aggregate

Use an Aggregate object to specify each aggregate that comprises an AggregateCombo object. There are a variety of factory methods here; however, it is typically easier to use the convenience methods in DeephavenImports, like so:

using static Deephaven.OpenAPI.Client.DeephavenImports;
...
var t2 = t.View(close)
  .By(AggCombo(
    AggAvg(close.As("AvgClose")),
    AggSum(close.As("SumClose")),
    AggMin(close.As("MinClose")),
    AggMax(close.As("MaxClose")),
    AggCount("Count")));

Inheritance

System.Object

Aggregate

Namespace: Deephaven.OpenAPI.Client

Assembly: DeephavenOpenAPI.dll

Syntax

public class Aggregate : object

Methods

AbsSum()

This method exists to resolve the ambiguity that would otherwise exist between AbsSum(String[]) and AbsSum(ISelectColumn[]) if the caller were ever to invoke it with no arguments.

Declaration

public static Aggregate AbsSum()

Returns

Type	Description
Aggregate

AbsSum(ISelectColumn[])

Calculates the sum of the absolute value of the values in each specified column.

Declaration

public static Aggregate AbsSum(params ISelectColumn[] columns)

Parameters

Type	Name	Description
ISelectColumn[]	columns	Columns or column rename expressions like foo.As("Bar")

Returns

Type	Description
Aggregate

AbsSum(String[])

Calculates the sum of the absolute value of the values in each specified column.

Declaration

public static Aggregate AbsSum(params string[] columns)

Parameters

Type	Name	Description
System.String[]	columns	Column names or rename expressions like "Foo=Bar"

Returns

Type	Description
Aggregate

Array()

This method exists to resolve the ambiguity that would otherwise exist between Array(String[]) and Array(ISelectColumn[]) if the caller were ever to invoke it with no arguments.

Declaration

public static Aggregate Array()

Returns

Type	Description
Aggregate

Array(ISelectColumn[])

Combines the values in each specified column into an array.

Declaration

public static Aggregate Array(params ISelectColumn[] columns)

Parameters

Type	Name	Description
ISelectColumn[]	columns	Column names or column rename expressions like foo.As("Bar")

Returns

Type	Description
Aggregate

Array(String[])

Combines the values in each specified column into an array.

Declaration

public static Aggregate Array(params string[] columns)

Parameters

Type	Name	Description
System.String[]	columns	Column names or rename expressions like "Foo=Bar"

Returns

Type	Description
Aggregate

Avg()

This method exists to resolve the ambiguity that would otherwise exist between Avg(String[]) and Avg(ISelectColumn[]) if the caller were ever to invoke it with no arguments.

Declaration

public static Aggregate Avg()

Returns

Type	Description
Aggregate

Avg(ISelectColumn[])

Calculates the average of each specified column into an array.

Declaration

public static Aggregate Avg(params ISelectColumn[] columns)

Parameters

Type	Name	Description
ISelectColumn[]	columns	Columns or column rename expressions like foo.As("Bar")

Returns

Type	Description
Aggregate

Avg(String[])

Calculates the average of each specified column into an array.

Declaration

public static Aggregate Avg(params string[] columns)

Parameters

Type	Name	Description
System.String[]	columns	Column names or rename expressions like "Foo=Bar"

Returns

Type	Description
Aggregate

Count(ISelectColumn)

Calculates the average of each specified column into an array.

Declaration

public static Aggregate Count(ISelectColumn resultColumn)

Parameters

Type	Name	Description
ISelectColumn	resultColumn	Columns or column rename expression like foo.As("Bar")

Returns

Type	Description
Aggregate

Count(String)

Calculates the number of rows in the specified column.

Declaration

public static Aggregate Count(string resultColumn)

Parameters

Type	Name	Description
System.String	resultColumn	Column name or rename expression like "Foo=Bar"

Returns

Type	Description
Aggregate

First()

This method exists to resolve the ambiguity that would otherwise exist between First(String[]) and First(ISelectColumn[]) if the caller were ever to invoke it with no arguments.

Declaration

public static Aggregate First()

Returns

Type	Description
Aggregate

First(ISelectColumn[])

Gets the first row of each specified column.

Declaration

public static Aggregate First(params ISelectColumn[] columns)

Parameters

Type	Name	Description
ISelectColumn[]	columns	Columns or column rename expressions like foo.As("Bar")

Returns

Type	Description
Aggregate

First(String[])

Gets the first row of each specified column.

Declaration

public static Aggregate First(params string[] columns)

Parameters

Type	Name	Description
System.String[]	columns	Column names or rename expressions like "Foo=Bar"

Returns

Type	Description
Aggregate

Last()

This method exists to resolve the ambiguity that would otherwise exist between Last(String[]) and Last(ISelectColumn[]) if the caller were ever to invoke it with no arguments.

Declaration

public static Aggregate Last()

Returns

Type	Description
Aggregate

Last(ISelectColumn[])

Gets the last row of each specified column.

Declaration

public static Aggregate Last(params ISelectColumn[] columns)

Parameters

Type	Name	Description
ISelectColumn[]	columns	Columns or column rename expressions like foo.As("Bar")

Returns

Type	Description
Aggregate

Last(String[])

Gets the last row of each specified column.

Declaration

public static Aggregate Last(params string[] columns)

Parameters

Type	Name	Description
System.String[]	columns	Column names or rename expressions like "Foo=Bar"

Returns

Type	Description
Aggregate

Max()

This method exists to resolve the ambiguity that would otherwise exist between Max(String[]) and Max(ISelectColumn[]) if the caller were ever to invoke it with no arguments.

Declaration

public static Aggregate Max()

Returns

Type	Description
Aggregate

Max(ISelectColumn[])

Gets the maximum value of each specified column.

Declaration

public static Aggregate Max(params ISelectColumn[] columns)

Parameters

Type	Name	Description
ISelectColumn[]	columns	Columns or column rename expressions like foo.As("Bar")

Returns

Type	Description
Aggregate

Max(String[])

Gets the maximum value of each specified column.

Declaration

public static Aggregate Max(params string[] columns)

Parameters

Type	Name	Description
System.String[]	columns	Column names or rename expressions like "Foo=Bar"

Returns

Type	Description
Aggregate

Med()

This method exists to resolve the ambiguity that would otherwise exist between Med(String[]) and Med(ISelectColumn[]) if the caller were ever to invoke it with no arguments.

Declaration

public static Aggregate Med()

Returns

Type	Description
Aggregate

Med(ISelectColumn[])

Gets the median value of each specified column.

Declaration

public static Aggregate Med(params ISelectColumn[] columns)

Parameters

Type	Name	Description
ISelectColumn[]	columns	Columns or column rename expressions like foo.As("Bar")

Returns

Type	Description
Aggregate

Med(String[])

Gets the median value of each specified column.

Declaration

public static Aggregate Med(params string[] columns)

Parameters

Type	Name	Description
System.String[]	columns	Column names or rename expressions like "Foo=Bar"

Returns

Type	Description
Aggregate

Min()

This method exists to resolve the ambiguity that would otherwise exist between Min(String[]) and Min(ISelectColumn[]) if the caller were ever to invoke it with no arguments.

Declaration

public static Aggregate Min()

Returns

Type	Description
Aggregate

Min(ISelectColumn[])

Gets the mininum value of each specified column.

Declaration

public static Aggregate Min(params ISelectColumn[] columns)

Parameters

Type	Name	Description
ISelectColumn[]	columns	Columns or column rename expressions like foo.As("Bar")

Returns

Type	Description
Aggregate

Min(String[])

Gets the minimum value of each specified column.

Declaration

public static Aggregate Min(params string[] columns)

Parameters

Type	Name	Description
System.String[]	columns	Column names or rename expressions like "Foo=Bar"

Returns

Type	Description
Aggregate

Pct(Double)

This method exists to resolve the ambiguity that would otherwise exist between Pct(Double, String[]) and Pct(Double, ISelectColumn[]) if the caller were ever to invoke it with no arguments.

Declaration

public static Aggregate Pct(double percentile)

Parameters

Type	Name	Description
System.Double	percentile

Returns

Type	Description
Aggregate

Pct(Double, ISelectColumn[])

Gets the value at the given percentile for each specified column.

Declaration

public static Aggregate Pct(double percentile, params ISelectColumn[] columns)

Parameters

Type	Name	Description
System.Double	percentile	The specified percentile
ISelectColumn[]	columns	Columns or column rename expressions like foo.As("Bar")

Returns

Type	Description
Aggregate

Pct(Double, Boolean)

This method exists to resolve the ambiguity that would otherwise exist between Pct(Double, Boolean, String[]) and Pct(Double, Boolean, ISelectColumn[]) if the caller were ever to invoke it with no arguments.

Declaration

public static Aggregate Pct(double percentile, bool avgMedian)

Parameters

Type	Name	Description
System.Double	percentile
System.Boolean	avgMedian

Returns

Type	Description
Aggregate

Pct(Double, Boolean, ISelectColumn[])

Gets the value at the given percentile for each specified column.

Declaration

public static Aggregate Pct(double percentile, bool avgMedian, params ISelectColumn[] columns)

Parameters

Type	Name	Description
System.Double	percentile	The specified percentile
System.Boolean	avgMedian	TODO (kosak)
ISelectColumn[]	columns	Columns or column rename expressions like foo.As("Bar")

Returns

Type	Description
Aggregate

Pct(Double, Boolean, String[])

Gets the value at the given percentile for each specified column.

Declaration

public static Aggregate Pct(double percentile, bool avgMedian, params string[] columns)

Parameters

Type	Name	Description
System.Double	percentile	The specified percentile
System.Boolean	avgMedian	TODO (kosak)
System.String[]	columns	Column names or rename expressions like "Foo=Bar"

Returns

Type	Description
Aggregate

Pct(Double, String[])

Gets the value at the given percentile for each specified column.

Declaration

public static Aggregate Pct(double percentile, params string[] columns)

Parameters

Type	Name	Description
System.Double	percentile	The specified percentile
System.String[]	columns	Column names or rename expressions like "Foo=Bar"

Returns

Type	Description
Aggregate

Std()

This method exists to resolve the ambiguity that would otherwise exist between Std(String[]) and Std(ISelectColumn[]) if the caller were ever to invoke it with no arguments.

Declaration

public static Aggregate Std()

Returns

Type	Description
Aggregate

Std(ISelectColumn[])

Calculates the standard deviation for each specified column.

Declaration

public static Aggregate Std(params ISelectColumn[] columns)

Parameters

Type	Name	Description
ISelectColumn[]	columns	Columns or column rename expressions like foo.As("Bar")

Returns

Type	Description
Aggregate

Std(String[])

Calculates the standard deviation for each specified column.

Declaration

public static Aggregate Std(params string[] columns)

Parameters

Type	Name	Description
System.String[]	columns	Column names or rename expressions like "Foo=Bar"

Returns

Type	Description
Aggregate

Sum()

This method exists to resolve the ambiguity that would otherwise exist between Sum(String[]) and Sum(ISelectColumn[]) if the caller were ever to invoke it with no arguments.

Declaration

public static Aggregate Sum()

Returns

Type	Description
Aggregate

Sum(ISelectColumn[])

Calculates the sum of each specified column.

Declaration

public static Aggregate Sum(params ISelectColumn[] columns)

Parameters

Type	Name	Description
ISelectColumn[]	columns	Columns or column rename expressions like foo.As("Bar")

Returns

Type	Description
Aggregate

Sum(String[])

Calculates the sum of each specified column.

Declaration

public static Aggregate Sum(params string[] columns)

Parameters

Type	Name	Description
System.String[]	columns	Column names or rename expressions like "Foo=Bar"

Returns

Type	Description
Aggregate

Var()

This method exists to resolve the ambiguity that would otherwise exist between Var(String[]) and Var(ISelectColumn[]) if the caller were ever to invoke it with no arguments.

Declaration

public static Aggregate Var()

Returns

Type	Description
Aggregate

Var(ISelectColumn[])

Calculates the variance of each specified column.

Declaration

public static Aggregate Var(params ISelectColumn[] columns)

Parameters

Type	Name	Description
ISelectColumn[]	columns	Columns or column rename expressions like foo.As("Bar")

Returns

Type	Description
Aggregate

Var(String[])

Calculates the variance of each specified column.

Declaration

public static Aggregate Var(params string[] columns)

Parameters

Type	Name	Description
System.String[]	columns	Column names or rename expressions like "Foo=Bar"

Returns

Type	Description
Aggregate

WAvg(ISelectColumn, ISelectColumn[])

Calculates the weighted average of the specified columns.

Declaration

public static Aggregate WAvg(ISelectColumn weightColumn, params ISelectColumn[] columns)

Parameters

Type	Name	Description
ISelectColumn	weightColumn	The weight column. This is mulitplied by the values in each other column."
ISelectColumn[]	columns	Columns or column rename expressions like foo.As("Bar")

Returns

Type	Description
Aggregate

WAvg(String)

This method exists to resolve the ambiguity that would otherwise exist between WAvg(String, String[]) and WAvg(ISelectColumn, ISelectColumn[]) if the caller were ever to invoke it with no arguments.

Declaration

public static Aggregate WAvg(string weightColumn)

Parameters

Type	Name	Description
System.String	weightColumn

Returns

Type	Description
Aggregate

WAvg(String, String[])

Calculates the weighted average of the specified columns.

Declaration

public static Aggregate WAvg(string weightColumn, params string[] columns)

Parameters

Type	Name	Description
System.String	weightColumn	The weight column. This is mulitplied by the values in each other column."
System.String[]	columns	Columns or column rename expressions like foo.As("Bar")

Returns

Type	Description
Aggregate