Swift dictionaryの要素を識別する方法としてindexを使用するメリットについて

Question

import UIKit
import SwiftUI
import CoreLocation

let landmarkData: [Landmark] = load("landmarkData.json")

func load<T: Decodable>(_ filename: String) -> T {
    let data: Data
  
    guard let file = Bundle.main.url(forResource: filename, withExtension: nil)
        else {
            fatalError("Couldn't find (filename) in main bundle.")
    }
    
    
    do {
        data = try Data(contentsOf: file)
    } catch {
        fatalError("Couldn't load (filename) from main bundle:\n(error)")
    }
    
    do {
        let decoder = JSONDecoder()
        return try decoder.decode(T.self, from: data)
    } catch {
        fatalError("Couldn't parse (filename) as (T.self):\n(error)")
    }
}




final class ImageStore {
    typealias _ImageDictionary = [String: CGImage]
    fileprivate var images: _ImageDictionary = [:]

    fileprivate static var scale = 2
    
    static var shared = ImageStore()
    

    func image(name: String) -> Image {
        let index = _guaranteeImage(name: name)
        
        return Image(images.values[index], scale: CGFloat(ImageStore.scale), label: Text(name))
    }

    
    
    
    static func loadImage(name: String) -> CGImage {
        
        guard
            let url = Bundle.main.url(forResource: name, withExtension: "jpg"),
            let imageSource = CGImageSourceCreateWithURL(url as NSURL, nil),
            let image = CGImageSourceCreateImageAtIndex(imageSource, 0, nil)
        else {
            fatalError("Couldn't load image (name).jpg from main bundle.")
        }

        return image
    }
    
    
    
    
    fileprivate func _guaranteeImage(name: String) -> _ImageDictionary.Index {
        if let index = images.index(forKey: name) { return index }
        images[name] = ImageStore.loadImage(name: name)
        return images.index(forKey: name)!
    }
}

https://developer.apple.com/tutorials/swiftui/building-lists-and-navigation
上記ページのダウンロードしたプロジェクトのData.swiftなんですが、

ストアドプロパティimagesはディクショナリで、その要素を識別・指定するためにindexを使っています。
ディクショナリ内の要素を識別するのはkeyでできるような気がします。
keyで識別できるのであればindexを使う必要はないと思うのですが、
indexを使っている理由がよくわかりません。

上記コードはindexを使わずに実装することは不可能なのでしょうか?
使わなくてもできるけど使っているのであれば、indexを使うなんらかのメリットがあると思うのですが、
それって何なのでしょうか?

Comments

[hoshi-takanori]

毎回 key でアクセスするよりは index を使った方が速い可能性はありますが、key の追加や削除があると index がずれて事故の原因になるので、普通は key でアクセスする方がいいと思います。(Apple 内部ではレビュー体制が整っているので事故は起こさないし、それよりも速度が重要なのでしょう、きっと。)

Answer 1

たしかに Key でできそうですね。同じく、インデックスを使う理由はまだ分からないですけれど、ひとまず Key を使ったコードに書き換えてみました。書き換えたメソッドだけを抜粋します。

func image(name: String) -> Image {

    return Image(_guaranteeImage(name: name), scale: CGFloat(ImageStore.scale), label: Text(name))
}

fileprivate func _guaranteeImage(name: String) -> CGImage {
        
    if let image = images[name] {
            
        return image
    }
    else {

        let image = ImageStore.loadImage(name: name)
        images[name] = image

        return image
    }
}

キーだけで画像をやりくりできるので、インデックスは必要なくなっています。

今回の修正では、もともとインデックスをやり取りしていたコードを、CGImage 型の値を直接やり取りするコードに変更しましたけれど、この部分は好みによっては、Key をやり取りするコードにしても良いかもしれません。

インデックスを使わない理由は今のところ不明

インデックスを使っていた理由は、想像ですけれど、最後の image(named:) 関数まで画像データの最終的な取得を避けているところから、もしかすると引数や戻り値で CGImage 型の値を渡したり受け取ったりするのを最後の最後まで避けたかったのかもしれません。

ただ、loadImage メソッドを使う必要があったときには格納と再取得が必要になっているので、インデックスを使わないコードと「どっちもどっち」にも見えるので、この想像が当たっているかはわかりません。

また、一般的には Int 型の値を扱うのが最も速いと思うので、インデックスを扱うのも効率的かと思うのですけれど、CGImage はクラス型で定義されている様子なので、同等の速度が期待できるポインターで扱えるため、そちらも「どっちもどっち」な印象でした。

確かな理由を想像できないので、インデックスを使う意図が汲める人がいらしたら教えてください。

インデックスにするかどうかは好みの可能性も

上記のようにインデックスを使わない理由を考えてみましたけれど、そもそものコードの修正で今回の修正ではやり取りするデータに「画像」を選びましたけど、扱うものがインデックスでも、キーでも、画像でも良さそうなことを踏まえると、好みに帰着する可能性もありそうです。

Comments

[moriman]

ありがとうございました。