mirror of
https://github.com/apple/swift-collections
synced 2026-11-22 04:20:40 +00:00
339 lines
13 KiB
Swift
339 lines
13 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift Collections open source project
|
|
//
|
|
// Copyright (c) 2024 - 2026 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
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0 WITH Swift-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#if !COLLECTIONS_SINGLE_MODULE
|
|
import InternalCollectionsUtilities
|
|
import SpanPreview
|
|
#endif
|
|
|
|
@available(SwiftStdlib 5.0, *)
|
|
extension UniqueArray where Element: ~Copyable {
|
|
/// Inserts a new element into the array at the specified position.
|
|
///
|
|
/// If the array does not have sufficient capacity to hold any more elements,
|
|
/// then this reallocates storage to extend its capacity, using a geometric
|
|
/// growth rate.
|
|
///
|
|
/// The new element is inserted before the element currently at the specified
|
|
/// index. If you pass the array's `endIndex` as the `index` parameter, then
|
|
/// the new element is appended to the container.
|
|
///
|
|
/// All existing elements at or following the specified position are moved to
|
|
/// make room for the new item.
|
|
///
|
|
/// - Parameter item: The new element to insert into the array.
|
|
/// - Parameter index: The position at which to insert the new element.
|
|
/// `index` must be a valid index in the array.
|
|
/// - Returns: A valid index to the newly inserted item.
|
|
/// - Complexity: O(`self.count`)
|
|
@inlinable
|
|
@discardableResult
|
|
public mutating func insert(_ item: consuming Element, at index: Int) -> Int {
|
|
precondition(index >= 0 && index <= count)
|
|
// FIXME: Avoid moving the subsequent elements twice.
|
|
_ensureFreeCapacity(1)
|
|
return _storage.insert(item, at: index)
|
|
}
|
|
}
|
|
|
|
@available(SwiftStdlib 5.0, *)
|
|
extension UniqueArray where Element: ~Copyable {
|
|
/// Inserts a given number of new items into this array at the specified
|
|
/// position, using a callback to directly initialize array storage by
|
|
/// populating an output span.
|
|
///
|
|
/// Existing elements in the array's storage are moved towards the back as
|
|
/// needed to make room for the new items.
|
|
///
|
|
/// If the array does not have sufficient capacity to hold the new elements,
|
|
/// then this operation reallocates storage to extend its capacity, using a
|
|
/// geometric growth rate.
|
|
///
|
|
/// var buffer = UniqueArray<Int>()
|
|
/// buffer.append([-999, 999])
|
|
/// var i = 0
|
|
/// buffer.insert(capacity: 3, at: 1) { target in
|
|
/// while !target.isFull {
|
|
/// target.append(i)
|
|
/// i += 1
|
|
/// }
|
|
/// }
|
|
/// // `buffer` now contains [-999, 0, 1, 2, 999]
|
|
///
|
|
/// - Parameters:
|
|
/// - newItemCount: The number of items to insert into the array.
|
|
/// - index: The position at which to insert the new items.
|
|
/// `index` must be a valid index in the array.
|
|
/// - body: A callback that gets called at most once to directly
|
|
/// populate newly reserved storage within the array. The function
|
|
/// is called with an empty output span of capacity matching the
|
|
/// supplied count, and it must fully populate it before returning.
|
|
/// - Returns: A valid index range addressing the newly inserted items.
|
|
/// - Complexity: O(`self.count` + `count`)
|
|
@_alwaysEmitIntoClient
|
|
@inline(__always)
|
|
@discardableResult
|
|
public mutating func insert<E: Error>(
|
|
addingCount newItemCount: Int,
|
|
at index: Int,
|
|
initializingWith initializer: (inout OutputSpan<Element>) throws(E) -> Void
|
|
) throws(E) -> Range<Int> {
|
|
_ensureFreeCapacity(newItemCount)
|
|
return try _storage.insert(
|
|
addingCount: newItemCount,
|
|
at: index,
|
|
initializingWith: initializer)
|
|
}
|
|
}
|
|
|
|
@available(SwiftStdlib 5.0, *)
|
|
extension UniqueArray where Element: ~Copyable {
|
|
/// Moves the elements of a fully initialized buffer into this array,
|
|
/// starting at the specified position, and leaving the buffer
|
|
/// uninitialized.
|
|
///
|
|
/// If the array does not have sufficient capacity to hold all elements,
|
|
/// then this reallocates storage to extend its capacity, using a geometric
|
|
/// growth rate.
|
|
///
|
|
/// - Parameters:
|
|
/// - items: A fully initialized buffer whose contents to move into
|
|
/// the array.
|
|
/// - Returns: A valid index range addressing the newly inserted items.
|
|
/// - Complexity: O(`self.count` + `items.count`)
|
|
@_alwaysEmitIntoClient
|
|
@discardableResult
|
|
@unsafe
|
|
public mutating func insert(
|
|
moving items: UnsafeMutableBufferPointer<Element>,
|
|
at index: Int
|
|
) -> Range<Int> {
|
|
// FIXME: Avoid moving the subsequent elements twice.
|
|
_ensureFreeCapacity(items.count)
|
|
return unsafe _storage.insert(moving: items, at: index)
|
|
}
|
|
|
|
#if UnstableContainersPreview
|
|
/// Moves the elements of an input span into this array,
|
|
/// starting at the specified position, and leaving the span empty.
|
|
///
|
|
/// All existing elements at or following the specified position are moved to
|
|
/// make room for the new items.
|
|
///
|
|
/// If the array does not have sufficient capacity to hold the new elements,
|
|
/// then this reallocates storage to extend its capacity, using a geometric
|
|
/// growth rate.
|
|
///
|
|
/// - Parameters:
|
|
/// - items: An input span whose contents to move into
|
|
/// the array.
|
|
/// - index: The position at which to insert the new items.
|
|
/// `index` must be a valid index in the array.
|
|
/// - Returns: A valid index range addressing the newly inserted items.
|
|
/// - Complexity: O(`self.count` + `items.count`)
|
|
@_alwaysEmitIntoClient
|
|
@discardableResult
|
|
public mutating func insert(
|
|
moving items: inout InputSpan<Element>,
|
|
at index: Int
|
|
) -> Range<Int> {
|
|
// FIXME: Remove when InputSpan starts conforming to RangeReplaceableContainer
|
|
_ensureFreeCapacity(items.count)
|
|
return _storage.insert(moving: &items, at: index)
|
|
}
|
|
#endif
|
|
|
|
/// Moves the elements of an output span into this array,
|
|
/// starting at the specified position, and leaving the span empty.
|
|
///
|
|
/// All existing elements at or following the specified position are moved to
|
|
/// make room for the new items.
|
|
///
|
|
/// If the array does not have sufficient capacity to hold the new elements,
|
|
/// then this reallocates storage to extend its capacity, using a geometric
|
|
/// growth rate.
|
|
///
|
|
/// - Parameters:
|
|
/// - items: An output span whose contents to move into
|
|
/// the array.
|
|
/// - index: The position at which to insert the new items.
|
|
/// `index` must be a valid index in the array.
|
|
/// - Returns: A valid index range addressing the newly inserted items.
|
|
/// - Complexity: O(`self.count` + `items.count`)
|
|
@_alwaysEmitIntoClient
|
|
@discardableResult
|
|
public mutating func insert(
|
|
moving items: inout OutputSpan<Element>,
|
|
at index: Int
|
|
) -> Range<Int> {
|
|
// FIXME: Remove when OutputSpan starts conforming to RangeReplaceableContainer
|
|
_ensureFreeCapacity(items.count)
|
|
return _storage.insert(moving: &items, at: index)
|
|
}
|
|
|
|
/// Inserts the elements of a given array into the given position in this
|
|
/// array by moving them between the containers. On return, the input array
|
|
/// becomes empty, but it is not destroyed, and it preserves its original
|
|
/// storage capacity.
|
|
///
|
|
/// If the array does not have sufficient capacity to hold all elements,
|
|
/// then this reallocates storage to extend its capacity, using a geometric
|
|
/// growth rate.
|
|
///
|
|
/// - Parameters:
|
|
/// - items: An array whose contents to move into `self`.
|
|
/// - index: The position in `self` at which to insert the new items.
|
|
/// - Returns: A valid index range addressing the newly inserted items.
|
|
/// - Complexity: O(`self.count` + `items.count`)
|
|
@_alwaysEmitIntoClient
|
|
@discardableResult
|
|
public mutating func insert(
|
|
moving items: inout RigidArray<Element>,
|
|
at index: Int
|
|
) -> Range<Int> {
|
|
// FIXME: Avoid moving the subsequent elements twice.
|
|
_ensureFreeCapacity(items.count)
|
|
return _storage.insert(moving: &items, at: index)
|
|
}
|
|
}
|
|
|
|
@available(SwiftStdlib 5.0, *)
|
|
extension UniqueArray {
|
|
/// Copies the elements of a fully initialized buffer pointer into this
|
|
/// array at the specified position.
|
|
///
|
|
/// The new elements are inserted before the element currently at the
|
|
/// specified index. If you pass the array's `endIndex` as the `index`
|
|
/// parameter, then the new elements are appended to the end of the array.
|
|
///
|
|
/// All existing elements at or following the specified position are moved to
|
|
/// make room for the new item.
|
|
///
|
|
/// If the array does not have sufficient capacity to hold enough elements,
|
|
/// then this reallocates the array's storage to extend its capacity, using a
|
|
/// geometric growth rate.
|
|
///
|
|
/// - Parameters:
|
|
/// - newElements: The new elements to insert into the array. The buffer
|
|
/// must be fully initialized.
|
|
/// - index: The position at which to insert the new elements. It must be
|
|
/// a valid index of the array.
|
|
/// - Returns: A valid index range addressing the newly inserted items.
|
|
/// - Complexity: O(`self.count` + `newElements.count`)
|
|
@inlinable
|
|
@discardableResult
|
|
@unsafe
|
|
public mutating func insert(
|
|
copying newElements: UnsafeBufferPointer<Element>, at index: Int
|
|
) -> Range<Int> {
|
|
// FIXME: Avoid moving the subsequent elements twice.
|
|
_ensureFreeCapacity(newElements.count)
|
|
return unsafe _storage.insert(copying: newElements, at: index)
|
|
}
|
|
|
|
/// Copies the elements of a fully initialized buffer pointer into this
|
|
/// array at the specified position.
|
|
///
|
|
/// The new elements are inserted before the element currently at the
|
|
/// specified index. If you pass the array's `endIndex` as the `index`
|
|
/// parameter, then the new elements are appended to the end of the array.
|
|
///
|
|
/// All existing elements at or following the specified position are moved to
|
|
/// make room for the new item.
|
|
///
|
|
/// If the array does not have sufficient capacity to hold enough elements,
|
|
/// then this reallocates the array's storage to extend its capacity, using a
|
|
/// geometric growth rate.
|
|
///
|
|
/// - Parameters:
|
|
/// - newElements: The new elements to insert into the array. The buffer
|
|
/// must be fully initialized.
|
|
/// - index: The position at which to insert the new elements. It must be
|
|
/// a valid index of the array.
|
|
/// - Returns: A valid index range addressing the newly inserted items.
|
|
/// - Complexity: O(`self.count` + `newElements.count`)
|
|
@inlinable
|
|
@discardableResult
|
|
@unsafe
|
|
public mutating func insert(
|
|
copying newElements: UnsafeMutableBufferPointer<Element>,
|
|
at index: Int
|
|
) -> Range<Int> {
|
|
unsafe self.insert(copying: UnsafeBufferPointer(newElements), at: index)
|
|
}
|
|
|
|
/// Copies the elements of a span into this array at the specified position.
|
|
///
|
|
/// The new elements are inserted before the element currently at the
|
|
/// specified index. If you pass the array's `endIndex` as the `index`
|
|
/// parameter, then the new elements are appended to the end of the array.
|
|
///
|
|
/// All existing elements at or following the specified position are moved to
|
|
/// make room for the new item.
|
|
///
|
|
/// If the array does not have sufficient capacity to hold enough elements,
|
|
/// then this reallocates the array's storage to extend its capacity, using a
|
|
/// geometric growth rate.
|
|
///
|
|
/// - Parameters:
|
|
/// - newElements: The new elements to insert into the array.
|
|
/// - index: The position at which to insert the new elements. It must be
|
|
/// a valid index of the array.
|
|
/// - Returns: A valid index range addressing the newly inserted items.
|
|
/// - Complexity: O(`self.count` + `newElements.count`)
|
|
@inlinable
|
|
@discardableResult
|
|
public mutating func insert(
|
|
copying newElements: Span<Element>, at index: Int
|
|
) -> Range<Int> {
|
|
// FIXME: Avoid moving the subsequent elements twice.
|
|
_ensureFreeCapacity(newElements.count)
|
|
return _storage.insert(copying: newElements, at: index)
|
|
}
|
|
|
|
/// Copies the elements of a collection into this array at the specified
|
|
/// position.
|
|
///
|
|
/// The new elements are inserted before the element currently at the
|
|
/// specified index. If you pass the array's `endIndex` as the `index`
|
|
/// parameter, then the new elements are appended to the end of the array.
|
|
///
|
|
/// All existing elements at or following the specified position are moved
|
|
/// to make room for the new item.
|
|
///
|
|
/// If the array does not have sufficient capacity to hold enough elements,
|
|
/// then this reallocates the array's storage to extend its capacity, using a
|
|
/// geometric growth rate.
|
|
///
|
|
/// - Parameters:
|
|
/// - newElements: The new elements to insert into the array.
|
|
/// - index: The position at which to insert the new elements. It must be
|
|
/// a valid index of the array.
|
|
/// - Returns: A valid index range addressing the newly inserted items.
|
|
/// - Complexity: O(`self.count` + `newElements.count`)
|
|
@inlinable
|
|
@discardableResult
|
|
public mutating func insert(
|
|
copying newElements: some Collection<Element>, at index: Int
|
|
) -> Range<Int> {
|
|
// FIXME: Remove this -- RangeReplaceContainer already has this algorithm.
|
|
// (Note that this would be source breaking while RRC lives in the separate
|
|
// ContainersPreview module.)
|
|
// FIXME: Avoid moving the subsequent elements twice.
|
|
let newCount = newElements.count
|
|
_ensureFreeCapacity(newCount)
|
|
return _storage._insertCollection(
|
|
addingCount: newCount, copying: newElements, at: index)
|
|
}
|
|
}
|