【Ruby】配列の先頭の要素を取得できるArray.firstメソッドについて解説します

こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在4社経験している、12年目エンジニアです。

この記事では、 Rubyで配列の先頭の要素を取得できるArray.firstメソッドについて

Array.firstメソッドとは
Array.firstメソッドを使うときの注意点
Array.firstメソッドを使ったサンプルプログラム

と、この記事で丁寧に解説していきます。

前提条件：実行環境について
Array.firstメソッドとは
1. パターン1：引数がない場合
2. パターン2：引数がある場合
Array.firstメソッドを使うときの注意点
Array.firstメソッドを解説するプログラムの概要
Rubyサンプルプログラム
実行結果
まとめ：Array.firstメソッドを使ってみよう！

前提条件：実行環境について

実行環境は以下の通りです。

OS	Windows10
Rubyのバージョン	2.6.6

Rubyのインストールは、下の記事をご参考ください。

【Ruby】OSがWindows10の場合のダウンロードするやり方を解説します

Array.firstメソッドとは

Array.firstメソッドとは、呼び出している配列の先頭の要素を取得して返すメソッドです。

Array.firstメソッドは使い方が

パターン1：引数がない場合
パターン2：引数がある場合

の合計2パターンあります。
それぞれ解説します。

パターン1：引数がない場合

引数がない場合、配列の最初の要素1つだけを返します。

使い方サンプルは以下です。

sample = [1, 2, 3]
result = sample.first

1 2	sample = [1, 2, 3] result = sample.first

変数resultには最初の要素の

1

が返されます。

もし呼び出している配列が空だった場合、nilを返します。

パターン2：引数がある場合

引数がある場合、先頭から引数の数分の要素を配列で返します。

使い方サンプルは以下です。

sample = [1, 2, 3]
result = sample.first(2)

1 2	sample = [1, 2, 3] result = sample.first(2)

変数resultには

[1, 2]

[1, 2]

という配列が返されます。

引数に指定した数が呼び出している配列の要素数より多い場合は、エラーとならず呼び出している配列がそのまま返されます。

Array.firstメソッドを使うときの注意点

引数を指定するパターン限定でArray.firstを使うときの注意点として、引数は0以上である必要があります。
たとえば

sample = [1, 2, 3]
result = sample.first(-3)

1 2	sample = [1, 2, 3] result = sample.first(-3)

と負の値を指定して実行した場合
Rubyのfirstメソッドを解説

Traceback (most recent call last):
        1: from arrayfirstsample.rb:2:in `<main>'
arrayfirstsample.rb:2:in `first': negative array size (ArgumentError)

Traceback (most recent call last):

1: from arrayfirstsample.rb:2:in `<main>'

arrayfirstsample.rb:2:in `first': negative array size (ArgumentError)

とエラーとなるので、ご注意ください。

では、次の章で実際に使ってみます。

Array.firstメソッドを解説するプログラムの概要

Array.firstメソッドを解説するプログラムでは、

数値の配列
文字列の配列
空の配列

の3種類の配列を用意します。
その配列に対して

パターン1：引数がない場合
パターン2：引数がある場合

の2パターンでArray.firstメソッドを実行し、結果を表示させます。

Rubyサンプルプログラム

puts "■firstメソッドサンプル"

# 確認する配列
numarray = [9, 8, 0, -6, 5]
engarray = ['MAP', 'EOL', 'ZIP', 'ABC']
emparray = []

puts "・確認する配列"
puts "#{numarray}"
puts "#{engarray}"
puts "#{emparray}"

puts "・パターン1：引数がない場合"
puts "#{numarray.first}"
puts "#{engarray.first}"
puts "#{emparray.first}"
puts

puts "・パターン2：引数がある場合"
puts "#{numarray.first(3)}"
puts "#{engarray.first(10)}"
puts "#{emparray.first(3)}"

puts "■firstメソッドサンプル"

# 確認する配列

numarray = [9, 8, 0, -6, 5]

engarray = ['MAP', 'EOL', 'ZIP', 'ABC']

emparray = []

puts "・確認する配列"

puts "#{numarray}"

puts "#{engarray}"

puts "#{emparray}"

puts "・パターン1：引数がない場合"

puts "#{numarray.first}"

puts "#{engarray.first}"

puts "#{emparray.first}"

puts

puts "・パターン2：引数がある場合"

puts "#{numarray.first(3)}"

puts "#{engarray.first(10)}"

puts "#{emparray.first(3)}"

実行結果

Rubyプログラムを実行するやり方は、以下の記事をご参考ください。

【Ruby】プログラムを実行するやり方を解説します

Rubyのfirstメソッドを解説

■firstメソッドサンプル
・確認する配列
[9, 8, 0, -6, 5]
["MAP", "EOL", "ZIP", "ABC"]
[]
・パターン1：引数がない場合
9
MAP


・パターン2：引数がある場合
[9, 8, 0]
["MAP", "EOL", "ZIP", "ABC"]
[]

■firstメソッドサンプル

・確認する配列

[9, 8, 0, -6, 5]

["MAP", "EOL", "ZIP", "ABC"]

[]

・パターン1：引数がない場合

MAP

・パターン2：引数がある場合

[9, 8, 0]

["MAP", "EOL", "ZIP", "ABC"]

[]

指定した条件の通り、配列の先頭の要素が抽出できていることが確認できました！

まとめ：Array.firstメソッドを使ってみよう！

以上がArray.firstメソッドについての解説でした！

あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ