Accessing an Array’s Uninitialized Buffer

Array と ContiguousArray に、未初期化バッファに直接アクセスできるイニシャライザと、既存配列の記憶領域を未初期化部分まで含めて扱えるメソッドの2つを追加することを提案していました。

init(unsafeUninitializedCapacity:initializingWith:)

容量を指定して Array を作り、クロージャの中で未初期化バッファに直接書き込めるイニシャライザです。クロージャは UnsafeMutableBufferPointer と、初期化済み要素数を表す inout Int を受け取り、クロージャ終了時点で buffer[0..<initializedCount] が初期化済み、残りが未初期化 という状態を満たす必要があります。

var myArray = Array<Int>(unsafeUninitializedCapacity: 10) { buffer, initializedCount in
    for x in 1..<5 {
        buffer[x] = x
    }
    buffer[0] = 10
    initializedCount = 5
}
// myArray == [10, 1, 2, 3, 4]

Array の実際の capacity は要求より大きくなる場合もありますが、クロージャに渡されるバッファは 要求した要素数ちょうどの長さ になります。これは「要求容量よりバッファが大きい」ことを前提にした誤ったコードを書きにくくするためです。

このイニシャライザを使うと、stable partition を余計なコピーなしで書けます。バッファの先頭から「条件を満たす要素」を、末尾から「そうでない要素」を書き込んでいき、最後に末尾側の区間を反転させるだけで済みます。

func stablyPartitioned(by belongsInFirstPartition: (Element) throws -> Bool) rethrows -> [Element] {
    return try Array<Element>(unsafeUninitializedCapacity: count) {
        buffer, initializedCount in
        var low = buffer.baseAddress!
        var high = low + buffer.count
        do {
            for element in self {
                if try belongsInFirstPartition(element) {
                    low.initialize(to: element)
                    low += 1
                } else {
                    high -= 1
                    high.initialize(to: element)
                }
            }

            let highIndex = high - buffer.baseAddress!
            buffer[highIndex...].reverse()
            initializedCount = buffer.count
        } catch {
            let lowCount = low - buffer.baseAddress!
            let highCount = (buffer.baseAddress! + buffer.count) - high
            buffer.baseAddress!.deinitialize(count: lowCount)
            high.deinitialize(count: highCount)
            throw error
        }
    }
}

withUnsafeMutableBufferPointerToStorage(capacity:_:)

もうひとつの追加が、既存の Array に対する mutating メソッドです。要求 capacity を満たすように必要ならバッファを拡張したうえで、初期化済み要素と未初期化領域の両方をカバーする UnsafeMutableBufferPointer と、初期化済み要素数をクロージャに渡します。クロージャは既存要素の変更・破棄や、新規領域の初期化を自由に行え、終了時に initializedCount が最終的な要素数を表すようにします。

public mutating func withUnsafeMutableBufferPointerToStorage<Result>(
    capacity: Int,
    _ body: (
        _ buffer: inout UnsafeMutableBufferPointer<Element>,
        _ initializedCount: inout Int
    ) throws -> Result
) rethrows -> Result

capacity には現在の count 以上の値を渡す必要があり、違反すると実行時エラーになります。これは、配列の中間から要素を切り詰めるような曖昧な操作を防ぐためです。

var a = Array(1...10)
a.withUnsafeMutableBufferPointerToStorage(capacity: 5) { ... } // 実行時エラー

エラー送出時の扱い

クロージャが throw した場合、その時点の initializedCount の値が正しいものとして扱われます。途中で例外を投げたいコードは、投げる前に次のいずれかを満たす必要があります。

1. その時点で新たに初期化した要素を deinitialize する、あるいは逆に破棄してしまった既存要素を再初期化する。
2. initializedCount を現在の実際の初期化済み要素数に更新する。

いずれにしても、「buffer[0..<initializedCount] は初期化済み、buffer[initializedCount...] は未初期化」という事後条件が保たれるようにする責任がユーザー側にあります。

Withdrawn となった経緯

この提案はレビューを経て Withdrawn（Returned for revision） となりました。特に、既存 Array に対する mutating メソッド withUnsafeMutableBufferPointerToStorage(capacity:) のセマンティクスについて、既存要素の扱いや命名をめぐって議論が収束せず、改訂のうえで再提案する方針となりました。

その後、イニシャライザ側のみに絞って改訂された SE-0245: Add an Array Initializer with Access to Uninitialized Storage が Swift 5.1 で採択・実装され、Array(unsafeUninitializedCapacity:initializingWith:) として現在利用できる形になっています。本提案で議論された withUnsafeMutableBufferPointerToStorage(capacity:) に相当するメソッドは、少なくともこの経路では標準ライブラリに入りませんでした。