関数(Functions)

最終更新日: 2022/12/3 原文: https://docs.swift.org/swift-book/LanguageGuide/Functions.html

関数を定義して呼び出し、引数にラベルを付け、戻り値を使用する。

_関数_は、特定のタスクを実行する独立したコードの塊です。何をするものなのかを特定するために名前を与え、必要なときにタスクを実行するためにこの関数が「呼び出す」ときに名前は使われます。

Swift の統一された関数構文は、シンプルな C 言語スタイルのパラメータ名のない関数から、Objective-C スタイルの個々のパラメータに名前とラベルを付けた関数までを表現できる、十分な柔軟性を持っています。パラメータには、関数の呼び出しをシンプルにするためにデフォルト値を設定できたり、関数の実行が完了すると渡した変数を変更する in-out パラメータも渡すことができます。

全ての関数は、パラメータや戻り値の型で構成された自身の型を持っています。他の Swift の型と同じようにこの型を使用することができます。他の関数のパラメータに関数を渡したり、関数から関数を戻すことも簡単にできます。また、関数の中で関数を作成することで、独自のスコープを作成して機能をカプセル化することもできます。

関数の定義と呼び出し(Defining and Calling Functions)

関数を定義するとき、必要な場合に名前と型を持つ_パラメータ_と呼ばれる 1 つ以上のインプットを定義することができます。また、関数の完了後に呼び出し元に結果を戻す、_戻り値_と呼ばれるアウトプットの型も必要な場合に定義できます。

全ての関数は、実行するタスクを説明する、関数名_を持っています。関数を使用するには、その関数をその名前で_呼び出し、関数のパラメータの型に一致する(_引数_と呼ばれる)入力値を渡します。引数は、関数のパラメータのリストと常に同じ順序で与えなければなりません。

下記の例の関数は、greet(person:) という関数で、名前が示す通り、人の名前を入力値として受け取り、その人への挨拶を返します。この関数では、person という String 型のパラメータと、その人に対する挨拶を含めた String 型の戻り値を返します:

func greet(person: String) -> String {
    let greeting = "こんにちは、 " + person + "!"
    return greeting
}

この情報は全て、関数の_定義_にまとめられ、定義の前に func キーワードを付けます。関数の戻り値の型は、戻り矢印 ->(ハイフンの後に山括弧が続く) で示し、その後に返す型名が続きます。

定義は、関数が何をするか、何を受け取ることを期待するか、そしてそれが行われたときに何を返すかを説明します。こうすることで、コード内の他の場所から誤解を生むことなく関数を呼び出すことができます。

print(greet(person: "Anna"))
// こんにちは、 Anna!
print(greet(person: "Brian"))
// こんにちは、 Brian!

greet(person:) 関数を呼び出すには、greet(person: "Anna") のように、person 引数ラベルの後に String 型の値を渡します。この関数は String 型の値を返すため、上記のように、greet(person:) を print(_:separator:terminator:) 関数の呼び出しでラップして、その文字列を出力して戻り値を確認できます。

NOTE print(_:separator:terminator:) 関数には最初の引数にラベルがなく、他の引数にはデフォルト値があるため、引数を渡しても渡さなくても呼び出し可能です。関数の構文の種類に関してはFunction Argument Labels and Parameter Names(引数ラベルとパラメータ名)とDefault Parameter Values(デフォルトパラメータ値)に記載しています。

greet(person:) 関数の本文は、greeting と呼ばれる新しい String 型の定数を定義し、それにシンプルな挨拶文に設定することから始まります。このメッセージは、return キーワードを使用して関数から戻り値を返します。return greeting という行で、関数は実行を終了し、greeting の現在の値を返します。

本文を短くするために、挨拶の作成と return 文を 1 行にまとめることができます。

func greetAgain(person: String) -> String {
    return "もう一度こんにちは、 " + person + "!"
}
print(greetAgain(person: "Anna"))
// もう一度こんにちは、 Anna!

関数のパラメータと戻り値(Function Parameters and Return Values)

Swift では、関数のパラメータと戻り値は非常に柔軟です。名前のない単一のパラメータを持つシンプルなユーティリティ関数から、読みやすいように表現できるパラメータ名と様々なパラメータオプションを持つ複雑な関数まで、あらゆるものを定義できます。

パラメータなし関数(Functions Without Parameters)

入力パラメータは関数に必須ではありません。入力パラメータのない関数は次のとおりです。この関数は、呼び出される度に、常に同じ String 型のメッセージを返します:

func sayHelloWorld() -> String {
    return "hello, world"
}
print(sayHelloWorld())
// こんにちは、 world

関数は、パラメータを受け取りませんが、関数名の後に括弧が必要です。関数が呼び出されると、関数名の後に空の括弧のペア(())も書きます。

複数のパラメータがある関数(Functions With Multiple Parameters)

関数は、カンマ(,)区切りで複数のパラメータを持つことができます。

この関数は、人の名前と、その人がすでに挨拶されているかどうかを入力値として受け取り、その人に適切な挨拶を返します:

func greet(person: String, alreadyGreeted: Bool) -> String {
    if alreadyGreeted {
        return greetAgain(person: person)
    } else {
        return greet(person: person)
    }
}
print(greet(person: "Tim", alreadyGreeted: true))
// もう一度こんにちは、 Tim!

person というラベルの付いた String 型の値と、括弧(()) 内にカンマ(,)で区切られた alreadyGreeted というラベルの付いた Bool 型の値の両方を渡して great(person:alreadyGreeted:) 関数を呼び出しています。この関数は、 前のセクションで示した greet(person:) 関数とは異なることに注意してください。どちらも greet という関数名ですが、greet(person:alreadyGreeted:) は 2 つの引数を取り、greet(person:) 関数は 1 つしか取りません。

戻り値なし関数(Functions Without Return Values)

戻り値の型を定義することも必須ではありません。greet(person:) バージョンは String 型の値を返すのではなく、その値を出力します。

func greet(person: String) {
    print("こんにちは、 \(person)!")
}
greet(person: "Dave")
// こんにちは、 Dave!

値を返す必要がないため、関数の定義には戻り矢印(->)や戻り値の型は含まれていません。

NOTE 厳密に言えば、greet(person:) は、戻り値が定義されていなくても値を返してます。戻り値の型が定義されていない関数は、Void 型の特別な値を返します。これは単に () と書く空のタプルです。

関数の戻り値は、呼び出し元で無視できます:

func printAndCount(string: String) -> Int {
    print(string)
    return string.count
}
func printWithoutCounting(string: String) {
    let _ = printAndCount(string: string)
}
printAndCount(string: "hello, world")
// "hello, world" を出力し、 12 の値が返されます
printWithoutCounting(string: "hello, world")
// "hello, world" を出力しますが、値は返されません

最初の関数 printAndCount(string:) は文字列を出力し、その文字数を Int として返します。2 番目の関数 printWithoutCounting(string:) は、最初の関数を呼び出しますが、その戻り値を無視します。2 番目の関数が呼び出されても、メッセージは最初の関数によって出力されますが、戻り値は使われていません。

NOTE 戻り値は無視できますが、常に関数が値を返すことは示さなければなりません。戻り値の型が定義されている関数では、値を返さずに関数を使用することはできません。そうしようとすると、コンパイルエラーが発生します。

複数の戻り値がある関数(Functions with Multiple Return Values)

タプル型を関数の戻り値の型として使用して、1 つの複合戻り値として複数の値を返すことができます。

以下の例では、minMax(array:) という関数を定義しています。この関数は、Int 値の配列内の最小値と最大値を検索します。

func minMax(array: [Int]) -> (min: Int, max: Int) {
    var currentMin = array[0]
    var currentMax = array[0]
    for value in array[1..<array.count] {
        if value < currentMin {
            currentMin = value
        } else if value > currentMax {
            currentMax = value
        }
    }
    return (currentMin, currentMax)
}

minMax(array:) 関数は、2 つの Int 値を含むタプルを返します。これらの値には min と max のラベルが付いているため、関数の戻り値を使用するときにその名前でアクセスできます。

minMax(array:) 関数の本文は、currentMin および currentMax と呼ばれる 2 つの変数に、配列の最初の整数値を設定することから始まります。次に、この関数は配列内の残りの値を繰り返し処理し、各値をチェックして、それぞれ currentMin と currentMax の値よりも小さいか大きいかを確認します。最後に、全体の最小値と最大値が 2 つの Int 値のタプルとして返されます。

タプルのそれぞれの値は、関数の戻り値の型の一部として名前が付けられているため、ドット(.)構文でアクセスして、見つかった最小値と最大値を取得できます。

let bounds = minMax(array: [8, -6, 2, 109, 3, 71])
print("最小値は \(bounds.min) で最大値は \(bounds.max)")
// 最小値は -6 で最大値は 109

タプルの各値は、関数の戻り値の型で名前がすでに指定されているため、関数からタプルが返されるときに名前を付ける必要がないことに注目してください。

オプショナルのタプルの戻り値の型(Optional Tuple Return Types)

関数から返されるタプル型が、「値が存在しない」可能性がある場合は、オプショナルのタプル型を使用して、タプル全体が nil になる可能性があることを示すことができます。(Int, Int)? や (String, Int, Bool)? のように、タプル型の閉じ括弧())の後に疑問符(?)を配置して、オプショナルのタプル型を書きます。

NOTE (Int, Int)? などの オプショナルのタプル型は (Int?, Int?) などの オプショナルの型を含むタプルとは異なります。オプショナルの型を使用すると、タプル内の個々の値だけでなく、タプル全体が オプショナルになります。

上記の minMax(array:) 関数は、2 つの Int 値を含むタプルを返します。ただし、この関数は、渡された配列に対して安全性チェックを行なっていません。array 引数に空の配列が含まれている場合、上記で定義した minMax(array:) 関数は、array[0] にアクセスしようとしたときに実行時エラーが発生します。

空の配列を安全に処理するには、オプショナルのタプルの戻り値の型を指定して、配列が空の場合は nil を返します。

func minMax(array: [Int]) -> (min: Int, max: Int)? {
    if array.isEmpty { return nil }
    var currentMin = array[0]
    var currentMax = array[0]
    for value in array[1..<array.count] {
        if value < currentMin {
            currentMin = value
        } else if value > currentMax {
            currentMax = value
        }
    }
    return (currentMin, currentMax)
}

オプショナルバインディングを使用して、このバージョンの minMax(array:) 関数が、実際のタプル値を返すか nil を返すかを確認できます:

if let bounds = minMax(array: [8, -6, 2, 109, 3, 71]) {
    print("最小値は \(bounds.min) で最大値は \(bounds.max)")
}
// 最小値は -6 で最大値は 109

暗黙的な戻り値がある関数(Functions With an Implicit Return)

関数の本文全体が、単一式の場合は、関数は暗黙的にその式の結果を返します。例えば、下記の両方の関数の動作は同じです:

func greeting(for person: String) -> String {
    "Hello, " + person + "!"
}
print(greeting(for: "Dave"))
// Hello, Dave!

func anotherGreeting(for person: String) -> String {
    return "Hello, " + person + "!"
}
print(anotherGreeting(for: "Dave"))
// Hello, Dave!

greeting(for:) 関数の全体の定義は、戻り値の挨拶文です。つまり、この短い形式を使用できます。anotherGreeting(for:) 関数は、複数の式を持つ関数と同様に return キーワードを使用して、同じ挨拶文を返しています。1 つの戻り行として記述した関数は、return を省略できます。

Shorthand Getter Declaration(省略 get プロパティ宣言)でも説明されていますが、プロパティの get でも暗黙的な戻り値を使用することができます。

NOTE 暗黙の戻り値を使ったコードは、何かしらの値を返す必要があります。例えば、fatalError("Oh no!") または print(13) を暗黙の戻り値として使用することはできません。これは Swift が暗黙の戻り値がないことを知っているからです。

引数ラベルとパラメータ名(Function Argument Labels and Parameter Names)

各関数のパラメータには、引数ラベルとパラメータ名の両方持つことができます。引数ラベルは、関数を呼び出すときに使用されます。各引数は、その前に書かれた引数ラベルを使用して関数が呼び出されます。引数名は関数の内部で使用されます。デフォルトでは、パラメータ名を引数ラベルとして使用します。

func someFunction(firstParameterName: Int, secondParameterName: Int) {
    // 関数の本文では、`firstParameterName`と`secondParameterName`は
    // 最初と 2 番目のパラメータの値を参照します。
}
someFunction(firstParameterName: 1, secondParameterName: 2)

全てのパラメータには一意の名前を付ける必要があります。複数のパラメータに同じ引数ラベルを付けることはできますが、一意の引数ラベルを使用すると、コードが読みやすくなります。

引数ラベルの特定(Specifying Argument Labels)

引数名の前に、スペースで区切って引数ラベルを記述します。

func someFunction(argumentLabel parameterName: Int) {
    // 関数の本文では、`parameterName` でパラメータの値を参照します
}

これは、人の名前と出身地を受け取って挨拶を返す greet(person:) 関数の一種です:

func greet(person: String, from hometown: String) -> String {
    return "Hello \(person)!  Glad you could visit from \(hometown)."
}
print(greet(person: "Bill", from: "Cupertino"))
// Hello Bill!  Glad you could visit from Cupertino.

引数ラベルを使用すると、関数の本文に読みやすく明確な意図を持たせつつ、表現豊かな文章のように関数を呼び出すことができます。

引数ラベルの省略(Omitting Argument Labels)

引数ラベルが必要ない場合は、その引数ラベルの代わりにアンダースコア(_)を記述します。

func someFunction(_ firstParameterName: Int, secondParameterName: Int) {
    // 関数の本文では、`firstParameterName`と`secondParameterName`は
    // 最初と 2 番目のパラメータの値を参照します。
}
someFunction(1, secondParameterName: 2)

パラメータに引数ラベルがある場合、関数を呼び出すときに引数にラベルを付ける必要があります。

デフォルトパラメータ値(Default Parameter Values)

パラメータの型の後に値を代入することで、関数内の任意のパラメータの_デフォルト値_を定義できます。デフォルト値が定義されている場合は、関数を呼び出すときにそのパラメータを省略できます。

func someFunction(parameterWithoutDefault: Int, parameterWithDefault: Int = 12) {
    // 関数を呼び出すときに 2 番目のパラメータを省略した場合、
    // `parameterWithDefault` の値は 12 になります。
}
someFunction(parameterWithoutDefault: 3, parameterWithDefault: 6) // `parameterWithDefault` は 6
someFunction(parameterWithoutDefault: 4) // `parameterWithDefault` は 12

デフォルト値のないパラメータは、関数のパラメータリストでデフォルト値のあるパラメータよりも前に置きましょう。通常、デフォルト値を持たないパラメータの方が重要です。最初にデフォルト値を持たないパラメータを置くと、デフォルトパラメータが省略されているかどうかに関係なく、同じ関数が呼び出されていることを認識しやすくなります。

可変長パラメータ(Variadic Parameters)

_可変長パラメータ_は、指定された型の 0 個以上の値を受け入れます。可変長パラメータを使用すると、関数が呼び出されたときに、パラメータに様々な数の入力値を渡すことができます。パラメータの型名の後に 3 つのピリオド文字(...)を挿入して、可変長パラメータを記述します。

可変長パラメータに渡された値は、適切な型の配列として関数の本文内で使用できるようになります。例えば、numbers という Double... 型を持つ可変長パラメータは、numbers という [Double] 型の定数配列として関数の本文内で使用できます。

下記の例では、任意の長さの数値のリストの算術平均(いわゆる平均)を計算しています。

func arithmeticMean(_ numbers: Double...) -> Double {
    var total: Double = 0
    for number in numbers {
        total += number
    }
    return total / Double(numbers.count)
}
arithmeticMean(1, 2, 3, 4, 5)
// 5 つの数値の平均の 3.0 を返します
arithmeticMean(3, 8.25, 18.75)
// 3 つの数値の平均の 10.0 を返します

関数は複数の可変長パラメータを持つことができます。可変長パラメータの後に続く最初のパラメータには、引数ラベルが必要です。引数ラベルにより、どの引数が可変長パラメータに渡され、どの引数が可変長パラメータの後に続くパラメータに渡されているかが明確になります。

In-Out パラメータ(In-Out Parameters)

関数のパラメータはデフォルトで定数です。関数の本文からパラメータの値を変更しようとすると、コンパイルエラーが発生します。つまり、誤ってパラメータの値を変更することはできません。関数でパラメータの値を変更する必要があり、関数呼び出しが終了した後もそれらの変更を保持したい場合は、代わりに _in-out パラメータ_として定義します。

パラメータの型の直前に inout キーワードを配置することにより、in-out パラメータを書きます。in-out パラメータに渡された値は、関数に渡され、変更され、元の値を置き換えて、関数から戻ってきます。in-out パラメータの動作および関連するコンパイラの最適化の詳細については、In-Out Parameters(In-Out パラメータ)を参照ください。

in-out パラメータには、変数のみ渡すことができます。定数とリテラルは変更できないため、渡すことはできません。変数を in-out パラメータとして渡すときは、変数名の直前にアンパサンド(&)を付けて、関数で値が変更される可能性があることを示します。

NOTE in-out パラメータにデフォルト値を設定したり、可変長パラメータを inout としてマークすることはできません。

これは、swapTwoInts(_:_:) という関数の例です。この関数には、a と b という 2 つのパラメータがあります。

func swapTwoInts(_ a: inout Int, _ b: inout Int) {
    let temporaryA = a
    a = b
    b = temporaryA
}

swapTwoInts(_:_:) 関数は、b の値を a にスワップし、a の値を b にスワップします。この関数は、a の値を temporaryA と呼ばれる一時定数に格納し、b の値を a に代入してから、temporaryA を b に代入することによってこのスワップを実行します。

Int 型の 2 つの変数を指定して swapTwoInts(_:_:) 関数を呼び出し、それらの値を交換できます。someInt と anotherInt には、swapTwoInts(_:_:) 関数に渡されるときに、アンパサンド(&)が前に付いていることに注目してください。

var someInt = 3
var anotherInt = 107
swapTwoInts(&someInt, &anotherInt)
print("someInt は現在 \(someInt) で、anotherInt は現在 \(anotherInt)")
// someInt は現在 107 で、anotherInt は現在 3

上記の例は、someInt と anotherInt の元の値が、関数の外部で定義されていたとしても、swapTwoInts(_:_:) 関数によって変更されることを示しています。

NOTE in-out パラメータは、関数から値を返すことと同じではありません。上記の swapTwoInts の例では、戻り値の型を定義して値を返していませんが、someInt と anotherInt の値を変更しています。in-out パラメータは、関数が本文の範囲外に影響を与える代替方法です。

関数型(Function Types)

全ての関数には特定の_関数型_があり、パラメータの型と戻り値の型で構成されています。

例えば:

func addTwoInts(_ a: Int, _ b: Int) -> Int {
    return a + b
}
func multiplyTwoInts(_ a: Int, _ b: Int) -> Int {
    return a * b
}

この例では、addTwoInts および multiplyTwoInts と呼ばれる 2 つのシンプルな数学関数を定義します。これらの関数はそれぞれ 2 つの Int 値を取り、適切な数学演算を実行した結果の Int 値を返します。

これらの関数の両方の型は、(Int, Int) -> Int です。これは次のように読むことができます:

「両方とも Int 型の 2 つの値を受け取り、Int 型の値を返す関数です」

パラメータや戻り値のない関数の例を次に示します。

func printHelloWorld() {
    print("hello, world")
}

この関数の型は、() -> Void で「パラメータを持たず、Void を返す関数」です。

関数型の使用(Using Function Types)

Swift の他の型と同じように関数型を使用します。例えば、定数または変数を関数型として定義し、その変数に適切な関数を代入することができます:

var mathFunction: (Int, Int) -> Int = addTwoInts

これは次のように読むことができます:

「2 つの Int 値を取り、Int 値を返す関数の型を持つ mathFunction という変数を定義します。この新しい変数が、addTwoInts という関数を参照するように設定します」

addTwoInts(_:_:) 関数は mathFunction 変数と同じ型のため、この代入は Swift の型チェックを通ります。

代入した関数を mathFunction という名前で呼び出すことができます。

mathFunction = multiplyTwoInts
print("結果: \(mathFunction(2, 3))")
// 結果: 6

他の型と同様に、定数または変数に関数を代入するときに、関数型を推論することができます。

let anotherMathFunction = addTwoInts
// anotherMathFunction は (Int, Int) -> Int と推論されます

パラメータの型としての関数型(Function Types as Parameter Types)

(Int, Int) -> Int などの関数型を別の関数のパラメータの型として使用できます。これにより、関数の呼び出し元で関数の一部の機能を決めることができます。

下記は、上記の数学関数の結果を出力する例です:

func printMathResult(_ mathFunction: (Int, Int) -> Int, _ a: Int, _ b: Int) {
    print("結果: \(mathFunction(a, b))")
}
printMathResult(addTwoInts, 3, 5)
// 結果: 8

この例では、3 つのパラメータを持つ printMathResult(_:_:_:) という関数を定義します。最初のパラメータは mathFunction と呼ばれ、(Int, Int) -> Int 型です。この最初のパラメータとして、その型の任意の関数を渡すことができます。2 番目と 3 番目のパラメータは a と b と呼ばれ、どちらも Int 型です。これらは、提供されている数学関数の 2 つの入力値として使用されています。

printMathResult(_:_:_:) が呼び出されると、addTwoInts(_:_:) 関数、および整数値 3 と 5 が渡されます。与えられた関数を値 3 と 5 で呼び出し、次の結果 8 を出力します。

printMathResult(_:_:_:) の役割は、適切な型の数学関数の結果を出力することです。その関数が実際に何をするかは重要ではありません。関数が正しい型なことが重要です。これにより、printMathResult(_:_:_:) は、その機能の一部を関数の呼び出し元に型安全な方法で渡すことができます。

戻り値の型としての関数型(Function Types as Return Types)

関数型を別の関数の戻り値の型として使用できます。これを行うには、関数の戻り矢印(->)の直後に完全な関数型を書きます。

次の例では、stepForward(_:) と stepBackward(_:) という 2 つのシンプルな関数を定義します。stepForward(_:) 関数は、入力値より 1 つ大きい値を返し、stepBackward(_:) 関数は、入力値より 1 つ小さい値を返します。両方の関数の型は (Int) -> Int です:

func stepForward(_ input: Int) -> Int {
    return input + 1
}
func stepBackward(_ input: Int) -> Int {
    return input - 1
}

以下が chooseStepFunction(backward:) という関数で、その戻り値の型は (Int) -> Int です。chooseStepFunction(backward:) 関数は、backward と呼ばれるブール値に基づいて stepForward(_:) または stepBackward(_:) を返します:

func chooseStepFunction(backward: Bool) -> (Int) -> Int {
    return backward ? stepBackward : stepForward

これで chooseStepFunction(backward:) を使って、どちらかの方向にステップする関数を得ることができるようになりました:

var currentValue = 3
let moveNearerToZero = chooseStepFunction(backward: currentValue > 0)
// moveNearerToZero は stepBackward() 関数を参照しています

上記の例では、currentValue という変数を徐々にゼロに近づけるために正または負のステップが必要かどうかを判断します。currentValue の初期値は 3 です。これは、currentValue > 0 が true を返し、chooseStepFunction(backward:) が stepBackward(_:) 関数を返すことを意味します。返された関数への参照は、moveNearerToZero という定数に格納されます。

moveNearerToZero が適切な関数を参照しているので、ゼロまでカウントできます:

print("0 までカウントします:")
// 0 までカウントします:
while currentValue != 0 {
    print("\(currentValue)... ")
    currentValue = moveNearerToZero(currentValue)
}
print("0!")
// 3...
// 2...
// 1...
// 0!

ネスト関数(Nested Functions)

この章でこれまでに見てきた全ての関数は、グローバルスコープで定義されたグローバル関数の例でしたが、_ネスト関数_と呼ばれる、他の関数の本文内に関数を定義することもできます。

ネスト関数は、デフォルトでは外から見えませんが、それを囲む関数から呼び出して使用することができます。囲んでいる関数が、ネスト関数内の 1 つを戻り値として、ネスト関数を別のスコープで使用することもできます。

上記の chooseStepFunction(backward:) の例を書き直して、ネスト関数を使用することができます。

func chooseStepFunction(backward: Bool) -> (Int) -> Int {
    func stepForward(input: Int) -> Int { return input + 1 }
    func stepBackward(input: Int) -> Int { return input - 1 }
    return backward ? stepBackward : stepForward
}
var currentValue = -4
let moveNearerToZero = chooseStepFunction(backward: currentValue > 0)
// moveNearerToZero は ネスト関数の stepForward() を参照しています
while currentValue != 0 {
    print("\(currentValue)... ")
    currentValue = moveNearerToZero(currentValue)
}
print("0!")
// -4...
// -3...
// -2...
// -1...
// 0!