resources/libraries/python/search/AbstractSearchAlgorithm.py

   1 # Copyright (c) 2018 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 """Module defining AbstractSearchAlgorithm class."""
  15
  16 from abc import ABCMeta, abstractmethod
  17
  18
  19 class AbstractSearchAlgorithm(object):
  20     """Abstract class defining common API for search algorithms."""
  21
  22     __metaclass__ = ABCMeta
  23
  24     def __init__(self, rate_provider):
  25         """Store the rate provider.
  26
  27         :param rate_provider: Object able to perform trial measurements.
  28         :type rate_provider: AbstractRateProvider
  29         """
  30         # TODO: Type check for AbstractRateProvider?
  31         self.rate_provider = rate_provider
  32
  33     @abstractmethod
  34     def narrow_down_ndr_and_pdr(
  35             self, fail_rate, line_rate, packet_loss_ratio):
  36         """Perform measurements to narrow down intervals, return them.
  37
  38         :param fail_rate: Minimal target transmit rate [pps].
  39         :param line_rate: Maximal target transmit rate [pps].
  40         :param packet_loss_ratio: Fraction of packets lost, for PDR [1].
  41         :type fail_rate: float
  42         :type line_rate: float
  43         :type packet_loss_ratio: float
  44         :returns: Structure containing narrowed down intervals
  45             and their measurements.
  46         :rtype: NdrPdrResult
  47         """
  48         # TODO: Do we agree on arguments related to precision or trial duration?
  49         pass