Package org.opensearch.search.aggregations.matrix.stats

Class InternalMatrixStats

java.lang.Object

org.opensearch.search.aggregations.InternalAggregation

org.opensearch.search.aggregations.matrix.stats.InternalMatrixStats

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, Aggregation, MatrixStats

public class InternalMatrixStats
extends InternalAggregation
implements MatrixStats

Computes distribution statistics over multiple fields

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.InternalAggregation

InternalAggregation.ReduceContext, InternalAggregation.ReduceContextBuilder

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.Aggregation

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields inherited from class org.opensearch.search.aggregations.InternalAggregation

metadata, name

Fields inherited from interface org.opensearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
InternalMatrixStats(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected void	doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
org.opensearch.core.xcontent.XContentBuilder	doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
boolean	equals(Object obj)
double	getCorrelation(String fieldX, String fieldY)	get the correlation between the two fields
double	getCovariance(String fieldX, String fieldY)	get the covariance between the two fields
long	getDocCount()	get the number of documents
long	getFieldCount(String field)	get the number of samples for the given field.
double	getKurtosis(String field)	get the distribution shape for the given field
double	getMean(String field)	get the mean for the given field
Object	getProperty(List<String> path)
double	getSkewness(String field)	get the distribution skewness for the given field
double	getVariance(String field)	get the variance for the given field
String	getWriteableName()
int	hashCode()
protected boolean	mustReduceOnSingleInternalAgg()
InternalAggregation	reduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)

Methods inherited from class org.opensearch.search.aggregations.InternalAggregation

copyWithRewritenBuckets, forEachBucket, getMetadata, getName, getProperty, getType, isMapped, mergePipelineTreeForBWCSerialization, pipelineAggregatorsForBwcSerialization, readSize, reducePipelines, sortValue, sortValue, toString, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.search.aggregations.Aggregation

getMetadata, getName, getType

Methods inherited from interface org.opensearch.core.xcontent.ToXContent

toXContent

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

Constructor Details

InternalMatrixStats

public InternalMatrixStats(org.opensearch.core.common.io.stream.StreamInput in)
                    throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface org.opensearch.core.common.io.stream.NamedWriteable

getDocCount

public long getDocCount()

get the number of documents

Specified by:

getDocCount in interface MatrixStats

getFieldCount

public long getFieldCount(String field)

get the number of samples for the given field. == docCount - numMissing

Specified by:

getFieldCount in interface MatrixStats

getMean

public double getMean(String field)

get the mean for the given field

Specified by:

getMean in interface MatrixStats

getVariance

public double getVariance(String field)

get the variance for the given field

Specified by:

getVariance in interface MatrixStats

getSkewness

public double getSkewness(String field)

get the distribution skewness for the given field

Specified by:

getSkewness in interface MatrixStats

getKurtosis

public double getKurtosis(String field)

get the distribution shape for the given field

Specified by:

getKurtosis in interface MatrixStats

getCovariance

public double getCovariance(String fieldX,
 String fieldY)

get the covariance between the two fields

Specified by:

getCovariance in interface MatrixStats

getCorrelation

public double getCorrelation(String fieldX,
 String fieldY)

get the correlation between the two fields

Specified by:

getCorrelation in interface MatrixStats

doXContentBody

public org.opensearch.core.xcontent.XContentBuilder doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                            throws IOException

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException

getProperty

public Object getProperty(List<String> path)

Specified by:

getProperty in class InternalAggregation

reduce

public InternalAggregation reduce(List<InternalAggregation> aggregations,
 InternalAggregation.ReduceContext reduceContext)

Specified by:

reduce in class InternalAggregation

mustReduceOnSingleInternalAgg

protected boolean mustReduceOnSingleInternalAgg()

Specified by:

mustReduceOnSingleInternalAgg in class InternalAggregation

hashCode

public int hashCode()

Overrides:

hashCode in class InternalAggregation

equals

public boolean equals(Object obj)

Overrides:

equals in class InternalAggregation