We currently have Array#bsearch but no Array#bsearch_index and to me it seems that violates the principle of least surprise, especially when we consider the other combinations of existing methods that find either an element or it’s index.
For example: the method would be very useful when needing to slice out a part of a sorted array. It would allow very quick location of the indices of the beginning and end of the segment.
A quick google of “ruby bsearch_index” reveals that I am not the only one that needed and expected that function to exist:
The very good thing is that we can get that method almost for free since the current implementation of bsearch internally finds the index and then looks up the actual element.
I have opened a PR on the github mirror that adds bsearch_index in what seems to me the simplest way possible: https://github.com/ruby/ruby/pull/813 .
I changed the bsearch implementation into bsearch_index and based the bsearch on it.
Please Note: The diff is deceptively large, if you look carefully you will notice that the change is actually small and the actual binary search algorithm remained completely intact.
I have kept the behaviour documentation on bsearch and simply referenced it from bsearch_index to minimize the documentation changes.