【Ruby3.x】Array::unshift()メソッドの使い方
unshiftメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
unshiftメソッドは、RubyのArrayクラスに属し、配列の先頭に一つ以上の要素を追加するメソッドです。
このメソッドの大きな特徴は、呼び出し元の配列そのものを変更する「破壊的な操作」である点です。つまり、新しい配列を作成して返すのではなく、既存の配列に対して直接要素を追加し、その変更された配列自身を返します。
unshiftメソッドを使用する際は、追加したい要素を引数として渡します。もし複数の要素を一度に追加したい場合は、カンマで区切って複数の引数を指定できます。その場合、引数として指定された順序で、配列の先頭から要素が追加されます。
例えば、[1, 2, 3]という配列に対してunshift(0)を実行すると、配列は[0, 1, 2, 3]に変わります。また、unshift(-2, -1)を実行すると、配列は[-2, -1, 1, 2, 3]となります。
このメソッドは、リストの先頭に新しい項目を追加したい場合や、時系列データを新しいものから順に配列の先頭に追加していきたい場合などに非常に役立ちます。変更された配列自身が戻り値として返されるため、続けてその配列に対して他のメソッドを呼び出すことも可能です。
構文(syntax)
1[3, 4].unshift(1, 2)
引数(parameters)
*objects
- objects: 配列の先頭に追加したいオブジェクトを複数指定します
戻り値(return)
Array
配列の先頭に指定した要素を追加した結果の配列が返されます。