1 # Copyright (c) 2021 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:
6 # http://www.apache.org/licenses/LICENSE-2.0
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.
14 """Module defining AbstractSearchAlgorithm class."""
16 from abc import ABCMeta, abstractmethod
19 class AbstractSearchAlgorithm(metaclass=ABCMeta):
20 """Abstract class defining common API for search algorithms."""
22 def __init__(self, measurer):
23 """Store the rate provider.
25 :param measurer: Object able to perform trial or composite measurements.
26 :type measurer: AbstractMeasurer.AbstractMeasurer
28 self.measurer = measurer
31 def narrow_down_intervals(
32 self, min_rate, max_rate, packet_loss_ratios):
33 """Perform measurements to narrow down intervals, return them.
35 :param min_rate: Minimal target transmit rate [tps].
36 Usually, tests are set to fail if search reaches this or below.
37 :param max_rate: Maximal target transmit rate [tps].
38 Usually computed from line rate and various other limits,
39 to prevent failures or duration stretching in Traffic Generator.
40 :param packet_loss_ratios: Ratios of packet loss to search for,
41 e.g. [0.0, 0.005] for NDR and PDR.
44 :type packet_loss_ratios: Iterable[float]
45 :returns: Structure containing narrowed down intervals
46 and their measurements.
47 :rtype: List[ReceiveRateInterval.ReceiveRateInterval]