DoublyLinkedList Structure Reference


                    
                    
                    Address

The address of an element in a doubly linked list.

Declaration

Swift

public struct Address : Hashable, Sendable

extension DoublyLinkedList.Address: CustomStringConvertible

Show on GitHub


                    
                    
                    Addresses

A collection with the addresses of a doubly-linked list.

Declaration

Swift

public struct Addresses : @unchecked Sendable

extension DoublyLinkedList.Addresses: BidirectionalCollection

Show on GitHub


                    
                    
                    Bucket

A bucket in the internal storage of a doubly linked list.

Note

A bucket is said to be used if its element is not nil.

Declaration

Swift

fileprivate struct Bucket

extension DoublyLinkedList.Bucket: Sendable where Element: Sendable

Show on GitHub


                    
                    
                    count

The number of elements in the list.

Declaration

Swift

public private(set) var count: Int { get }

Show on GitHub


                    
                    
                    headOffset

The offset of the list head.

Declaration

Swift

private var headOffset: Int

Show on GitHub


                    
                    
                    tailOffset

The offset of the list tail.

Declaration

Swift

private var tailOffset: Int

Show on GitHub


                    
                    
                    freeOffset

The position of the next free bucket in the list buffer.

Declaration

Swift

private var freeOffset: Int

Show on GitHub


                    
                    
                    storage

The elements in list.

Declaration

Swift

fileprivate var storage: [Bucket]

Show on GitHub


                    
                    
                    init()

Creates an empty list.

Declaration

Swift

public init()

Show on GitHub


                    
                    
                    capacity

The number of elements that can be stored in the list without allocating new storage.

Declaration

Swift

public var capacity: Int { get }

Show on GitHub


                    
                    
                    firstAddress

The address of the first element.

Declaration

Swift

public var firstAddress: Address? { get }

Show on GitHub


                    
                    
                    firstAddress(where:)

Returns the first address at which an element satisfies the given predicate.

Declaration

Swift

public func firstAddress(where predicate: (Element) throws -> Bool) rethrows -> Address?

Show on GitHub


                    
                    
                    lastAddress

The address of the last element.

Declaration

Swift

public var lastAddress: Address? { get }

Show on GitHub


                    
                    
                    lastAddress(where:)

Returns the last address at which an element satisfies the given predicate.

Declaration

Swift

public func lastAddress(where predicate: (Element) throws -> Bool) rethrows -> Address?

Show on GitHub


                    
                    
                    address(after:)

The address of the element that immediately follows the element at address.

Declaration

Swift

public func address(after address: Address) -> Address?

Show on GitHub


                    
                    
                    address(before:)

The address of the element that immediately precedes the element at address.

Declaration

Swift

public func address(before address: Address) -> Address?

Show on GitHub


                    
                    
                    addresses

The addresses in the list.

Declaration

Swift

public var addresses: Addresses { get }

Show on GitHub


                    
                    
                    subscript(_:)

Accesses the element at address.

Declaration

Swift

public subscript(address: Address) -> Element { get set }

Show on GitHub


                    
                    
                    append(_:)

Inserts newElement at the end of the list and returns its address.

Declaration

Swift

@discardableResult
public mutating func append(_ newElement: Element) -> Address

Show on GitHub


                    
                    
                    prepend(_:)

Inserts newElement at the start of the list and returns its address.

Declaration

Swift

@discardableResult
public mutating func prepend(_ newElement: Element) -> Address

Show on GitHub


                    
                    
                    insert(_:after:)

Inserts newElement after the element at address and returns its address.

Requires

address must be a valid an address in self.

Declaration

Swift

@discardableResult
public mutating func insert(_ newElement: Element, after address: Address) -> Address

Show on GitHub


                    
                    
                    insert(_:before:)

Inserts newElement before the element at address and returns its address.

Requires

address must be the address of an element in self.

Declaration

Swift

@discardableResult
public mutating func insert(_ newElement: Element, before address: Address) -> Address

Show on GitHub


                    
                    
                    insert(_:at:)

Inserts newElement at the given position and returns its address.

The new element is inserted before the element currently at position. You can pass a “past the end” index to append newElement at the end of self.

Declaration

Swift

@discardableResult
public mutating func insert(_ newElement: Element, at position: Index) -> Address

Show on GitHub


                    
                    
                    remove(at:)

Removes the element at address.

Declaration

Swift

@discardableResult
public mutating func remove(at address: Address) -> Element

Show on GitHub


                    
                    
                    reserveCapacity(_:)

Reserves enough space to store the minimumCapacity elements without allocating new storage.

Declaration

Swift

public mutating func reserveCapacity(_ minimumCapacity: Int)

Show on GitHub


                    
                    
                    isInBounds(_:)

Returns whether address is in bounds.

Declaration

Swift

private func isInBounds(_ address: Address) -> Bool

Show on GitHub


                    
                    
                    Index

Declaration

Swift

public struct Index : Comparable, Hashable, Sendable

Show on GitHub


                    
                    
                    isEmpty

Declaration

Swift

public var isEmpty: Bool { get }

Show on GitHub


                    
                    
                    first

The first element of the list.

Declaration

Swift

public var first: Element? { get }

Show on GitHub


                    
                    
                    last

The last element of the list.

Declaration

Swift

public var last: Element? { get }

Show on GitHub


                    
                    
                    startIndex

Declaration

Swift

public var startIndex: Index { get }

Show on GitHub


                    
                    
                    endIndex

Declaration

Swift

public var endIndex: Index { get }

Show on GitHub


                    
                    
                    index(after:)

Declaration

Swift

public func index(after i: Index) -> Index

Show on GitHub


                    
                    
                    index(before:)

Declaration

Swift

public func index(before i: Index) -> Index

Show on GitHub


                    
                    
                    subscript(_:)

Declaration

Swift

public subscript(position: Index) -> Element { get set }

Show on GitHub


                    
                    
                    init(arrayLiteral:)

Declaration

Swift

public init(arrayLiteral elements: Element...)

Show on GitHub


                    
                    
                    description

Declaration

Swift

public var description: String { get }

Show on GitHub

DoublyLinkedList

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Available where Element: Equatable

Declaration

Available where Element: Hashable

Declaration

Available where `Element`: `Equatable`

Available where `Element`: `Hashable`