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
52
53
54
|
# 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 for holding AvgStdevMetadata class."""
from AbstractGroupMetadata import AbstractGroupMetadata
class AvgStdevMetadata(AbstractGroupMetadata):
"""Class for metadata specifying the average and standard deviation."""
def __init__(self, size=0, avg=0.0, stdev=0.0):
"""Construct the metadata by setting the values needed.
The values are sanitized, so faulty callers to not cause math errors.
:param size: Number of values participating in this group.
:param avg: Population average of the participating sample values.
:param stdev: Population standard deviation of the sample values.
:type size: int
:type avg: float
:type stdev: float
"""
self.size = size if size >= 0 else 0
self.avg = avg if size >= 1 else 0.0
self.stdev = stdev if size >= 2 else 0.0
def __str__(self):
"""Return string with human readable description of the group.
:returns: Readable description.
:rtype: str
"""
return "size={size} avg={avg} stdev={stdev}".format(
size=self.size, avg=self.avg, stdev=self.stdev)
def __repr__(self):
"""Return string executable as Python constructor call.
:returns: Executable constructor call.
:rtype: str
"""
return "AvgStdevMetadata(size={size},avg={avg},stdev={stdev})".format(
size=self.size, avg=self.avg, stdev=self.stdev)
|
