MLRsearch: Support other than just two ratios

+ Change some method names and argument types:
 + Do not mention NDR and PDR, except as examples.
 + Return list of ReceiveRateInterval instead of NdrPdrResult.
 + The resulting intervals can be degenerate when hitting min/max rate.
+ Rename quantity name parts from "fraction" to "ratio".
+ Intervals are no longer tracked for each target ratio.
 + They are found dynamically from known results.
+ Add effective_loss_ratio field to avoid loss inversion effects.
+ Move some functions to separate files.
 + Bound search logic moved to MeasurementDatabase.py
 + ProgressState moved to its file.
 + WidthArithmetics.py holds small computation functions.
+ Use parameter expansion_coefficient instead of "doublings".
+ Do uneven bisect to save time when width is not power of two times goal.
+ Timeout now correctly tracked for the whole search,
  not just the current phase.
+ Make logging (debug) function pluggable.
 + Added debug log messages for initial phase.
+ Do not mark as subclass if contructor signature differs.
+ Avoid re-measure on scale-limited (ASTF) profiles.
+ Remove outdated comments.
+ Bump copyright years.

Change-Id: I93f693b4f186f59030ee5ac21b78acc890109813
Signed-off-by: Vratko Polak <vrpolak@cisco.com>

1 files changed, 7 insertions, 10 deletions

diff --git a/resources/libraries/python/MLRsearch/AbstractSearchAlgorithm.py b/resources/libraries/python/MLRsearch/AbstractSearchAlgorithm.py
index f2bf04e1b1..cca48ef798 100644
--- a/resources/libraries/python/MLRsearch/AbstractSearchAlgorithm.py
+++ b/resources/libraries/python/MLRsearch/AbstractSearchAlgorithm.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Cisco and/or its affiliates.
+# Copyright (c) 2021 Cisco and/or its affiliates.
 # 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:
@@ -25,27 +25,24 @@ class AbstractSearchAlgorithm(metaclass=ABCMeta):
         :param measurer: Object able to perform trial or composite measurements.
         :type measurer: AbstractMeasurer.AbstractMeasurer
         """
-        # TODO: Type check for AbstractMeasurer?
         self.measurer = measurer
 
     @abstractmethod
-    def narrow_down_ndr_and_pdr(
-            self, min_rate, max_rate, packet_loss_ratio):
+    def narrow_down_intervals(
+            self, min_rate, max_rate, packet_loss_ratios):
         """Perform measurements to narrow down intervals, return them.
 
-        This will be renamed when custom loss ratio lists are supported.
-
         :param min_rate: Minimal target transmit rate [tps].
             Usually, tests are set to fail if search reaches this or below.
         :param max_rate: Maximal target transmit rate [tps].
             Usually computed from line rate and various other limits,
             to prevent failures or duration stretching in Traffic Generator.
-        :param packet_loss_ratio: Fraction of packets lost, for PDR [1].
+        :param packet_loss_ratios: Ratios of packet loss to search for,
+            e.g. [0.0, 0.005] for NDR and PDR.
         :type min_rate: float
         :type max_rate: float
-        :type packet_loss_ratio: float
+        :type packet_loss_ratios: Iterable[float]
         :returns: Structure containing narrowed down intervals
             and their measurements.
-        :rtype: NdrPdrResult.NdrPdrResult
+        :rtype: List[ReceiveRateInterval.ReceiveRateInterval]
         """
-        # TODO: Do we agree on arguments related to precision or trial duration?