aboutsummaryrefslogtreecommitdiffstats
path: root/resources/libraries/python/search/AbstractSearchAlgorithm.py
diff options
context:
space:
mode:
authorVratko Polak <vrpolak@cisco.com>2018-07-10 14:07:02 +0200
committerPeter Mikus <pmikus@cisco.com>2018-07-12 04:23:17 +0000
commitad27739cd87a75b172fd415fc20db08983ea4e13 (patch)
tree42695d534cb19d3dc138ce4db8673244d3e3924b /resources/libraries/python/search/AbstractSearchAlgorithm.py
parente3bed8e21e3c8b60734ce95eb2bb2a2d371a9907 (diff)
CSIT-1186: Consume MLRsearch in agreed upon way
+ Rename search to MLRsearch in resources/libraries/python/. + Make PyPI/MLRsearch/MLRsearch a symlink to the renamed directory. + TrafficGenerator.py to import from the renamed directory/module. - No change to MLRsearch code. - Version stays at 0.1.1 to point to the latest released code. Change-Id: I4a38b0b7f8f083fbb1a93b25522560144b4ef556 Signed-off-by: Vratko Polak <vrpolak@cisco.com>
Diffstat (limited to 'resources/libraries/python/search/AbstractSearchAlgorithm.py')
-rw-r--r--resources/libraries/python/search/AbstractSearchAlgorithm.py51
1 files changed, 0 insertions, 51 deletions
diff --git a/resources/libraries/python/search/AbstractSearchAlgorithm.py b/resources/libraries/python/search/AbstractSearchAlgorithm.py
deleted file mode 100644
index 538322a42c..0000000000
--- a/resources/libraries/python/search/AbstractSearchAlgorithm.py
+++ /dev/null
@@ -1,51 +0,0 @@
-# Copyright (c) 2018 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(object):
- """Abstract class defining common API for search algorithms."""
-
- __metaclass__ = ABCMeta
-
- def __init__(self, measurer):
- """Store the rate provider.
-
- :param measurer: Object able to perform trial or composite measurements.
- :type measurer: AbstractMeasurer
- """
- # TODO: Type check for AbstractMeasurer?
- self.measurer = measurer
-
- @abstractmethod
- def narrow_down_ndr_and_pdr(
- self, fail_rate, line_rate, packet_loss_ratio):
- """Perform measurements to narrow down intervals, return them.
-
- This will be renamed when custom loss ratio lists are supported.
-
- :param fail_rate: Minimal target transmit rate [pps].
- :param line_rate: Maximal target transmit rate [pps].
- :param packet_loss_ratio: Fraction of packets lost, for PDR [1].
- :type fail_rate: float
- :type line_rate: float
- :type packet_loss_ratio: float
- :returns: Structure containing narrowed down intervals
- and their measurements.
- :rtype: NdrPdrResult
- """
- # TODO: Do we agree on arguments related to precision or trial duration?
- pass