Skip to content

Commit 5334240

Browse files
lorenteylorentey
committed
SortedSet, SortedBag: Rename index finding methods
Index manipulations in Swift use prepositions indicating horizontal or chronological placement (before/after), not vertical placement (above/below)
1 parent 7029d32 commit 5334240

File tree

4 files changed

+24
-24
lines changed

4 files changed

+24
-24
lines changed

‎Sources/SortedBag.swift

+4-4
Original file line numberDiff line numberDiff line change
@@ -451,7 +451,7 @@ extension SortedBag {
451451
/// This function never returns `endIndex`. (If it returns non-nil, the returned index can be used to subscript the bag.)
452452
///
453453
/// - Complexity: O(log(`count`))
454-
public func lowestIndex(above element: Element) -> BTreeIndex<Element, Void>? {
454+
public func indexOfFirstElement(after element: Element) -> BTreeIndex<Element, Void>? {
455455
let index = tree.index(forInserting: element, at: .last)
456456
if tree.offset(of: index) == tree.count { return nil }
457457
return index
@@ -462,7 +462,7 @@ extension SortedBag {
462462
/// This function never returns `endIndex`. (If it returns non-nil, the returned index can be used to subscript the bag.)
463463
///
464464
/// - Complexity: O(log(`count`))
465-
public func lowestIndex(notBelow element: Element) -> BTreeIndex<Element, Void>? {
465+
public func indexOfFirstElement(notBefore element: Element) -> BTreeIndex<Element, Void>? {
466466
let index = tree.index(forInserting: element, at: .first)
467467
if tree.offset(of: index) == tree.count { return nil }
468468
return index
@@ -473,7 +473,7 @@ extension SortedBag {
473473
/// This function never returns `endIndex`. (If it returns non-nil, the returned index can be used to subscript the bag.)
474474
///
475475
/// - Complexity: O(log(`count`))
476-
public func highestIndex(below element: Element) -> BTreeIndex<Element, Void>? {
476+
public func indexOfLastElement(before element: Element) -> BTreeIndex<Element, Void>? {
477477
var index = tree.index(forInserting: element, at: .first)
478478
if tree.offset(of: index) == 0 { return nil }
479479
tree.formIndex(before: &index)
@@ -485,7 +485,7 @@ extension SortedBag {
485485
/// This function never returns `endIndex`. (If it returns non-nil, the returned index can be used to subscript the bag.)
486486
///
487487
/// - Complexity: O(log(`count`))
488-
public func highestIndex(notAbove element: Element) -> BTreeIndex<Element, Void>? {
488+
public func indexOfLastElement(notAfter element: Element) -> BTreeIndex<Element, Void>? {
489489
var index = tree.index(forInserting: element, at: .last)
490490
if tree.offset(of: index) == 0 { return nil }
491491
tree.formIndex(before: &index)

‎Sources/SortedSet.swift

+4-4
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@ extension SortedSet {
429429
/// This function never returns `endIndex`. (If it returns non-nil, the returned index can be used to subscript the set.)
430430
///
431431
/// - Complexity: O(log(`count`))
432-
public func lowestIndex(above element: Element) -> BTreeIndex<Element, Void>? {
432+
public func indexOfFirstElement(after element: Element) -> BTreeIndex<Element, Void>? {
433433
let index = tree.index(forInserting: element, at: .last)
434434
if tree.offset(of: index) == tree.count { return nil }
435435
return index
@@ -440,7 +440,7 @@ extension SortedSet {
440440
/// This function never returns `endIndex`. (If it returns non-nil, the returned index can be used to subscript the set.)
441441
///
442442
/// - Complexity: O(log(`count`))
443-
public func lowestIndex(notBelow element: Element) -> BTreeIndex<Element, Void>? {
443+
public func indexOfFirstElement(notBefore element: Element) -> BTreeIndex<Element, Void>? {
444444
let index = tree.index(forInserting: element, at: .first)
445445
if tree.offset(of: index) == tree.count { return nil }
446446
return index
@@ -451,7 +451,7 @@ extension SortedSet {
451451
/// This function never returns `endIndex`. (If it returns non-nil, the returned index can be used to subscript the set.)
452452
///
453453
/// - Complexity: O(log(`count`))
454-
public func highestIndex(below element: Element) -> BTreeIndex<Element, Void>? {
454+
public func indexOfLastElement(before element: Element) -> BTreeIndex<Element, Void>? {
455455
var index = tree.index(forInserting: element, at: .first)
456456
if tree.offset(of: index) == 0 { return nil }
457457
tree.formIndex(before: &index)
@@ -463,7 +463,7 @@ extension SortedSet {
463463
/// This function never returns `endIndex`. (If it returns non-nil, the returned index can be used to subscript the set.)
464464
///
465465
/// - Complexity: O(log(`count`))
466-
public func highestIndex(notAbove element: Element) -> BTreeIndex<Element, Void>? {
466+
public func indexOfLastElement(notAfter element: Element) -> BTreeIndex<Element, Void>? {
467467
var index = tree.index(forInserting: element, at: .last)
468468
if tree.offset(of: index) == 0 { return nil }
469469
tree.formIndex(before: &index)

‎Tests/SortedBagTests.swift

+8-8
Original file line numberDiff line numberDiff line change
@@ -363,12 +363,12 @@ class SortedBagTests: XCTestCase {
363363
}
364364
}
365365

366-
func test_lowestIndexAbove() {
366+
func test_indexOfFirstElementAfter() {
367367
let c = 100
368368
let bag = SortedBag((0 ..< c).map { 2 * $0 }.repeatEach(3))
369369

370370
for i in 0 ..< 2 * c {
371-
let index = bag.lowestIndex(above: i)
371+
let index = bag.indexOfFirstElement(after: i)
372372
if i < 2 * (c - 1) {
373373
XCTAssertNotNil(index)
374374
guard let index = index else { continue }
@@ -381,12 +381,12 @@ class SortedBagTests: XCTestCase {
381381
}
382382
}
383383

384-
func test_lowestIndexNotBelow() {
384+
func test_indexOfFirstElementNotBefore() {
385385
let c = 100
386386
let bag = SortedBag((0 ..< c).map { 2 * $0 }.repeatEach(3))
387387

388388
for i in 0 ..< 2 * c {
389-
let index = bag.lowestIndex(notBelow: i)
389+
let index = bag.indexOfFirstElement(notBefore: i)
390390
if i < 2 * c - 1 {
391391
XCTAssertNotNil(index)
392392
guard let index = index else { continue }
@@ -407,12 +407,12 @@ class SortedBagTests: XCTestCase {
407407
}
408408
}
409409

410-
func test_highestIndexBelow() {
410+
func test_indexOfLastElementBefore() {
411411
let c = 100
412412
let bag = SortedBag((0 ..< c).map { 2 * $0 }.repeatEach(3))
413413

414414
for i in -2 ..< 2 * c {
415-
let index = bag.highestIndex(below: i)
415+
let index = bag.indexOfLastElement(before: i)
416416
if i > 0 {
417417
XCTAssertNotNil(index)
418418
guard let index = index else { continue }
@@ -433,12 +433,12 @@ class SortedBagTests: XCTestCase {
433433
}
434434
}
435435

436-
func test_highestIndexNotAbove() {
436+
func test_indexOfLastElementNotAfter() {
437437
let c = 100
438438
let bag = SortedBag((0 ..< c).map { 2 * $0 }.repeatEach(3))
439439

440440
for i in -2 ..< 2 * c {
441-
let index = bag.highestIndex(notAbove: i)
441+
let index = bag.indexOfLastElement(notAfter: i)
442442
if i >= 0 {
443443
XCTAssertNotNil(index)
444444
guard let index = index else { continue }

‎Tests/SortedSetTests.swift

+8-8
Original file line numberDiff line numberDiff line change
@@ -320,12 +320,12 @@ class SortedSetTests: XCTestCase {
320320
}
321321
}
322322

323-
func test_lowestIndexAbove() {
323+
func test_indexOfFirstElementAfter() {
324324
let c = 100
325325
let set = SortedSet((0 ..< c).map { 2 * $0 })
326326

327327
for i in 0 ..< 2 * c {
328-
let index = set.lowestIndex(above: i)
328+
let index = set.indexOfFirstElement(after: i)
329329
if i < 2 * (c - 1) {
330330
XCTAssertNotNil(index)
331331
guard let index = index else { continue }
@@ -343,12 +343,12 @@ class SortedSetTests: XCTestCase {
343343
}
344344
}
345345

346-
func test_lowestIndexNotBelow() {
346+
func test_indexOfFirstElementNotBefore() {
347347
let c = 100
348348
let set = SortedSet((0 ..< c).map { 2 * $0 })
349349

350350
for i in 0 ..< 2 * c {
351-
let index = set.lowestIndex(notBelow: i)
351+
let index = set.indexOfFirstElement(notBefore: i)
352352
if i < 2 * c - 1 {
353353
XCTAssertNotNil(index)
354354
guard let index = index else { continue }
@@ -366,12 +366,12 @@ class SortedSetTests: XCTestCase {
366366
}
367367
}
368368

369-
func test_highestIndexBelow() {
369+
func test_indexOfLastElementBefore() {
370370
let c = 100
371371
let set = SortedSet((0 ..< c).map { 2 * $0 })
372372

373373
for i in -2 ..< 2 * c {
374-
let index = set.highestIndex(below: i)
374+
let index = set.indexOfLastElement(before: i)
375375
if i > 0 {
376376
XCTAssertNotNil(index)
377377
guard let index = index else { continue }
@@ -389,12 +389,12 @@ class SortedSetTests: XCTestCase {
389389
}
390390
}
391391

392-
func test_highestIndexNotAbove() {
392+
func test_indexOfLastElementNotAfter() {
393393
let c = 100
394394
let set = SortedSet((0 ..< c).map { 2 * $0 })
395395

396396
for i in -2 ..< 2 * c {
397-
let index = set.highestIndex(notAbove: i)
397+
let index = set.indexOfLastElement(notAfter: i)
398398
if i >= 0 {
399399
XCTAssertNotNil(index)
400400
guard let index = index else { continue }

0 commit comments

Comments
 (0)