Adding knobs on HQP provider.

chrome/browser/history/scored_history_match.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CHROME_BROWSER_HISTORY_SCORED_HISTORY_MATCH_H_
 #define CHROME_BROWSER_HISTORY_SCORED_HISTORY_MATCH_H_
 
 #include <map>
 #include <set>
 #include <vector>
@@ skipping 11 matching lines @@
 
 // An HistoryMatch that has a score as well as metrics defining where in the
 // history item's URL and/or page title matches have occurred.
 class ScoredHistoryMatch : public history::HistoryMatch {
  public:
   // The maximum number of recent visits to examine in GetFrequency().
   // Public so url_index_private_data.cc knows how many visits it is
   // expected to deliver (at minimum) to this class.
   static const size_t kMaxVisitsToScore;
 
+  // ScoreMaxRelevance maps from intermediate-score to the final-relevance

[Mark P, 2015/02/14 01:27:14]

from -> from an
to the -> to the maximum

[Ashok vardhan, 2015/02/17 01:23:53]

Done.

+  // score given to URL. This is used to store the score ranges of HQP relevance

[Mark P, 2015/02/14 01:27:14]

to URL -> to a URL for this intermediate score.

[Ashok vardhan, 2015/02/17 01:23:53]

Done.

+  // buckets. Please see GetFinalRelevancyScore() for details.
+  typedef std::pair<double, int> ScoreMaxRelevance;
+
   ScoredHistoryMatch();  // Required by STL.
 
   // Creates a new match with a raw score calculated for the history item
   // given in |row| with recent visits as indicated in |visits|.  First
   // determines if the row qualifies by seeing if all of the terms in
   // |terms_vector| occur in |row|.  If so, calculates a raw score.  This raw
   // score is in part determined by whether the matches occur at word
   // boundaries, the locations of which are stored in |word_starts|.  For some
   // terms, it's appropriate to look for the word boundary within the term.
   // For instance, the term ".net" should look for a word boundary at the "n".
@@ skipping 34 matching lines @@
   // end_pos == string::npos is treated as end_pos = length of string.
   static TermMatches FilterTermMatchesByWordStarts(
       const TermMatches& term_matches,
       const WordStarts& terms_to_word_starts_offsets,
       const WordStarts& word_starts,
       size_t start_pos,
       size_t end_pos);
 
  private:
   friend class ScoredHistoryMatchTest;
+  FRIEND_TEST_ALL_PREFIXES(ScoredHistoryMatchTest, GetFinalRelevancyScore);
   FRIEND_TEST_ALL_PREFIXES(ScoredHistoryMatchTest, ScoringBookmarks);
   FRIEND_TEST_ALL_PREFIXES(ScoredHistoryMatchTest, ScoringDiscountFrecency);
   FRIEND_TEST_ALL_PREFIXES(ScoredHistoryMatchTest, ScoringScheme);
   FRIEND_TEST_ALL_PREFIXES(ScoredHistoryMatchTest, ScoringTLD);
 
   // The number of days of recency scores to precompute.
   static const int kDaysToPrecomputeRecencyScoresFor;
 
   // The number of raw term score buckets use; raw term scores
   // greater this are capped at the score of the largest bucket.
@@ skipping 24 matching lines @@
   // Examines the first kMaxVisitsToScore and return a score (higher is
   // better) based the rate of visits, whether the page is bookmarked, and
   // how often those visits are typed navigations (i.e., explicitly
   // invoked by the user).  |now| is passed in to avoid unnecessarily
   // recomputing it frequently.
   static float GetFrequency(const base::Time& now,
                             const bool bookmarked,
                             const VisitInfoVector& visits);
 
   // Combines the two component scores into a final score that's
-  // an appropriate value to use as a relevancy score.
+  // an appropriate value to use as a relevancy score. Scoring buckets are
+  // specified through |hqp_relevance_buckets|. Please see function

[Mark P, 2015/02/14 01:27:14]

see -> see the

[Ashok vardhan, 2015/02/17 01:23:52]

Done.

+  // implementation for more details.
   static float GetFinalRelevancyScore(
       float topicality_score,
-      float frequency_score);
+      float frequency_score,
+      const std::vector<ScoreMaxRelevance>& hqp_relevance_buckets);
+
+  // Initializes the HQP experimental params.

[Mark P, 2015/02/14 01:27:14]

This comment is a verb, implying it should go next to a function.  Yet it's
associated with a variable.  Please rearrange/revise these comments so they're
appropriate.

Also note that the style guide says all functions should be declared in class
files before all variables.

[Ashok vardhan, 2015/02/17 01:23:53]

Done.

+  // If the experimental scoring is enabled, it sets:

[Mark P, 2015/02/14 01:27:14]

By the way, this comment is wrong as written.  In particular, you end up seeing
some of these variables even if hqp_experimental_scoring is not enabled (and you
rely on these settings in the code even when experimental scoring is not
enabled).

+  //
+  // 1. hqp_experimental to true. Default value is set to false.
+  //
+  // 2. It initializes the topicality_threshold_, and hqp_scoring from the
+  //    finch experiment params.
+  //
+  // 3. topicality_threshold_ is used to control the topicality scoring.
+  // If topicality_threshold > 0, then URLs with topicality score < threshold,
+  // are given score 0. It is initalized to -1;
+  //
+  // 4. hqp_relevance_buckets_, buckets that gives the mapping from
+  // (topicality*frequency) to the final relevance scoring.
+  // Please see GetFinalRelevancyScore() for more details and scoring method.
+  static bool hqp_experimental_scoring_enabled_;
+  static float topicality_threshold_;
+  static std::vector<ScoreMaxRelevance>* hqp_relevance_buckets_;
+
+  static void InitializeHQPExperimentalParams();
 
   // Sets |also_do_hup_like_scoring_|,
   // |max_assigned_score_for_non_inlineable_matches_|, |bookmark_value_|,
   // |allow_tld_matches_|, and |allow_scheme_matches_| based on the field
   // trial state.
   static void Init();
 
   // An interim score taking into consideration location and completeness
   // of the match.
   int raw_score_;
@@ skipping 55 matching lines @@
   // matches) because if a non-inlineable match comes first than all matches
   // will get demoted later in HistoryQuickProvider to non-inlineable scores.
   // Set to -1 to indicate no maximum score.
   static int max_assigned_score_for_non_inlineable_matches_;
 };
 typedef std::vector<ScoredHistoryMatch> ScoredHistoryMatches;
 
 }  // namespace history
 
 #endif  // CHROME_BROWSER_HISTORY_SCORED_HISTORY_MATCH_H_