[search] Calculate final RankerResult rank once.

Signed-off-by: Viktor Govako <viktor.govako@gmail.com>

iphone/Maps/Classes/CarPlay/MWMCarPlaySearchResultObject.mm

@@ -1,8 +1,12 @@
 #import "MWMCarPlaySearchResultObject.h"
 #import "MWMSearch.h"
-#include "platform/localization.hpp"
+
 #include "search/result.hpp"
 
+#include "indexer/classificator.hpp"
+
+#include "platform/localization.hpp"
+
 @interface MWMCarPlaySearchResultObject()
 @property(assign, nonatomic, readwrite) NSInteger originalRow;
 @property(strong, nonatomic, readwrite) NSString *title;

iphone/Maps/UI/Search/TableView/MWMSearchCommonCell.mm

@@ -81,8 +81,9 @@ bool PopularityHasHigherPriority(bool hasPosition, double distanceInMeters)
     }
   }
 
-  bool showPopular = result.GetRankingInfo().m_popularity > 0;
-  self.popularView.hidden = !showPopular;
+  /// @todo Restore "TOP" badge in future, when popularity will be available.
+  //self.popularView.hidden = result.GetRankingInfo().m_popularity == 0;
+  self.popularView.hidden = YES;
   
   switch (result.IsOpenNow())
   {

search/geocoder.hpp

@@ -92,6 +92,8 @@ public:
     double m_streetSearchRadiusM = 0.0;
     double m_villageSearchRadiusM = 0.0;
     int m_scale = scales::GetUpperScale();
+
+    bool m_useDebugInfo = false;  // Set to true for debug logs and tests.
   };
 
   struct LocalitiesCaches

search/intermediate_result.cpp

@@ -269,18 +269,22 @@ void FillDetails(FeatureType & ft, Result::Details & details)
 string DebugPrint(RankerResult const & r)
 {
   stringstream ss;
-  ss << "RankerResult ["
-     << "Name: " << r.GetName()
-     << "; Type: " << classif().GetReadableObjectName(r.GetBestType());
+  ss << "RankerResult "
+     << "{ Name: " << r.GetName()
+     << "; Type: " << classif().GetReadableObjectName(r.GetBestType())
+     << "; Linear model rank: " << r.GetLinearModelRank();
 
 #ifdef SEARCH_USE_PROVENANCE
     if (!r.m_provenance.empty())
       ss << "; Provenance: " << ::DebugPrint(r.m_provenance);
 #endif
 
-     ss << "; " << DebugPrint(r.GetRankingInfo())
-     << "; Linear model rank: " << r.GetLinearModelRank()
-     << "]";
+  if (r.m_dbgInfo)
+    ss << "; " << DebugPrint(*r.m_dbgInfo);
+  else
+    ss << "; " << DebugPrint(r.GetRankingInfo());
+
+  ss << " }";
   return ss.str();
 }
 }  // namespace search

search/intermediate_result.hpp

@@ -3,6 +3,7 @@
 #include "search/pre_ranking_info.hpp"
 #include "search/ranking_info.hpp"
 #include "search/result.hpp"
+#include "search/tracer.hpp"
 
 #include "storage/storage_defines.hpp"
 
@@ -108,10 +109,10 @@ public:
 
   bool IsStreet() const;
 
-  RankingInfo const & GetRankingInfo() const { return m_info; }
-  void SetRankingInfo(RankingInfo & info)
+  StoredRankingInfo const & GetRankingInfo() const { return m_info; }
+  void SetRankingInfo(RankingInfo const & info)
   {
-    // No sense to make move for RankingInfo.
+    m_finalRank = info.GetLinearModelRank();
     m_info = info;
   }
 
@@ -124,7 +125,7 @@ public:
   Result::Details GetDetails() const { return m_details; }
 
   double GetDistanceToPivot() const { return m_info.m_distanceToPivot; }
-  double GetLinearModelRank() const { return m_info.GetLinearModelRank(); }
+  double GetLinearModelRank() const { return m_finalRank; }
 
   bool GetCountryId(storage::CountryInfoGetter const & infoGetter, uint32_t ftype,
                     storage::CountryId & countryId) const;
@@ -162,10 +163,14 @@ private:
   RegionInfo m_region;
   feature::TypesHolder m_types;
   std::string m_str;
-  RankingInfo m_info = {};
   Result::Details m_details;
 
+  StoredRankingInfo m_info;
+  std::shared_ptr<RankingInfo> m_dbgInfo;   // used in debug logs and tests, nullptr in production
+
   FeatureID m_id;
+  double m_finalRank;
+
   Type m_resultType;
   feature::GeomType m_geomType = feature::GeomType::Undefined;
 

search/processor.cpp

@@ -825,6 +825,7 @@ void Processor::InitGeocoder(Geocoder::Params & geocoderParams, SearchParams con
   geocoderParams.m_tracer = searchParams.m_tracer;
   geocoderParams.m_streetSearchRadiusM = searchParams.m_streetSearchRadiusM;
   geocoderParams.m_villageSearchRadiusM = searchParams.m_villageSearchRadiusM;
+  geocoderParams.m_useDebugInfo = searchParams.m_useDebugInfo;
 
   m_geocoder.SetParams(geocoderParams);
 }

search/ranker.cpp

@@ -381,13 +381,15 @@ public:
 
     RankerResult r(*ft, center, m_ranker.m_params.m_pivot, std::move(name), country);
 
-    search::RankingInfo info;
+    RankingInfo info;
     InitRankingInfo(*ft, center, preRankerResult, info);
     if (info.m_type == Model::TYPE_STREET)
       info.m_classifType.street = m_wayChecker.GetSearchRank(r.GetBestType());
     info.m_rank = NormalizeRank(info.m_rank, info.m_type, center, country,
                                 m_capitalChecker(*ft), !info.m_allTokensUsed);
     r.SetRankingInfo(info);
+    if (m_params.m_useDebugInfo)
+      r.m_dbgInfo = std::make_shared<RankingInfo>(std::move(info));
 
 #ifdef SEARCH_USE_PROVENANCE
     r.m_provenance = preRankerResult.GetProvenance();
@@ -466,8 +468,7 @@ private:
     return ft;
   }
 
-  void InitRankingInfo(FeatureType & ft, m2::PointD const & center, PreRankerResult const & res,
-                       search::RankingInfo & info)
+  void InitRankingInfo(FeatureType & ft, m2::PointD const & center, PreRankerResult const & res, RankingInfo & info)
   {
     auto const & preInfo = res.GetInfo();
     auto const & pivot = m_ranker.m_params.m_accuratePivotCenter;
@@ -711,7 +712,7 @@ Result Ranker::MakeResult(RankerResult rankerResult, bool needAddress, bool need
   if (needHighlighting)
     HighlightResult(m_params.m_tokens, m_params.m_prefix, res);
 
-  res.SetRankingInfo(rankerResult.m_info);
+  res.SetRankingInfo(rankerResult.m_dbgInfo);
 
 #ifdef SEARCH_USE_PROVENANCE
   res.SetProvenance(move(rankerResult.m_provenance));
@@ -749,9 +750,7 @@ void Ranker::UpdateResults(bool lastUpdate)
   }
   else
   {
-    // *NOTE* GetLinearModelRank is calculated on the fly
-    // but the model is lightweight enough and the slowdown
-    // is negligible.
+    /// @note Here is _reverse_ order sorting, because bigger is better.
     sort(m_tentativeResults.rbegin(), m_tentativeResults.rend(),
          base::LessBy(&RankerResult::GetLinearModelRank));
 

search/ranking_info.cpp

@@ -124,8 +124,9 @@ class IsServiceTypeChecker
 private:
   IsServiceTypeChecker()
   {
-    for (string_view const t : {"barrier", "power", "traffic_calming"})
-      m_oneLevelTypes.push_back(classif().GetTypeByPath({t}));
+    Classificator const & c = classif();
+    for (char const * e : {"barrier", "power", "traffic_calming"})
+      m_oneLevelTypes.push_back(c.GetTypeByPath({e}));
   }
 
 public:
@@ -137,9 +138,10 @@ public:
 
   bool operator()(feature::TypesHolder const & th) const
   {
-    return base::AnyOf(th, [&](auto t) {
+    return base::AnyOf(th, [&](auto t)
+    {
       ftype::TruncValue(t, 1);
-      return find(m_oneLevelTypes.begin(), m_oneLevelTypes.end(), t) != m_oneLevelTypes.end();
+      return base::IsExist(m_oneLevelTypes, t);
     });
   }
 
@@ -168,20 +170,11 @@ void RankingInfo::PrintCSVHeader(ostream & os)
      << ",HasName";
 }
 
-string DebugPrint(RankingInfo const & info)
+std::string DebugPrint(StoredRankingInfo const & info)
 {
   ostringstream os;
-  os << boolalpha << "RankingInfo { ";
-  PrintParse(os, info.m_tokenRanges, info.m_numTokens);
-
-  os << ", m_distanceToPivot: " << info.m_distanceToPivot
-     << ", m_rank: " << static_cast<int>(info.m_rank)
-     << ", m_popularity: " << static_cast<int>(info.m_popularity)
-     << ", m_nameScore: " << DebugPrint(info.m_nameScore)
-     << ", m_errorsMade: " << DebugPrint(info.m_errorsMade)
-     << ", m_isAltOrOldName: " << info.m_isAltOrOldName
-     << ", m_numTokens: " << info.m_numTokens
-     << ", m_matchedFraction: " << info.m_matchedFraction
+  os << "StoredRankingInfo "
+     << "{ m_distanceToPivot: " << info.m_distanceToPivot
      << ", m_type: " << DebugPrint(info.m_type)
      << ", m_resultType: ";
 
@@ -190,7 +183,26 @@ string DebugPrint(RankingInfo const & info)
   else if (info.m_type == Model::TYPE_STREET)
     os << DebugPrint(info.m_classifType.street);
 
-  os << ", m_pureCats: " << info.m_pureCats
+  os << " }";
+  return os.str();
+}
+
+string DebugPrint(RankingInfo const & info)
+{
+  ostringstream os;
+  os << boolalpha << "RankingInfo { "
+     << DebugPrint(static_cast<StoredRankingInfo const &>(info)) << ", ";
+
+  PrintParse(os, info.m_tokenRanges, info.m_numTokens);
+
+  os << ", m_rank: " << static_cast<int>(info.m_rank)
+     << ", m_popularity: " << static_cast<int>(info.m_popularity)
+     << ", m_nameScore: " << DebugPrint(info.m_nameScore)
+     << ", m_errorsMade: " << DebugPrint(info.m_errorsMade)
+     << ", m_isAltOrOldName: " << info.m_isAltOrOldName
+     << ", m_numTokens: " << info.m_numTokens
+     << ", m_matchedFraction: " << info.m_matchedFraction
+     << ", m_pureCats: " << info.m_pureCats
      << ", m_falseCats: " << info.m_falseCats
      << ", m_allTokensUsed: " << info.m_allTokensUsed
      << ", m_exactCountryOrCapital: " << info.m_exactCountryOrCapital

search/ranking_info.hpp

@@ -35,7 +35,26 @@ enum class PoiType : uint8_t
 
 using StreetType = ftypes::IsWayChecker::SearchRank;
 
-struct RankingInfo
+struct StoredRankingInfo
+{
+  // Do not change this constant, it is used to normalize distance and takes part in distance rank, accordingly.
+  static double constexpr kMaxDistMeters = 2.0E6;
+
+  // Distance from the feature to the pivot point.
+  double m_distanceToPivot = kMaxDistMeters;
+
+  // Search type for the feature.
+  Model::Type m_type = Model::TYPE_COUNT;
+
+  // Used for non-categorial requests.
+  union
+  {
+    PoiType poi;        // type (food/transport/attraction/etc) for POI results
+    StreetType street;  // type (peddestrian/residential/regular/etc) for Street results
+  } m_classifType;
+};
+
+struct RankingInfo : public StoredRankingInfo
 {
   RankingInfo()
     : m_isAltOrOldName(false)
@@ -50,8 +69,6 @@ struct RankingInfo
     m_classifType.street = StreetType::Default;
   }
 
-  static double constexpr kMaxDistMeters = 2.0E6;
-
   static void PrintCSVHeader(std::ostream & os);
 
   void ToCSV(std::ostream & os) const;
@@ -62,9 +79,6 @@ struct RankingInfo
 
   double GetErrorsMadePerToken() const;
 
-  // Distance from the feature to the pivot point.
-  double m_distanceToPivot = kMaxDistMeters;
-
   // Matched parts of the query.
   // todo(@m) Using TokenType instead of ModelType here would
   //          allow to distinguish postcodes too.
@@ -88,16 +102,6 @@ struct RankingInfo
   // Score for the feature's name.
   NameScore m_nameScore = NAME_SCORE_ZERO;
 
-  // Search type for the feature.
-  Model::Type m_type = Model::TYPE_COUNT;
-
-  // Used for non-categorial requests.
-  union
-  {
-    PoiType poi;        // type (food/transport/attraction/etc) for POI results
-    StreetType street;  // type (peddestrian/residential/regular/etc) for Street results
-  } m_classifType;
-
   // alt_name or old_name is used.
   bool m_isAltOrOldName : 1;
 
@@ -130,7 +134,9 @@ struct RankingInfo
 
 PoiType GetPoiType(feature::TypesHolder const & th);
 
+std::string DebugPrint(StoredRankingInfo const & info);
 std::string DebugPrint(RankingInfo const & info);
+
 std::string DebugPrint(PoiType type);
 std::string DebugPrint(StreetType type);
 }  // namespace search

search/result.hpp

@@ -2,7 +2,6 @@
 
 #include "search/bookmarks/results.hpp"
 #include "search/ranking_info.hpp"
-#include "search/tracer.hpp"
 
 #include "indexer/feature_decl.hpp"
 
@@ -13,8 +12,6 @@
 #include "base/assert.hpp"
 #include "base/buffer_vector.hpp"
 
-#include "defines.hpp"
-
 #include <algorithm>
 #include <string>
 #include <utility>
@@ -136,12 +133,15 @@ public:
   int32_t GetPositionInResults() const { return m_positionInResults; }
   void SetPositionInResults(int32_t pos) { m_positionInResults = pos; }
 
-  RankingInfo const & GetRankingInfo() const { return m_info; }
-  void SetRankingInfo(RankingInfo & info)
+  /// @name Used for debug logs and tests only.
+  /// @{
+  RankingInfo const & GetRankingInfo() const
   {
-    // No sense to make move for RankingInfo.
-    m_info = info;
+    CHECK(m_dbgInfo, ());
+    return *m_dbgInfo;
   }
+  void SetRankingInfo(std::shared_ptr<RankingInfo> info) { m_dbgInfo = std::move(info); }
+  /// @}
 
 #ifdef SEARCH_USE_PROVENANCE
   template <typename Prov>
@@ -169,7 +169,7 @@ private:
   std::string m_suggestionStr;
   buffer_vector<std::pair<uint16_t, uint16_t>, 4> m_hightlightRanges;
 
-  RankingInfo m_info = {};
+  std::shared_ptr<RankingInfo> m_dbgInfo;   // used in debug logs and tests, nullptr in production
 
   // The position that this result occupied in the vector returned by
   // a search query. -1 if undefined.

search/search_params.hpp

@@ -79,6 +79,13 @@ struct SearchParams
   // Street search radius from pivot for everywhere search mode.
   double m_villageSearchRadiusM = kDefaultVillageSearchRadiusM;
 
+  bookmarks::GroupId m_bookmarksGroupId = bookmarks::kInvalidGroupId;
+
+  // Amount of time after which the search is aborted.
+  TimeDurationT m_timeout = kDefaultTimeout;
+
+  std::shared_ptr<Tracer> m_tracer;
+
   Mode m_mode = Mode::Everywhere;
 
   // Needed to generate search suggests.
@@ -90,15 +97,15 @@ struct SearchParams
   // Needed to highlight matching parts of search result names.
   bool m_needHighlighting = false;
 
-  /// True if you need *pure* category results, without names/addresses/etc matching.
+  // True if you need *pure* category results only, without names/addresses/etc matching.
   bool m_categorialRequest = false;
 
-  bookmarks::GroupId m_bookmarksGroupId = bookmarks::kInvalidGroupId;
-
-  // Amount of time after which the search is aborted.
-  TimeDurationT m_timeout = kDefaultTimeout;
-
-  std::shared_ptr<Tracer> m_tracer;
+  // Set to true for debug logs and tests.
+#ifdef DEBUG
+  bool m_useDebugInfo = true;
+#else   // RELEASE
+  bool m_useDebugInfo = false;
+#endif  // DEBUG
 };
 
 std::string DebugPrint(SearchParams const & params);

search/search_quality/sample.cpp

@@ -189,6 +189,7 @@ void Sample::FillSearchParams(search::SearchParams & params) const
   params.m_needAddress = true;
   params.m_suggestsEnabled = false;
   params.m_needHighlighting = false;
+  params.m_useDebugInfo = true;     // for RankingInfo printing
 }
 
 void FromJSONObject(json_t * root, char const * field, Sample::Result::Relevance & relevance)

search/search_tests/feature_offset_match_tests.cpp

@@ -8,16 +8,15 @@
 #include "base/mem_trie.hpp"
 #include "base/string_utils.hpp"
 
-#include <cstdint>
 #include <map>
 #include <string>
 #include <vector>
 
+namespace feature_offset_match_tests
+{
 using namespace base;
 using namespace std;
 
-namespace
-{
 using Key = strings::UniString;
 using Value = uint32_t;
 using ValueList = VectorValues<Value>;
@@ -94,4 +93,4 @@ UNIT_TEST(MatchPrefixInTrieTest)
     TEST(vals.at(1), (vals));
   }
 }
-}  // namespace
+} // namespace feature_offset_match_tests

search/search_tests_support/test_search_request.cpp

@@ -2,11 +2,7 @@
 
 #include "search/search_tests_support/test_search_engine.hpp"
 
-#include "geometry/latlon.hpp"
-#include "geometry/mercator.hpp"
-
 #include "base/assert.hpp"
-#include "base/logging.hpp"
 
 #include <functional>
 
@@ -27,6 +23,8 @@ TestSearchRequest::TestSearchRequest(TestSearchEngine & engine, string const & q
   m_params.m_mode = mode;
   m_params.m_streetSearchRadiusM = kDefaultTestStreetSearchRadiusM;
   m_params.m_villageSearchRadiusM = kDefaultTestVillageSearchRadiusM;
+  m_params.m_useDebugInfo = true;
+
   SetUpCallbacks();
   SetUpResultParams();
 }
@@ -34,6 +32,8 @@ TestSearchRequest::TestSearchRequest(TestSearchEngine & engine, string const & q
 TestSearchRequest::TestSearchRequest(TestSearchEngine & engine, SearchParams const & params)
   : m_engine(engine), m_params(params)
 {
+  m_params.m_useDebugInfo = true;
+
   SetUpCallbacks();
 }
 
@@ -51,6 +51,8 @@ TestSearchRequest::TestSearchRequest(TestSearchEngine & engine, string const & q
   m_params.m_onResults = onResults;
   m_params.m_streetSearchRadiusM = kDefaultTestStreetSearchRadiusM;
   m_params.m_villageSearchRadiusM = kDefaultTestVillageSearchRadiusM;
+  m_params.m_useDebugInfo = true;
+
   SetUpResultParams();
 }