searx.metrics.models.Histogram Class Reference

Inheritance diagram for searx.metrics.models.Histogram:

Public Member Functions
	__init__ (self, width=10, size=200)
	observe (self, value)
	quartiles (self)
	count (self)
	sum (self)
	average (self)
	quartile_percentage (self)
	quartile_percentage_map (self)
	percentage (self, percentage)
	__repr__ (self)

Public Attributes
	average

Protected Attributes
	_lock = threading.Lock()
	_width = width
	_size = size
list	_quartiles = [0] * size
int	_count = 0
int	_sum = 0

Static Protected Attributes
str	_slots__ = '_lock', '_size', '_sum', '_quartiles', '_count', '_width'

Detailed Description

Definition at line 15 of file models.py.

Constructor & Destructor Documentation

__init__()

searx.metrics.models.Histogram.__init__	(		self,
			width = 10,
			size = 200 )

Definition at line 19 of file models.py.

    def __init__(self, width=10, size=200):
        self._lock = threading.Lock()
        self._width = width
        self._size = size
        self._quartiles = [0] * size
        self._count = 0
        self._sum = 0
 

Member Function Documentation

__repr__()

searx.metrics.models.Histogram.__repr__

(

self

)

Definition at line 98 of file models.py.

    def __repr__(self):
        return "Histogram<avg: " + str(self.average) + ", count: " + str(self._count) + ">"
 
 

average()

searx.metrics.models.Histogram.average

(

self

)

Definition at line 53 of file models.py.

    def average(self):
        with self._lock:
            if self._count != 0:
                return self._sum / self._count
            return 0
 

References _count, _lock, and _sum.

count()

searx.metrics.models.Histogram.count

(

self

)

Definition at line 45 of file models.py.

    def count(self):
        return self._count
 

References _count.

observe()

searx.metrics.models.Histogram.observe	(		self,
			value )

Reimplemented in searx.metrics.models.VoidHistogram.

Definition at line 27 of file models.py.

    def observe(self, value):
        q = int(value / self._width)
        if q < 0:  # pylint: disable=consider-using-max-builtin
            # Value below zero is ignored
            q = 0
        if q >= self._size:
            # Value above the maximum is replaced by the maximum
            q = self._size - 1
        with self._lock:
            self._quartiles[q] += 1
            self._count += 1
            self._sum += value
 

References _count, _lock, _quartiles, _size, _sum, and _width.

percentage()

searx.metrics.models.Histogram.percentage	(		self,
			percentage )

Definition at line 83 of file models.py.

    def percentage(self, percentage):
        # use Decimal to avoid rounding errors
        x = decimal.Decimal(0)
        width = decimal.Decimal(self._width)
        stop_at_value = decimal.Decimal(self._count) / 100 * percentage
        sum_value = 0
        with self._lock:
            if self._count > 0:
                for y in self._quartiles:
                    sum_value += y
                    if sum_value >= stop_at_value:
                        return x
                    x += width
        return None
 

References _count, _lock, _quartiles, and _width.

quartile_percentage()

searx.metrics.models.Histogram.quartile_percentage

(

self

)

Quartile in percentage

Definition at line 60 of file models.py.

    def quartile_percentage(self):
        '''Quartile in percentage'''
        with self._lock:
            if self._count > 0:
                return [int(q * 100 / self._count) for q in self._quartiles]
            return self._quartiles
 

References _count, _lock, and _quartiles.

quartile_percentage_map()

searx.metrics.models.Histogram.quartile_percentage_map

(

self

)

Definition at line 68 of file models.py.

    def quartile_percentage_map(self):
        result = {}
        # use Decimal to avoid rounding errors
        x = decimal.Decimal(0)
        width = decimal.Decimal(self._width)
        width_exponent = -width.as_tuple().exponent
        with self._lock:
            if self._count > 0:
                for y in self._quartiles:
                    yp = int(y * 100 / self._count)  # pylint: disable=invalid-name
                    if yp != 0:
                        result[round(float(x), width_exponent)] = yp
                    x += width
        return result
 

References _count, _lock, _quartiles, and _width.

quartiles()

searx.metrics.models.Histogram.quartiles

(

self

)

Definition at line 41 of file models.py.

    def quartiles(self):
        return list(self._quartiles)
 

References _quartiles.

sum()

searx.metrics.models.Histogram.sum

(

self

)

Definition at line 49 of file models.py.

    def sum(self):
        return self._sum
 

References _sum.

Member Data Documentation

_count

searx.metrics.models.Histogram._count = 0

protected

Definition at line 24 of file models.py.

Referenced by average(), count(), observe(), percentage(), quartile_percentage(), and quartile_percentage_map().

_lock

searx.metrics.models.Histogram._lock = threading.Lock()

protected

Definition at line 20 of file models.py.

Referenced by searx.results.ResultContainer._merge_infobox(), searx.results.ResultContainer._merge_main_result(), searx.results.ResultContainer.add_timing(), searx.results.ResultContainer.add_unresponsive_engine(), average(), searx.results.ResultContainer.get_timings(), searx.results.ResultContainer.number_of_results(), observe(), percentage(), quartile_percentage(), and quartile_percentage_map().

_quartiles

searx.metrics.models.Histogram._quartiles = [0] * size

protected

Definition at line 23 of file models.py.

Referenced by observe(), percentage(), quartile_percentage(), quartile_percentage_map(), and quartiles().

_size

searx.metrics.models.Histogram._size = size

protected

Definition at line 22 of file models.py.

Referenced by observe().

_slots__

str searx.metrics.models.Histogram._slots__ = '_lock', '_size', '_sum', '_quartiles', '_count', '_width'

staticprotected

Definition at line 17 of file models.py.

_sum

int searx.metrics.models.Histogram._sum = 0

protected

Definition at line 25 of file models.py.

Referenced by average(), observe(), and sum().

_width

searx.metrics.models.Histogram._width = width

protected

Definition at line 21 of file models.py.

Referenced by observe(), percentage(), and quartile_percentage_map().

average

searx.metrics.models.Histogram.average

Definition at line 99 of file models.py.

---

The documentation for this class was generated from the following file:

• /home/andrew/Documents/code/public/searxng/searx/metrics/models.py