xref: /aosp_15_r20/external/icing/icing/join/aggregation-scorer.h (revision 8b6cd535a057e39b3b86660c4aa06c99747c2136)
1 // Copyright (C) 2022 Google LLC
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 //      http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #ifndef ICING_JOIN_AGGREGATION_SCORER_H_
16 #define ICING_JOIN_AGGREGATION_SCORER_H_
17 
18 #include <memory>
19 #include <vector>
20 
21 #include "icing/proto/search.pb.h"
22 #include "icing/scoring/scored-document-hit.h"
23 
24 namespace icing {
25 namespace lib {
26 
27 class AggregationScorer {
28  public:
29   static std::unique_ptr<AggregationScorer> Create(
30       const JoinSpecProto& join_spec);
31 
32   virtual ~AggregationScorer() = default;
33 
34   virtual double GetScore(const ScoredDocumentHit& parent,
35                           const std::vector<ScoredDocumentHit>& children) = 0;
36 };
37 
38 }  // namespace lib
39 }  // namespace icing
40 
41 #endif  // ICING_JOIN_AGGREGATION_SCORER_H_
42