【C#】（値型と参照型の）値渡しと参照渡し -引数を渡す

Qiita Advent Calendar 2回目の参加です。よろしくお願いします。
C#を習得するときかなり大コケをした「値渡しと参照渡し」について振り返り、まとめました。

## 値型の値と参照・参照型の値と参照　
以下、全ての画像はイメージです。アドレスやメモリの配置などはそれっぽいものとして受け取ってください。
**＜値型＞ <font color="MediumOrchid">値＝「1」</font><font color="Orange">参照＝「0x2742」</font>**
値型の値は「1 や 10 などの実体（インスタンス）」です。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/566811/71cbdfaa-339a-b8ef-8e67-f26356ce9c87.png)
**＜参照型＞ <font color="MediumOrchid">値＝「0x2904」</font><font color="Orange">参照＝「0x2742」</font>**
参照型の値は「1 や 10 などの実体（インスタンス）」ではなく参照先にある実体の「アドレス」を持っています。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/566811/e15a14b8-b3ec-2c88-c74c-aaf2ac2069dc.png)
この他にポインターという型が存在しますが、今回は扱いません。▶ ​[アンセーフ コード、ポインター型、関数ポインター](https://docs.microsoft.com/ja-jp/dotnet/csharp/language-reference/unsafe-code)

## 値渡しと参照渡しについて
「値渡し」「参照渡し」渡し方は2種類あります。ですが、C#には型の種類が2つあるため組み合わせとしては2×2=4パターンとなります。**<font color="DeepPink">値型を渡すことが値渡し、参照型を渡すことが参照渡し、と呼ばない点が大きなポイントです。C#では参照型と参照渡しの概念は別物です。</font>**

 - **値型の<font color="MediumOrchid">値渡し</font>**
 - **参照型の<font color="MediumOrchid">値渡し</font>**
 - **値型の<font color="Orange">参照渡し</font>**
 - **参照型の<font color="Orange">参照渡し</font>**

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/566811/e238c7b4-a90d-19bb-f625-9c9841d4ef59.png)

## 値渡しと参照渡しの違い
名前の通り、<font color="MediumOrchid">**値**</font>を渡すのが<font color="MediumOrchid">**「値渡し」**</font>、<font color="Orange">**参照**</font>を渡すのが<font color="Orange">**「参照渡し」**</font>です。先程の画像を例に挙げます。
値型 `paramValue` は<font color="MediumOrchid">**値渡しだと「10」**</font><font color="Orange">**参照渡しだと「0x2742」**</font>を渡します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/566811/71cbdfaa-339a-b8ef-8e67-f26356ce9c87.png)

参照型 `paramRef` は<font color="MediumOrchid">**値渡しだと「0x2904」**</font><font color="Orange">**参照渡しだと「0x2742」**</font>を渡します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/566811/e15a14b8-b3ec-2c88-c74c-aaf2ac2069dc.png)

## 参照渡しで出来ること
 - 参照渡しで引数を渡す
 - 参照戻り値
 - ref ローカル変数
 - ref readonly
 - ref 条件式　などなど…
 
出来ることは色々ありますが<font color="DarkGray">（説明できるかどうか自信がないので）</font>今回は **参照渡しで引数を渡す** をピックアップします。

## 参照渡しのキーワード
C#で参照渡しを使用する際は、以下のキーワードを使用します。
### 1. ref
```C#:
        private void ReferenceTypes_PassByReference_ref(ref int[] param)
        {
            param = new int[] { 1000, 2000, 3000 };
        }

        public void Call()
        {
            // 変数の初期化をしないとエラー
            var paramRef2 = new int[] { 1, 2, 3 };
            ReferenceTypes_PassByReference_ref(ref paramRef2);
        }
```

- 呼び出し時に `ref` キーワードが必須
- メソッド内で書き換え可能（必須ではない）
- 変数の初期化必須

### 2. in　
```C#:
        private void ReferenceTypes_PassByReference_in(in int[] param)
        {
            // メソッド内で代入をするとエラーになる　書き換え不可
            // param = new int[] { 1000, 2000, 3000 };
        }

        public void Call()
        {
            // 変数の初期化をしないとエラー
            var paramRef = new int[] { 1, 2, 3 };
            ReferenceTypes_PassByReference_in(paramRef);
        }
```

- 呼び出し時に `in` キーワードは不要（ `in` を付けて呼び出してもエラーではない）
- メソッド内で書き換え不可（読み取り専用）
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/566811/5741cf20-cde7-7dd6-5564-64794076998b.png)
- 変数の初期化必須

### 3. out
```C#:
        private void ReferenceTypes_PassByReference_out(out int[] param)
        {
            // メソッド内で代入をしなければエラーになる 書き換え必須
            param = new int[] { 1000, 2000, 3000 };
        }

        public void Call()
        {
            // 変数の初期化をしなくてもエラーが出ない
            int[] paramRef;
            ReferenceTypes_PassByReference_out(out paramRef);
        }
```
- 呼び出し時に `out` キーワードが必須
- メソッド内での書き換え必須
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/566811/4249dcde-458d-82ac-8b94-e94baf7220ba.png)
- 変数の初期化をしなくてもよい（必須ではない）

## 値渡し/参照渡しで引数を渡す
**<font color="DeepPink">この記事内で「書き換え」という言葉を使用しますが、これは参照自体の値を変更することを指します。</font>**
**値型でいえば `param = 10;` 参照型でいえば `param = new int[] { 1000, 2000, 3000 };` などのコードが該当します。**
` param[1] = 10;` や ` param.Name = "AAA";` など、参照先のオブジェクトに属するデータを変更するコード（配列の要素を変更、クラスのメンバーを変更）は該当しません。要素やメンバーを変更すると、参照渡しでなくとも変更は反映されるからです。
参考： [参照型パラメーターの引き渡し (C# プログラミング ガイド)](https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/classes-and-structs/passing-reference-type-parameters) より
>参照型の変数には、そのデータが直接入っているのではなく、そのデータへの参照が含まれています。値（渡し）で参照型パラメーターを渡す場合、クラスメンバの値など参照先のオブジェクトに属するデータを変更することができます。ただし、参照自体の値を変更することはできません。参照自体の値を変更する場合は ref または out キーワードを使用してパラメーターを渡します。

**<font color="DeepPink">前述の通り `ref` `in` `out` どのキーワードでも「参照渡し」はできますが、「参照渡し＋書き換える」ことが可能なのは `ref` と `out` です。</font>**
以下の表は値渡しで書き換えた場合と、参照渡し（`ref` または `out`）で書き換えた場合の比較表です。

|  | 「値渡し」で書き換え| 「参照渡し（ref/out）」で書き換え |
|:-------:|:---------------------:|:---------------------:|
| 値型    | 呼び出し元の引数（実引数）に変更が反映されない | 呼び出し元の引数（実引数）に**変更が反映される** |
| 参照型  | 呼び出し元の引数（実引数）に変更が反映されない | 呼び出し元の引数（実引数）に**変更が反映される** |

### 引数を渡して書き換える①　値型の値渡し・値型の参照渡し
サンプルコードでは `ref` を使用します。

```C#:値型の値渡し・参照渡し
        private void ValueTypes_PassByValue(int param)
        {
            param = 1000;
        }

        private void ValueTypes_PassByReference_ref(ref int param)
        {
            param = 1000;
        }

        public void Call()
        {
            // 値型の値渡し
            var paramValue = 1;
            Console.WriteLine($"呼び出し前 {paramValue}"); // 呼び出し前 1

            ValueTypes_PassByValue(paramValue);
            Console.WriteLine($"呼び出し後 {paramValue}"); // 呼び出し後 1

            // 値型の値渡し
            var paramValue2 = 1;
            Console.WriteLine($"呼び出し前 {paramValue2}"); // 呼び出し前 1

            ValueTypes_PassByReference_ref(ref paramValue2);
            Console.WriteLine($"呼び出し後 {paramValue2}"); // 呼び出し後 1000
        }
```
参照渡しは仮引数の `param` に実引数である `paramValue2` の参照が渡されるため、その先にある実体に書き換えの結果が反映されます。＝呼び出し元に書き換え結果が反映されます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/566811/fa6acc43-837d-37a6-dc8f-05ceb9dacdf2.png)

### 引数を渡して書き換える②　参照型の値渡し・参照型の参照渡し
サンプルコードでは `ref` を使用します。

```C#:参照型の値渡し・参照渡し
        private void ReferenceTypes_PassByValue(int[] param)
        {
            param = new int[] { 1000, 2000, 3000 };
        }

        private void ReferenceTypes_PassByReference_ref(ref int[] param)
        {
            param = new int[] { 1000, 2000, 3000 };
        }

        public void Call()
        {
            // 参照型の値渡し
            var paramRef = new int[] { 1, 2, 3 };
            Console.WriteLine($"呼び出し前 {string.Join(", ", paramRef)}"); // 呼び出し前 1, 2, 3

            ReferenceTypes_PassByValue(paramRef);
            Console.WriteLine($"呼び出し後 {string.Join(", ", paramRef)}"); // 呼び出し後 1, 2, 3
            
            // 参照型の参照渡し
            var paramRef2 = new int[] { 1, 2, 3 };
            Console.WriteLine($"呼び出し前 {string.Join(", ", paramRef2)}"); // 呼び出し前 1, 2, 3

            ReferenceTypes_PassByReference_ref(ref paramRef2);
            Console.WriteLine($"呼び出し後 {string.Join(", ", paramRef2)}"); // 呼び出し後 1000, 2000, 3000
        }

```
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/566811/14322d42-34cb-356d-6196-f91f4011e331.png)
参照型の参照渡しも同じく仮引数の `param` に実引数である `paramRef2` の参照が渡されるため、その先にある実体を書き換えていることになります。そのため、呼び出し元に書き換え結果が反映されます。参照型の参照渡しは実体がヒープに存在するため複雑に見えますが、値型の参照渡しと動作は同じです。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/566811/77cb97cb-7da0-35bf-b2f5-00ed96968e2f.png)

## おまけ　参照型で値渡しをしたはずなのに、引数が変更されてしまった？
<font color="DarkGray">それは、参照型であるクラスのメンバーを変更しているからなのでは……？</font>

値渡しも参照渡しもバッチリ🎶と思い込んでいたとき、値渡しでクラスのメンバーを変更するコードを書いたのですが「どうして引数に変更が反映されているんだろう？？」と混乱しました。なぜか参照型の特徴を無視して「値渡しなら呼び出し元の引数は絶対に変わらない」と思い込んでいたようです。
 [参照型パラメーターの引き渡し (C# プログラミング ガイド)](https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/classes-and-structs/passing-reference-type-parameters) に<font color="DeepPink">**「参照型の変数には、そのデータが直接入っているのではなく、そのデータへの参照が含まれています。値（渡し）で参照型パラメーターを渡す場合、クラスメンバの値など参照先のオブジェクトに属するデータを変更することができます」**</font>と、書いてあります。その通りです。

```C#:
class SampleClass
{
    public string Name { get; set; } = "STAR";
    public string[] Names { get; set; } = new string[] { "A", "B", "C" };
}

class MemberChangeClass
{
    public void Call()
    {
        var sample = new SampleClass();
        Console.WriteLine($"呼出前　{sample.Name} {sample.Names[1]}"); // 呼出前　STAR B
        Sample(sample);
        Console.WriteLine($"呼出後　{sample.Name} {sample.Names[1]}"); // 呼出後　MOON BBB
    }

    private void MemberChange(Sample sample)
    {
        // 値渡しでもメンバーの書き換えは反映される
        sample.Name = "MOON";
        sample.Names[1] = "BBB";
    }
}
```
## まとめ
 - **渡し方**　
 C#では値型も参照型も明示的に指定しなければ値渡し。逆に言えば、値型も参照型も明示的に指定すれば参照渡し。

 - **参照渡しで出来ること**
 引数を渡す（メソッド内で書き換え可能なのは `ref` `out`）、戻り値を返す、ローカル引数を設定する、など。

 - **参照渡しのキーワード**　
  `ref` `in` `out` というキーワードがある。どれも参照渡しが可能だがそれぞれ制約がある。

 - **メソッドに引数を渡して書き換えたときの違い**
 値渡しをすると呼び出し元の引数（実引数）に変更が反映されない。参照渡しをすると呼び出し元の引数（実引数）に変更が反映される。メソッドの仮引数に「値」が渡されているのか、それとも「参照」が渡されているのか、という違いがあるため。

記事内で使用したサンプルコードはこちら▶ [CsharpRefSample](https://github.com/184ym2/prince/tree/master/CsharpRefSample)

## 参考URL
- [値の受け渡し ++C++; // 未確認飛行 C ](https://ufcpp.net/study/csharp/sp_ref.html#pass-by)
- [参照渡しの引数 ++C++; // 未確認飛行 C ](https://ufcpp.net/study/csharp/sp_ref.html#sec-byref-param)
- [参照戻り値と参照ローカル変数 ++C++; // 未確認飛行 C ](https://ufcpp.net/study/csharp/sp_ref.html?p=2#ref-returns)
- [値型の参照渡し ++C++; // 未確認飛行 C ](https://ufcpp.net/study/csharp/sp_ref.html?p=3#value-type)
- [C#でわかる値渡し、参照渡し](https://qiita.com/KageShiron/items/b74d9246aad3ca0854c2)
- [C# out と ref](https://qiita.com/muro/items/f88b17b5fea3b4537ba7)
- [ref (C# リファレンス)](https://docs.microsoft.com/ja-jp/dotnet/csharp/language-reference/keywords/ref)
- [ref (C# リファレンス) - 参照渡しで引数を渡す](https://docs.microsoft.com/ja-jp/dotnet/csharp/language-reference/keywords/ref#passing-an-argument-by-reference)
- [ref (C# リファレンス) - 参照戻り値](https://docs.microsoft.com/ja-jp/dotnet/csharp/language-reference/keywords/ref#reference-return-values)
- [in パラメーター修飾子 (C# リファレンス)](https://docs.microsoft.com/ja-jp/dotnet/csharp/language-reference/keywords/in-parameter-modifier)
- [out パラメーター修飾子 (C# リファレンス)](https://docs.microsoft.com/ja-jp/dotnet/csharp/language-reference/keywords/out-parameter-modifier)

最後まで見ていただきありがとうございました。