[Swift] 値を特定値域に限定する / clamp

環境＆対象

Range

Range は、範囲を表現するための型です。
実際には、開始位置は 閉区間、終了位置は 開区間 になります。

参考
RangeApple Developer Documentation

開始/終了の両方が閉区間を表現する ClosedRange もあります。

参考
ClosedRangeApple Developer Documentation

clamped(to:)

値域を扱うときに、特定の範囲に収まるように値域を調整したいケースがあります。

Swift では、clamped(to:) というメソッドが用意されています。

参考
clamped(to:)Apple Developer Documentation

to に与えられた Range に収まるような Range を返します。

Range の(範囲の対象となる) Bound は、Comparable な型なので、その順序に応じた処理がされます。

なお、同様なメソッドが ClosedRange にも用意されています。

以下は、clamped(to:) の動作を確認した時のテストコードです。

    @Test func understandClamped() async throws {
        #expect((1..<10).clamped(to: 2..<5) == 2..<5)
        #expect((1..<10).clamped(to: 0..<3) == 1..<3)
        #expect((1..<10).clamped(to: 7..<15) == 7..<10)
        #expect((1..<10).clamped(to: 15..<25) == 15..<15)
    }

４つ目のテストで確認している “２つのRange の値域がまったく交わらない時” の挙動に少し注意が必要でしょうか。

Double/Int 等を clamp

clamp を理解すると 同様の操作を Double や Int に適用したくなります。

ですが、今のところ(?) は用意されていないようです。

以下のような感じで、extension を作ると Range と同様に適用できるようになります。

extension ClosedRange {
    public func clamp(_ value: Bound) -> Bound {
        if value < self.lowerBound {
            return self.lowerBound
        } else if self.upperBound < value {
            return self.upperBound
        }
        return value
    }
}

以下のようなテストコードで挙動を確認できます。

    @Test func clamp_check() async throws {
        #expect((1...3).clamp(2) == 2)
        #expect((1...3).clamp(5) == 3)
        #expect((1...3).clamp(-2) == 1)
    }

まとめ

Range/ClosedRange の clampedを確認し、Double/Int 等にも同様の処理ができるようにしてみました。

説明は以上です。
不明な点やおかしな点ありましたら、こちらまで。

SwiftUI おすすめ本

SwiftUI を理解するには、以下の本がおすすめです。

SwiftUI 徹底入門

＃ SwiftUI は、毎年大きく改善されていますので、少し古くなってしまいましたが、いまでも 定番本です。

Swift学習におすすめの本

詳解Swift

Swift の学習には、詳解 Swift という書籍が、おすすめです。

著者は、Swift の初期から書籍を出していますし、Swift の前に主力言語だった Objective-C という言語についても同様の書籍を出しています。

最新版を購入するのがおすすめです。

現時点では、上記の Swift 5 に対応した第５版が最新版です。

関連記事:

[SwiftUI][SwiftCharts] 複数系列のデータを１つのグラフに表示する [Swift] NSRange と Range の使い方 [Swift][TextKit] textStorage(:,willProcessEditing/didprocessEditing:,range:,changeInLength) に渡される情報まとめ [Swift] String の範囲指定を理解する (String/Range, NSString/NSRange)