File: CompletionScore.swift

package info (click to toggle)
swiftlang 6.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,856,264 kB
  • sloc: cpp: 9,995,718; ansic: 2,234,019; asm: 1,092,167; python: 313,940; objc: 82,726; f90: 80,126; lisp: 38,373; pascal: 25,580; sh: 20,378; ml: 5,058; perl: 4,751; makefile: 4,725; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (75 lines) | stat: -rw-r--r-- 2,665 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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 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
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

import Foundation

/// Represents a composite score formed from a semantic and textual components.
///
/// The textual component forms the bulk of the score typically having a value in the 10's to 100's.
/// You can think of the semantic component as a bonus to the text score.
/// It usually has a value between 0 and 2, and is used as a multiplier.
package struct CompletionScore: Comparable {
  package var semanticComponent: Double
  package var textComponent: Double

  package init(textComponent: Double, semanticComponent: Double) {
    self.semanticComponent = semanticComponent
    self.textComponent = textComponent
  }

  package init(textComponent: Double, semanticClassification: SemanticClassification) {
    self.semanticComponent = semanticClassification.score
    self.textComponent = textComponent
  }

  package var value: Double {
    semanticComponent * textComponent
  }

  package static func < (_ lhs: Self, _ rhs: Self) -> Bool {
    lhs.value < rhs.value
  }
}

// MARK: - Deprecated -
extension CompletionScore {
  /// There is no natural order to these arguments, so they're alphabetical.
  @available(
    *,
    deprecated,
    renamed:
      "SemanticClassification(completionKind:deprecationStatus:flair:moduleProximity:popularity:scopeProximity:structuralProximity:synchronicityCompatibility:typeCompatibility:)"
  )
  package static func semanticScore(
    completionKind: CompletionKind,
    deprecationStatus: DeprecationStatus,
    flair: Flair,
    moduleProximity: ModuleProximity,
    popularity: Popularity,
    scopeProximity: ScopeProximity,
    structuralProximity: StructuralProximity,
    synchronicityCompatibility: SynchronicityCompatibility,
    typeCompatibility: TypeCompatibility
  ) -> Double {
    SemanticClassification(
      availability: deprecationStatus,
      completionKind: completionKind,
      flair: flair,
      moduleProximity: moduleProximity,
      popularity: popularity,
      scopeProximity: scopeProximity,
      structuralProximity: structuralProximity,
      synchronicityCompatibility: synchronicityCompatibility,
      typeCompatibility: typeCompatibility
    ).score
  }
}