File: IdentifierFactory.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 (46 lines) | stat: -rw-r--r-- 1,973 bytes parent folder | download | duplicates (2)
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
// This source file is part of the Swift.org open source project
//
// Copyright 2019 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for Swift project authors

/// IdentifierFactory creates unique identifiers for given elements.
/// It provides an API to map between identifiers and elements and can be used
/// for fast lookups.
public final class IdentifierFactory<T: Hashable> {
    public typealias Identifier = Array<T>.Index
    public let elements: [T]
    private var identifiers: [T: Identifier]
    
    /// Initializes a new factory using a collection of elements.
    /// - Parameter elements: Contains all elements which will become valid input for calling `identifier(element:)`.
    public init<C>(_ elements: C) where C: Collection, C.Element == T {
        self.elements = Array(elements)
        var identifierLookup = [T: Identifier](minimumCapacity: self.elements.count)
        for (index, element) in elements.enumerated() {
            identifierLookup[element] = index
        }
        self.identifiers = identifierLookup
    }
    
    public var count: Int {
        return elements.count
    }
    
    /// Returns the element for a provided identifier.
    /// - Parameter id: An identifier created using `identifier(element:)`
    public func element(id: Identifier) -> T {
        return elements[id]
    }
    
    /// Returns a unique identifier for a given element.
    /// - Parameter element: The element must have been part of the collection used in the initialization.
    public func identifier(element: T) -> Identifier {
        guard let identifier = self.identifiers[element] else {
            preconditionFailure("Could not get identifier for \(element) because it was not initially added to the IdentifierFactory.")
        }
        return identifier
    }
}