Profiler Object:Column-Based Numeric Statistics: Difference between revisions
Created page with " ← Profiler Object Reference {| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #aaaaaa; font-size..." |
No edit summary |
||
Line 27: | Line 27: | ||
{| class="mw-collapsible" style="width:100%;" | {| class="mw-collapsible" style="width:100%;" | ||
|- align="left" | |- align="left" | ||
! style="color:black;"|[[Profiler Object:Column-Based Statistics|Column-Based Statistics]] | ! style="color:black; text-align:left;"|[[Profiler Object:Column-Based Statistics|Column-Based Statistics]] | ||
|- | |- | ||
|[[Profiler Object:Column-Based String Statistics|Column-Based String Statistics]] | |[[Profiler Object:Column-Based String Statistics|Column-Based String Statistics]] | ||
Line 52: | Line 52: | ||
{| class="mw-collapsible mw-collapsed" style="width:100%;" | {| class="mw-collapsible mw-collapsed" style="width:100%;" | ||
|- align="left" | |- align="left" | ||
! style="color:black;"|[[Profiler Object:Iterators|Iterators]] | ! style="color:black; text-align:left;"|[[Profiler Object:Iterators|Iterators]] | ||
|- | |- | ||
|[[Profiler Object:Column-Based Value Frequency Table Iteration|Column-Based Value Frequency Table Iteration]] | |[[Profiler Object:Column-Based Value Frequency Table Iteration|Column-Based Value Frequency Table Iteration]] | ||
Line 73: | Line 73: | ||
{| class="mw-collapsible mw-collapsed" style="width:100%;" | {| class="mw-collapsible mw-collapsed" style="width:100%;" | ||
|- align="left" | |- align="left" | ||
! style="color:black;"|[[Profiler Object:Result Codes|Result Codes]] | ! style="color:black; text-align:left;"|[[Profiler Object:Result Codes|Result Codes]] | ||
|- | |- | ||
|[[Returned Result Codes:APIs#Profiler Object|Returned Result Codes]] | |[[Returned Result Codes:APIs#Profiler Object|Returned Result Codes]] |
Revision as of 18:51, 2 February 2015
These statistics should only be retrieved after calling the ProfileData function. These values are all column-specific. Numeric statistics are computed for all column types including non numeric-based ones (such as strings, date/times, etc.)
Quartiles and Medians
A median value is the 'middle' value. That is, if one were to order a list of 100 values from lowest to highest (including duplicate values), the median value is the value of the 50th item. There are two quartile values: first and third. In our example, the first quartile would be the 25th value, and the third quartile would be the 75th value. In cases where the total number of records is not evenly divisible, then a pair of quartile values is computed: the integral quartile, which is the value closest to the quartile or median point, and the interpolated quartile, which is an interpolated quartile value.
GetColumnNumericMaxValue
This function returns the column’s largest value as sorted numerically.
This function takes one parameter.
Parameters
Name | Data Type | Description |
---|---|---|
ColumnName | String | Column Name to get the columns largest value. |
Syntax | profiler->GetColumnNumericMaxValue(columnNameStr); |
---|---|
C | double = mdProfilerGetColumnNumericMaxValue(profiler, columnNameStr); |
.Net | double = profiler.GetColumNumericMaxValue(columnNameStr); |
GetColumnNumericMinValue
This function returns the column’s smallest numeric value.
This function takes one parameter.
Parameters
Name | Data Type | Description |
---|---|---|
ColumnName | String | Column Name to get the columns smallest value. |
Syntax | profiler->GetColumnNumericMinValue(columnNameStr); |
---|---|
C | double = mdProfilerGetColumnNumericMinValue(profiler, columnNameStr); |
.Net | double = profiler.GetColumNumericMinValue(columnNameStr); |
GetColumnNumericAvgValue
This function returns the column’s numeric average value.
This function takes one parameter.
Parameters
Name | Data Type | Description |
---|---|---|
ColumnName | String | Column Name to get the columns average value. |
Syntax | profiler->GetColumnNumericAvgValue(columnNameStr); |
---|---|
C | double = mdProfilerGetColumnNumericAvgValue(profiler, columnNameStr); |
.Net | double = profiler.GetColumNumericAvgValue(columnNameStr); |
GetColumnNumericQ1Value
This function returns the column’s first interpolated quartile value.
This function takes one parameter.
Parameters
Name | Data Type | Description |
---|---|---|
ColumnName | String | Column Name to get the columns first interpolated quartile value. |
Syntax | profiler->GetColumnNumericQ1Value(columnNameStr); |
---|---|
C | double = mdProfilerGetColumnNumericQ1Value(profiler, columnNameStr); |
.Net | double = profiler.GetColumNumericQ1Value(ColumnNameStr); |
GetColumnNumericQ1IntValue
Th is function returns the column’s first integral quartile value.
This function takes one parameter.
Parameters
Name | Data Type | Description |
---|---|---|
ColumnName | String | Column Name to get the columns first integral quartile value. |
Syntax | profiler->GetColumnNumericQ1IntValue(columnNameStr); |
---|---|
C | double = mdProfilerGetColumnNumericQ1IntValue(profiler, columnNameStr); |
.Net | double = profiler.GetColumNumericQ1IntValue(columnNameStr); |
GetColumnNumericMedValue
This function returns the column’s interpolated median value.
This function takes one parameter.
Parameters
Name | Data Type | Description |
---|---|---|
ColumnName | String | Column Name to get the columns interpolated median value. |
Syntax | profiler->GetColumnNumericMedValue(columnNameStr); |
---|---|
C | double = mdProfilerGetColumnNumericMedValue(profiler, columnNameStr); |
.Net | double = profiler.GetColumNumericMedValue(columnNameStr); |
GetColumnNumericMedIntValue
This function returns the column’s Integral median quartile value.
This function takes one parameter.
Parameters
Name | Data Type | Description |
---|---|---|
ColumnName | String | Column Name to get the columns integral median quartile value. |
Syntax | profiler->GetColumnNumericMedIntValue(columnNameStr); |
---|---|
C | double = mdProfilerGetColumnNumericMedIntValue(profiler, columnNameStr); |
.Net | double = profiler.GetColumNumericMedIntValue(columnNameStr); |
GetColumnNumericQ3Value
This function returns the column’s third interpolated quartile value.
This function takes one parameter.
Parameters
Name | Data Type | Description |
---|---|---|
ColumnName | String | Column Name to get the columns third interpolated quartile value. |
Syntax | profiler->GetColumnNumericQ3Value(columnNameStr); |
---|---|
C | double = mdProfilerGetColumnNumericQ3Value(profiler, columnNameStr); |
.Net | double = profiler.GetColumNumericQ3Value(columnNameStr); |
GetColumnNumericQ3IntValue
This function returns the column’s third integral quartile value.
This function takes one parameter.
Parameters
Name | Data Type | Description |
---|---|---|
ColumnName | String | Column Name to get the columns third integral quartile value. |
Syntax | profiler->GetColumnNumericQ3IntValue(columnNameStr); |
---|---|
C | double = mdProfilerGetColumnNumericQ3IntValue(profiler, columnNameStr); |
.Net | double = profiler.GetColumNumericQ3IntValue(columnNameStr); |
GetColumnNumericStdDevValue
This function returns the column’s standard deviation value.
This function takes one parameter.
Parameters
Name | Data Type | Description |
---|---|---|
ColumnName | String | Column Name to get the columns standard deviation value. |
Syntax | profiler->GetColumnNumericStdDevValue(columnNameStr); |
---|---|
C | double = mdProfilerGetColumnNumericStdDevValue(profiler, columnNameStr); |
.Net | double = profiler.GetColumNumericStdDevValue(columnNameStr); |