8000 Improvements to the bisect docs by rhettinger · Pull Request #95807 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

Improvements to the bisect docs #95807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 9, 2022
Merged

Improvements to the bisect docs #95807

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
424044d
Misc improvements to the bisect docs:
rhettinger Aug 9, 2022
a45e91f
More touchups
rhettinger Aug 9, 2022
90109c9
Change *i* to *ip*
rhettinger Aug 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Diff view
38 changes: 19 additions & 19 deletions Doc/library/bisect.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,16 @@

This module provides support for maintaining a list in sorted order without
having to sort the list after each in 8000 sertion. For long lists of items with
expensive comparison operations, this can be an improvement over the more common
approach. The module is called :mod:`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!).
expensive comparison operations, this can be an improvement over
linear searches or frequent resorting.

The module is called :mod:`bisect` because it uses a basic bisection
algorithm to do its work. Unlike other bisection tools that search for a
specific value, the functions in this module are designed to locate an
insertion point. Accordingly, the functions never call an :meth:`__eq__`
method to determine whether a value has been found. Instead, the
functions only call the :meth:`__lt__` method and will return an insertion
point between values in an array.

The following functions are provided:

Expand All @@ -30,16 +36,17 @@ The following functions are provided:
any existing entries. The return value is suitable for use as the first
parameter to ``list.insert()`` assuming that *a* is already sorted.

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.
The returned insertion point *ip* partitions the array *a* into two
slices such that ``all(elem < x for elem in a[lo : ip])`` is true for the
left slice and ``all(elem >= x for elem in a[ip : hi])`` is true for the
right slice.

*key* specifies a :term:`key function` of one argument that is used to
extract a comparison key from each element in the array. To support
searching complex records, the key function is not applied to the *x* value.

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

.. versionchanged:: 3.10
Added the *key* parameter.
Expand All @@ -51,16 +58,9 @@ The following functions are provided:
Similar to :func:`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* specifies a :term:`key function` of one argument that is used to
extract a comparison key from each element in the array. To support
searching complex records, the key function is not applied to the *x* value.

If *key* is ``None``, the elements are compared directly with no
intervening function call.
The returned insertion point *ip* partitions the array *a* into two slices
such that ``all(elem <= x for elem in a[lo : ip])`` is true for the left slice and
``all(elem > x for elem in a[ip : hi])`` is true for the right slice.

.. versionchanged:: 3.10
Added the *key* parameter.
Expand Down
0