eckity.statistics.statistics

 1from sys import stdout
 2from abc import abstractmethod
 3
 4
 5class Statistics:
 6    """
 7    Abstract Statistics class.
 8    Provides statistics about the current evolution state.
 9
10    Parameters
11    ----------
12    format_string: str
13        String format of the data to output.
14        Value depends on the information the statistics provides.
15        For more information, check out the concrete classes who extend this class.
16
17    output_stream: Optional[SupportsWrite[str]], default=stdout
18        Output file for the statistics.
19        By default, the statistics will be written to stdout.
20    """
21    def __init__(self, format_string, output_stream=stdout):
22        self.output_stream = output_stream
23        self.format_string = format_string
24
25    @abstractmethod
26    def write_statistics(self, sender, data_dict):
27        """
28        Write the statistics information using the format string field to the output stream field.
29
30        Parameters
31        ----------
32        sender: object
33            The object that this statistics provides information about.
34            This class registers to a certain event that the sender object publishes.
35            The statistics are shown as a callback to the event publication.
36            For example, we can register a concrete Statistics sub-class to provide statistics after every generation
37            of a concrete Algorithm sub-class.
38
39        data_dict: dict(str, object)
40            Relevant data to the statistics. Used to gain and provide information from the sender.
41
42        Returns
43        -------
44        None.
45        """
46        pass