aboutsummaryrefslogtreecommitdiff
path: root/icing/join/aggregation-scorer.cc
blob: 3dee3dd3d98cdd64f3adb8597cf318d5b7ab2e20 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
// Copyright (C) 2022 Google LLC
//
// Licensed 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.

#include "icing/join/aggregation-scorer.h"

#include <algorithm>
#include <memory>
#include <numeric>
#include <vector>

#include "icing/proto/search.pb.h"
#include "icing/scoring/scored-document-hit.h"

namespace icing {
namespace lib {

class CountAggregationScorer : public AggregationScorer {
 public:
  double GetScore(const ScoredDocumentHit& parent,
                  const std::vector<ScoredDocumentHit>& children) override {
    return children.size();
  }
};

class MinAggregationScorer : public AggregationScorer {
 public:
  double GetScore(const ScoredDocumentHit& parent,
                  const std::vector<ScoredDocumentHit>& children) override {
    if (children.empty()) {
      // Return 0 if there is no child document.
      // For non-empty children with negative scores, they are considered "worse
      // than" 0, so it is correct to return 0 for empty children to assign it a
      // rank higher than non-empty children with negative scores.
      return 0.0;
    }
    return std::min_element(children.begin(), children.end(),
                            [](const ScoredDocumentHit& lhs,
                               const ScoredDocumentHit& rhs) -> bool {
                              return lhs.score() < rhs.score();
                            })
        ->score();
  }
};

class AverageAggregationScorer : public AggregationScorer {
 public:
  double GetScore(const ScoredDocumentHit& parent,
                  const std::vector<ScoredDocumentHit>& children) override {
    if (children.empty()) {
      // Return 0 if there is no child document.
      // For non-empty children with negative scores, they are considered "worse
      // than" 0, so it is correct to return 0 for empty children to assign it a
      // rank higher than non-empty children with negative scores.
      return 0.0;
    }
    return std::reduce(
               children.begin(), children.end(), 0.0,
               [](double prev, const ScoredDocumentHit& item) -> double {
                 return prev + item.score();
               }) /
           children.size();
  }
};

class MaxAggregationScorer : public AggregationScorer {
 public:
  double GetScore(const ScoredDocumentHit& parent,
                  const std::vector<ScoredDocumentHit>& children) override {
    if (children.empty()) {
      // Return 0 if there is no child document.
      // For non-empty children with negative scores, they are considered "worse
      // than" 0, so it is correct to return 0 for empty children to assign it a
      // rank higher than non-empty children with negative scores.
      return 0.0;
    }
    return std::max_element(children.begin(), children.end(),
                            [](const ScoredDocumentHit& lhs,
                               const ScoredDocumentHit& rhs) -> bool {
                              return lhs.score() < rhs.score();
                            })
        ->score();
  }
};

class SumAggregationScorer : public AggregationScorer {
 public:
  double GetScore(const ScoredDocumentHit& parent,
                  const std::vector<ScoredDocumentHit>& children) override {
    return std::reduce(
        children.begin(), children.end(), 0.0,
        [](double prev, const ScoredDocumentHit& item) -> double {
          return prev + item.score();
        });
  }
};

class DefaultAggregationScorer : public AggregationScorer {
 public:
  double GetScore(const ScoredDocumentHit& parent,
                  const std::vector<ScoredDocumentHit>& children) override {
    return parent.score();
  }
};

std::unique_ptr<AggregationScorer> AggregationScorer::Create(
    const JoinSpecProto& join_spec) {
  switch (join_spec.aggregation_scoring_strategy()) {
    case JoinSpecProto::AggregationScoringStrategy::COUNT:
      return std::make_unique<CountAggregationScorer>();
    case JoinSpecProto::AggregationScoringStrategy::MIN:
      return std::make_unique<MinAggregationScorer>();
    case JoinSpecProto::AggregationScoringStrategy::AVG:
      return std::make_unique<AverageAggregationScorer>();
    case JoinSpecProto::AggregationScoringStrategy::MAX:
      return std::make_unique<MaxAggregationScorer>();
    case JoinSpecProto::AggregationScoringStrategy::SUM:
      return std::make_unique<SumAggregationScorer>();
    case JoinSpecProto::AggregationScoringStrategy::NONE:
      // No aggregation strategy means using parent document score, so fall
      // through to return DefaultAggregationScorer.
      [[fallthrough]];
    default:
      return std::make_unique<DefaultAggregationScorer>();
  }
}

}  // namespace lib
}  // namespace icing