-
Notifications
You must be signed in to change notification settings - Fork 25.6k
Add parsing method for Matrix Stats #24746
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
tlrx
merged 3 commits into
elastic:feature/client_aggs_parsing
from
tlrx:add-parsing-matrix-stats
May 19, 2017
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
224 changes: 224 additions & 0 deletions
224
...s/src/main/java/org/elasticsearch/search/aggregations/matrix/stats/ParsedMatrixStats.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,224 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.elasticsearch.search.aggregations.matrix.stats; | ||
|
|
||
| import org.elasticsearch.common.ParseField; | ||
| import org.elasticsearch.common.xcontent.ObjectParser; | ||
| import org.elasticsearch.common.xcontent.XContentBuilder; | ||
| import org.elasticsearch.common.xcontent.XContentParser; | ||
| import org.elasticsearch.search.aggregations.ParsedAggregation; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.HashMap; | ||
| import java.util.LinkedHashMap; | ||
| import java.util.Map; | ||
| import java.util.Objects; | ||
|
|
||
| public class ParsedMatrixStats extends ParsedAggregation implements MatrixStats { | ||
|
|
||
| private final Map<String, Long> counts = new LinkedHashMap<>(); | ||
| private final Map<String, Double> means = new HashMap<>(); | ||
| private final Map<String, Double> variances = new HashMap<>(); | ||
| private final Map<String, Double> skewness = new HashMap<>(); | ||
| private final Map<String, Double> kurtosis = new HashMap<>(); | ||
| private final Map<String, Map<String, Double>> covariances = new HashMap<>(); | ||
| private final Map<String, Map<String, Double>> correlations = new HashMap<>(); | ||
|
|
||
| @Override | ||
| public String getType() { | ||
| return MatrixStatsAggregationBuilder.NAME; | ||
| } | ||
|
|
||
| @Override | ||
| public long getDocCount() { | ||
| throw new UnsupportedOperationException(); | ||
| } | ||
|
|
||
| @Override | ||
| public long getFieldCount(String field) { | ||
| if (counts.containsKey(field) == false) { | ||
| return 0; | ||
| } | ||
| return counts.get(field); | ||
| } | ||
|
|
||
| @Override | ||
| public double getMean(String field) { | ||
| return checkedGet(means, field); | ||
| } | ||
|
|
||
| @Override | ||
| public double getVariance(String field) { | ||
| return checkedGet(variances, field); | ||
| } | ||
|
|
||
| @Override | ||
| public double getSkewness(String field) { | ||
| return checkedGet(skewness, field); | ||
| } | ||
|
|
||
| @Override | ||
| public double getKurtosis(String field) { | ||
| return checkedGet(kurtosis, field); | ||
| } | ||
|
|
||
| @Override | ||
| public double getCovariance(String fieldX, String fieldY) { | ||
| if (fieldX.equals(fieldY)) { | ||
| return checkedGet(variances, fieldX); | ||
| } | ||
| return MatrixStatsResults.getValFromUpperTriangularMatrix(covariances, fieldX, fieldY); | ||
| } | ||
|
|
||
| @Override | ||
| public double getCorrelation(String fieldX, String fieldY) { | ||
| if (fieldX.equals(fieldY)) { | ||
| return 1.0; | ||
| } | ||
| return MatrixStatsResults.getValFromUpperTriangularMatrix(correlations, fieldX, fieldY); | ||
| } | ||
|
|
||
| @Override | ||
| protected XContentBuilder doXContentBody(XContentBuilder builder, Params params) throws IOException { | ||
| if (counts != null && counts.isEmpty() == false) { | ||
| builder.startArray(InternalMatrixStats.Fields.FIELDS); | ||
| for (String fieldName : counts.keySet()) { | ||
| builder.startObject(); | ||
| builder.field(InternalMatrixStats.Fields.NAME, fieldName); | ||
| builder.field(InternalMatrixStats.Fields.COUNT, getFieldCount(fieldName)); | ||
| builder.field(InternalMatrixStats.Fields.MEAN, getMean(fieldName)); | ||
| builder.field(InternalMatrixStats.Fields.VARIANCE, getVariance(fieldName)); | ||
| builder.field(InternalMatrixStats.Fields.SKEWNESS, getSkewness(fieldName)); | ||
| builder.field(InternalMatrixStats.Fields.KURTOSIS, getKurtosis(fieldName)); | ||
| { | ||
| builder.startObject(InternalMatrixStats.Fields.COVARIANCE); | ||
| Map<String, Double> covars = covariances.get(fieldName); | ||
| if (covars != null) { | ||
| for (Map.Entry<String, Double> covar : covars.entrySet()) { | ||
| builder.field(covar.getKey(), covar.getValue()); | ||
| } | ||
| } | ||
| builder.endObject(); | ||
| } | ||
| { | ||
| builder.startObject(InternalMatrixStats.Fields.CORRELATION); | ||
| Map<String, Double> correls = correlations.get(fieldName); | ||
| if (correls != null) { | ||
| for (Map.Entry<String, Double> correl : correls.entrySet()) { | ||
| builder.field(correl.getKey(), correl.getValue()); | ||
| } | ||
| } | ||
| builder.endObject(); | ||
| } | ||
| builder.endObject(); | ||
| } | ||
| builder.endArray(); | ||
| } | ||
| return builder; | ||
| } | ||
|
|
||
| private static <T> T checkedGet(final Map<String, T> values, final String fieldName) { | ||
| if (fieldName == null) { | ||
| throw new IllegalArgumentException("field name cannot be null"); | ||
| } | ||
| if (values.containsKey(fieldName) == false) { | ||
| throw new IllegalArgumentException("field " + fieldName + " does not exist"); | ||
| } | ||
| return values.get(fieldName); | ||
| } | ||
|
|
||
| private static ObjectParser<ParsedMatrixStats, Void> PARSER = | ||
| new ObjectParser<>(ParsedMatrixStats.class.getSimpleName(), true, ParsedMatrixStats::new); | ||
| static { | ||
| declareAggregationFields(PARSER); | ||
| PARSER.declareObjectArray((matrixStats, results) -> { | ||
| for (ParsedMatrixStatsResult result : results) { | ||
| final String fieldName = result.name; | ||
| matrixStats.counts.put(fieldName, result.count); | ||
| matrixStats.means.put(fieldName, result.mean); | ||
| matrixStats.variances.put(fieldName, result.variance); | ||
| matrixStats.skewness.put(fieldName, result.skewness); | ||
| matrixStats.kurtosis.put(fieldName, result.kurtosis); | ||
| matrixStats.covariances.put(fieldName, result.covariances); | ||
| matrixStats.correlations.put(fieldName, result.correlations); | ||
| } | ||
| }, (p, c) -> ParsedMatrixStatsResult.fromXContent(p), new ParseField(InternalMatrixStats.Fields.FIELDS)); | ||
| } | ||
|
|
||
| public static ParsedMatrixStats fromXContent(XContentParser parser, String name) throws IOException { | ||
| ParsedMatrixStats aggregation = PARSER.parse(parser, null); | ||
| aggregation.setName(name); | ||
| return aggregation; | ||
| } | ||
|
|
||
| static class ParsedMatrixStatsResult { | ||
|
|
||
| String name; | ||
| Long count; | ||
| Double mean; | ||
| Double variance; | ||
| Double skewness; | ||
| Double kurtosis; | ||
| Map<String, Double> covariances; | ||
| Map<String, Double> correlations; | ||
|
|
||
| private static ObjectParser<ParsedMatrixStatsResult, Void> RESULT_PARSER = | ||
| new ObjectParser<>(ParsedMatrixStatsResult.class.getSimpleName(), true, ParsedMatrixStatsResult::new); | ||
| static { | ||
| RESULT_PARSER.declareString((result, name) -> result.name = name, | ||
| new ParseField(InternalMatrixStats.Fields.NAME)); | ||
| RESULT_PARSER.declareLong((result, count) -> result.count = count, | ||
| new ParseField(InternalMatrixStats.Fields.COUNT)); | ||
| RESULT_PARSER.declareDouble((result, mean) -> result.mean = mean, | ||
| new ParseField(InternalMatrixStats.Fields.MEAN)); | ||
| RESULT_PARSER.declareDouble((result, variance) -> result.variance = variance, | ||
| new ParseField(InternalMatrixStats.Fields.VARIANCE)); | ||
| RESULT_PARSER.declareDouble((result, skewness) -> result.skewness = skewness, | ||
| new ParseField(InternalMatrixStats.Fields.SKEWNESS)); | ||
| RESULT_PARSER.declareDouble((result, kurtosis) -> result.kurtosis = kurtosis, | ||
| new ParseField(InternalMatrixStats.Fields.KURTOSIS)); | ||
|
|
||
| RESULT_PARSER.declareObject((ParsedMatrixStatsResult result, Map<String, Object> covars) -> { | ||
| result.covariances = new LinkedHashMap<>(covars.size()); | ||
| for (Map.Entry<String, Object> covar : covars.entrySet()) { | ||
| result.covariances.put(covar.getKey(), mapValueAsDouble(covar.getValue())); | ||
| } | ||
| }, (p, c) -> p.mapOrdered(), new ParseField(InternalMatrixStats.Fields.COVARIANCE)); | ||
|
|
||
| RESULT_PARSER.declareObject((ParsedMatrixStatsResult result, Map<String, Object> correls) -> { | ||
| result.correlations = new LinkedHashMap<>(correls.size()); | ||
| for (Map.Entry<String, Object> correl : correls.entrySet()) { | ||
| result.correlations.put(correl.getKey(), mapValueAsDouble(correl.getValue())); | ||
| } | ||
| }, (p, c) -> p.mapOrdered(), new ParseField(InternalMatrixStats.Fields.CORRELATION)); | ||
| } | ||
|
|
||
| private static Double mapValueAsDouble(Object value) { | ||
| if (value instanceof Double) { | ||
| return (Double) value; | ||
| } | ||
| return Double.valueOf(Objects.toString(value)); | ||
| } | ||
|
|
||
| static ParsedMatrixStatsResult fromXContent(XContentParser parser) throws IOException { | ||
| return RESULT_PARSER.parse(parser, null); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we don't render this to the REST response, but its part of the MatrixStats interface, should we either add this value to the output or remove the method from the interface?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it makes sense to add this field to the REST response. I can do that in another PR against master.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
++