File: RopeMetric.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (35 lines) | stat: -rw-r--r-- 1,315 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift Collections open source project
//
// Copyright (c) 2023 - 2024 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
//
//===----------------------------------------------------------------------===//

public protocol RopeMetric<Element>: Sendable {
  associatedtype Element: RopeElement

  /// Returns the size of a summarized rope element in this metric.
  func size(of summary: Element.Summary) -> Int

  /// Returns an index addressing the content at the given offset from
  /// the start of the specified rope element.
  ///
  /// - Parameter offset: An integer offset from the start of `element` in this
  ///     metric, not exceeding `size(of: element.summary)`.
  /// - Parameter element: An arbitrary rope element.
  /// - Returns: The index addressing the desired position in the input element.
  func index(at offset: Int, in element: Element) -> Element.Index
}

extension RopeMetric {
  @inlinable @inline(__always)
  internal func _nonnegativeSize(of summary: Element.Summary) -> Int {
    let r = size(of: summary)
    assert(r >= 0)
    return r
  }
}