resources/tools/presentation/new/jumpavg/AbstractGroupClassifier.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 from abc import ABCMeta, abstractmethod
  15
  16
  17 class AbstractGroupClassifier(object):
  18
  19     __metaclass__ = ABCMeta
  20
  21     @abstractmethod
  22     def classify(self, values):
  23         """Divide values into consecutive groups with metadata.
  24
  25         The metadata does not need to follow any specific rules,
  26         although progression/regression/outlier description would be fine.
  27
  28         :param values: Sequence of runs to classify.
  29         :type values: Iterable of float or of AvgStdevMetadata
  30         :returns: Classified groups
  31         :rtype: Iterable of RunGroup
  32         """
  33         pass