bisect — Array bisection algorithm

Вихідний код: Lib/bisect.py

This module provides support for maintaining a list in sorted order without having to sort the list after each insertion. For long lists of items with expensive comparison operations, this can be an improvement over the more common approach. The module is called bisect because it uses a basic bisection algorithm to do its work. The source code may be most useful as a working example of the algorithm (the boundary conditions are already right!).

Передбачені такі функції:

bisect.bisect_left(a, x, lo=0, hi=len(a), *, key=None)

Знайдіть точку вставки для x у a, щоб зберегти відсортований порядок. Параметри lo і hi можуть використовуватися для визначення підмножини списку, яку слід враховувати; за замовчуванням використовується весь список. Якщо x уже присутній у a, точка вставки буде перед будь-якими існуючими записами (зліва від них). Повернене значення придатне для використання як перший параметр для list.insert() за умови, що a вже відсортовано.

The returned insertion point i partitions the array a into two halves so that all(val < x for val in a[lo : i]) for the left side and all(val >= x for val in a[i : hi]) for the right side.

key визначає key function одного аргументу, який використовується для отримання ключа порівняння з кожного елемента в масиві. Для підтримки пошуку складних записів функція ключа не застосовується до значення x.

If key is None, the elements are compared directly with no intervening function call.

Змінено в версії 3.10: Додано параметр key.

bisect.bisect_right(a, x, lo=0, hi=len(a), *, key=None)
bisect.bisect(a, x, lo=0, hi=len(a), *, key=None)

Similar to bisect_left(), but returns an insertion point which comes after (to the right of) any existing entries of x in a.

The returned insertion point i partitions the array a into two halves so that all(val <= x for val in a[lo : i]) for the left side and all(val > x for val in a[i : hi]) for the right side.

key визначає key function одного аргументу, який використовується для отримання ключа порівняння з кожного елемента в масиві. Для підтримки пошуку складних записів функція ключа не застосовується до значення x.

If key is None, the elements are compared directly with no intervening function call.

Змінено в версії 3.10: Додано параметр key.

bisect.insort_left(a, x, lo=0, hi=len(a), *, key=None)

Вставте x у a в порядку сортування.

This function first runs bisect_left() to locate an insertion point. Next, it runs the insert() method on a to insert x at the appropriate position to maintain sort order.

Щоб підтримувати вставлення записів у таблицю, функція key (якщо є) застосовується до x для кроку пошуку, але не для кроку вставки.

Keep in mind that the O(log n) search is dominated by the slow O(n) insertion step.

Змінено в версії 3.10: Додано параметр key.

bisect.insort_right(a, x, lo=0, hi=len(a), *, key=None)
bisect.insort(a, x, lo=0, hi=len(a), *, key=None)

Similar to insort_left(), but inserting x in a after any existing entries of x.

This function first runs bisect_right() to locate an insertion point. Next, it runs the insert() method on a to insert x at the appropriate position to maintain sort order.

Щоб підтримувати вставлення записів у таблицю, функція key (якщо є) застосовується до x для кроку пошуку, але не для кроку вставки.

Keep in mind that the O(log n) search is dominated by the slow O(n) insertion step.

Змінено в версії 3.10: Додано параметр key.

Примітки щодо продуктивності

Під час написання чутливого до часу коду за допомогою bisect() і insort() пам’ятайте про такі думки:

  • Ділення навпіл ефективне для пошуку діапазонів значень. Для пошуку конкретних значень словники більш ефективні.

  • The insort() functions are O(n) because the logarithmic search step is dominated by the linear time insertion step.

  • The search functions are stateless and discard key function results after they are used. Consequently, if the search functions are used in a loop, the key function may be called again and again on the same array elements. If the key function isn’t fast, consider wrapping it with functools.cache() to avoid duplicate computations. Alternatively, consider searching an array of precomputed keys to locate the insertion point (as shown in the examples section below).

Дивись також

  • Sorted Collections is a high performance module that uses bisect to managed sorted collections of data.

  • Рецепт SortedCollection використовує bisect для створення повнофункціонального класу колекції з прямими методами пошуку та підтримкою функції ключа. Ключі попередньо обчислені, щоб уникнути непотрібних викликів функції клавіш під час пошуку.

Пошук у відсортованих списках

The above bisect functions are useful for finding insertion points but can be tricky or awkward to use for common searching tasks. The following five functions show how to transform them into the standard lookups for sorted lists:

def index(a, x):
    'Locate the leftmost value exactly equal to x'
    i = bisect_left(a, x)
    if i != len(a) and a[i] == x:
        return i
    raise ValueError

def find_lt(a, x):
    'Find rightmost value less than x'
    i = bisect_left(a, x)
    if i:
        return a[i-1]
    raise ValueError

def find_le(a, x):
    'Find rightmost value less than or equal to x'
    i = bisect_right(a, x)
    if i:
        return a[i-1]
    raise ValueError

def find_gt(a, x):
    'Find leftmost value greater than x'
    i = bisect_right(a, x)
    if i != len(a):
        return a[i]
    raise ValueError

def find_ge(a, x):
    'Find leftmost item greater than or equal to x'
    i = bisect_left(a, x)
    if i != len(a):
        return a[i]
    raise ValueError

Приклади

The bisect() function can be useful for numeric table lookups. This example uses bisect() to look up a letter grade for an exam score (say) based on a set of ordered numeric breakpoints: 90 and up is an „A“, 80 to 89 is a „B“, and so on:

>>> def grade(score, breakpoints=[60, 70, 80, 90], grades='FDCBA'):
...     i = bisect(breakpoints, score)
...     return grades[i]
...
>>> [grade(score) for score in [33, 99, 77, 70, 89, 90, 100]]
['F', 'A', 'C', 'C', 'B', 'A', 'A']

The bisect() and insort() functions also work with lists of tuples. The key argument can serve to extract the field used for ordering records in a table:

>>> from collections import namedtuple
>>> from operator import attrgetter
>>> from bisect import bisect, insort
>>> from pprint import pprint

>>> Movie = namedtuple('Movie', ('name', 'released', 'director'))

>>> movies = [
...     Movie('Jaws', 1975, 'Spielberg'),
...     Movie('Titanic', 1997, 'Cameron'),
...     Movie('The Birds', 1963, 'Hitchcock'),
...     Movie('Aliens', 1986, 'Cameron')
... ]

>>> # Find the first movie released after 1960
>>> by_year = attrgetter('released')
>>> movies.sort(key=by_year)
>>> movies[bisect(movies, 1960, key=by_year)]
Movie(name='The Birds', released=1963, director='Hitchcock')

>>> # Insert a movie while maintaining sort order
>>> romance = Movie('Love Story', 1970, 'Hiller')
>>> insort(movies, romance, key=by_year)
>>> pprint(movies)
[Movie(name='The Birds', released=1963, director='Hitchcock'),
 Movie(name='Love Story', released=1970, director='Hiller'),
 Movie(name='Jaws', released=1975, director='Spielberg'),
 Movie(name='Aliens', released=1986, director='Cameron'),
 Movie(name='Titanic', released=1997, director='Cameron')]

Якщо функція ключа є дорогою, можна уникнути повторних викликів функції шляхом пошуку списку попередньо обчислених ключів, щоб знайти індекс запису:

>>> data = [('red', 5), ('blue', 1), ('yellow', 8), ('black', 0)]
>>> data.sort(key=lambda r: r[1])       # Or use operator.itemgetter(1).
>>> keys = [r[1] for r in data]         # Precompute a list of keys.
>>> data[bisect_left(keys, 0)]
('black', 0)
>>> data[bisect_left(keys, 1)]
('blue', 1)
>>> data[bisect_left(keys, 5)]
('red', 5)
>>> data[bisect_left(keys, 8)]
('yellow', 8)