CSIT-1110: Use jumpavg library from pip

[csit.git] / PyPI / jumpavg / jumpavg / BitCountingGroupList.py

diff --git a/PyPI/jumpavg/jumpavg/BitCountingGroupList.py b/PyPI/jumpavg/jumpavg/BitCountingGroupList.py
new file mode 100644 (file)
index 0000000..1f69c06
--- /dev/null
+++ b/PyPI/jumpavg/jumpavg/BitCountingGroupList.py
@@ -0,0 +1,87 @@
+# 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 holding BitCountingGroupList class."""
+
+from BitCountingGroup import BitCountingGroup
+from BitCountingMetadataFactory import BitCountingMetadataFactory
+
+
+class BitCountingGroupList(list):
+    """List of BitCountingGroup which tracks overall bit count.
+
+    This is useful, as bit count of a subsequent group
+    depends on average of the previous group.
+    Having the logic encapsulated here spares the caller
+    the effort to pass averages around.
+
+    Method with_value_added_to_last_group() delegates to BitCountingGroup,
+    with_group_appended() adds new group with recalculated bits.
+
+    TODO: last_group.metadata_factory.max_value in with_group_appended()
+    is ugly, find a more natural class design.
+    """
+
+    def __init__(self, group_list=[], bits=None):
+        """Create a group list from given list of groups.
+
+        :param group_list: List of groups to compose this group.
+        :param bits: Bit count if known, else None.
+        :type group_list: list of BitCountingGroup
+        :type bits: float or None
+        """
+        super(BitCountingGroupList, self).__init__(group_list)
+        if bits is not None:
+            self.bits = bits
+            return
+        bits = 0.0
+        for group in group_list:
+            bits += group.metadata.bits
+        self.bits = bits
+
+    def with_group_appended(self, group):
+        """Create and return new group list with given group more than self.
+
+        The group argument object is updated with derivative metadata.
+
+        :param group: Next group to be appended to the group list.
+        :type group: BitCountingGroup
+        :returns: New group list with added group.
+        :rtype: BitCountingGroupList
+        """
+        group_list = list(self)
+        if group_list:
+            last_group = group_list[-1]
+            factory = BitCountingMetadataFactory(
+                last_group.metadata_factory.max_value, last_group.metadata.avg)
+            group.metadata_factory = factory
+            group.metadata = factory.from_data(group.values)
+        group_list.append(group)
+        bits = self.bits + group.metadata.bits
+        return BitCountingGroupList(group_list, bits)
+
+    def with_value_added_to_last_group(self, value):
+        """Create and return new group list with value added to last group.
+
+        :param value: The run value to add to the last group.
+        :type value: float or od AvgStdevMetadata
+        :returns: New group list with the last group updated.
+        :rtype: BitCountingGroupList
+        """
+        group_list = list(self)
+        last_group = group_list[-1]
+        bits_before = last_group.metadata.bits
+        last_group = last_group.with_run_added(value)
+        group_list[-1] = last_group
+        bits = self.bits - bits_before + last_group.metadata.bits
+        return BitCountingGroupList(group_list, bits)