blob: f2bf04e1b1437ff8595d12da9abfa3b9efa3f9f3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
# Copyright (c) 2020 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:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Module defining AbstractSearchAlgorithm class."""
from abc import ABCMeta, abstractmethod
class AbstractSearchAlgorithm(metaclass=ABCMeta):
"""Abstract class defining common API for search algorithms."""
def __init__(self, measurer):
"""Store the rate provider.
: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):
"""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].
:type min_rate: float
:type max_rate: float
:type packet_loss_ratio: float
:returns: Structure containing narrowed down intervals
and their measurements.
:rtype: NdrPdrResult.NdrPdrResult
"""
# TODO: Do we agree on arguments related to precision or trial duration?
|
