Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【Ruby3.x】Array::flatten()メソッドの使い方

flattenメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

flattenメソッドは、Arrayクラスに属し、ネストされた配列(配列の中に別の配列が含まれている状態)を平坦化する、つまり全ての要素を単一の配列にまとめる操作を実行するメソッドです。

このメソッドを呼び出すと、元の配列の構造が変更されることなく、新しい配列が生成されて返されます。新しい配列には、元の配列内の全ての要素が、階層構造が取り除かれた状態で格納されます。

オプションとして、整数値の引数 level を指定することもできます。level を指定した場合、その指定された深さのレベルまでのみ配列のネストを解除します。例えば、flatten(1) と指定すると、最上位の配列直下にある配列のみが平坦化され、それより深いネストはそのまま残ります。引数を省略した場合や、levelnil または負の値を指定した場合は、全てのネストが完全に解除され、完全に平坦な配列が得られます。

flatten メソッドは、複数の配列が入れ子になっているデータを一つのリストとして扱いたい場合や、階層的な構造を持つデータを処理する際に非常に役立ちます。例えば、[1, [2, 3], [4, [5]]] のような配列に対して flatten を適用すると、[1, 2, 3, 4, 5] という結果が得られます。

構文(syntax)

1[1, [2, 3], 4].flatten

引数(parameters)

level = nil

  • level = nil: 配列を平坦化する深さを指定します。nil の場合は、ネストがすべて解除されます。

戻り値(return)

Array

ネストされた配列を平坦化し、要素をすべて1つの配列にまとめた新しい配列を返します。

関連コンテンツ

関連プログラミング言語