Interface MatrixStats
- All Superinterfaces:
org.elasticsearch.search.aggregations.Aggregation
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentFragment
- All Known Implementing Classes:
InternalMatrixStats
,ParsedMatrixStats
public interface MatrixStats
extends org.elasticsearch.search.aggregations.Aggregation
Interface for MatrixStats Metric Aggregation
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation
org.elasticsearch.search.aggregations.Aggregation.CommonFields
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
-
Field Summary
Fields inherited from interface org.elasticsearch.search.aggregations.Aggregation
TYPED_KEYS_DELIMITER
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Method Summary
Modifier and TypeMethodDescriptiondouble
getCorrelation
(String fieldX, String fieldY) return the correlation coefficient of field x and field ydouble
getCovariance
(String fieldX, String fieldY) return the covariance between field x and field ylong
return the total document countlong
getFieldCount
(String field) return total field count (differs from docCount if there are missing values)double
getKurtosis
(String field) return the kurtosis of the distributiondouble
return the field meandouble
getSkewness
(String field) return the skewness of the distributiondouble
getVariance
(String field) return the field varianceMethods inherited from interface org.elasticsearch.search.aggregations.Aggregation
getMetadata, getName, getType
Methods inherited from interface org.elasticsearch.xcontent.ToXContent
toXContent
Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Method Details
-
getDocCount
long getDocCount()return the total document count -
getFieldCount
return total field count (differs from docCount if there are missing values) -
getMean
return the field mean -
getVariance
return the field variance -
getSkewness
return the skewness of the distribution -
getKurtosis
return the kurtosis of the distribution -
getCovariance
return the covariance between field x and field y -
getCorrelation
return the correlation coefficient of field x and field y
-