PHPのarray_sum関数は、配列に含まれるすべての数値要素の合計値を計算するために使用されます。
売上データの合計、点数の総計、数値リストの合計など、配列内の数値情報を集計する際に便利です。
foreachループで同じ処理を書くよりも短く、直感的に記述できます。
この記事では、array_sum 関数の基本的な使い方、引数、戻り値、非数値要素や空の配列に対する挙動、そして使用する際の注意点について解説します。
array_sum関数の基本的な構文
array_sum 関数の基本的な構文は以下の通りです。
int|float array_sum(array $array)
$array: 合計値を計算したい数値要素を含む配列です。
array_sum関数の戻り値
配列内のすべての要素を合計した結果の数値（int または float）が返されます。
array_sum関数を使ってみる
実際にarray_sum関数を使って、動作を確認してみます。
例1：基本的な数値配列の合計
数値配列の合計値を求めてみます。
<?php
$numbers = [10, 20, 30, 40, 50];
$total = array_sum($numbers);
echo "配列の合計: " . $total . PHP_EOL; // 出力: 配列の合計: 150
?>
$numbers配列は数値のみを並べた配列です。
その次の処理で、$numbers配列をarray_sum関数に渡しています。
これで$numbers配列の合計値が計算され、返り値として、$totalに返ってきます。
出力すると、合計されていることが確認できました。
例2：浮動小数点数を含む配列の合計
浮動小数点数（小数）を含む配列の合計を計算する場合も、同じようにarray_sum関数を使用できます。
<?php
$prices = [12.50, 8.75, 20.00, 5.25];
$totalPrice = array_sum($prices);
echo "合計金額: " . $totalPrice . PHP_EOL; // 出力: 合計金額: 46.5
?>
$prices配列は商品の価格など、小数が含まれる数値の配列です。
array_sum関数にこの配列を渡すと、すべての小数を正確に加算し、合計値として$totalPriceに返します。
計算結果が浮動小数点数になる場合にも、適切に処理されていることが確認できました。
例3：負の数を含む配列の合計
負の数が含まれている配列でも、array_sum関数は正しく合計を計算します。
利益と損失の合計を求める際などに役立ちます。
<?php
$gainsLosses = [100, -20, 50, -80];
$netChange = array_sum($gainsLosses);
echo "増減: " . $netChange . PHP_EOL; // 出力: 増減: 50
?>
$gainsLosses配列に正の数と負の数が混在しています。
array_sum関数は、すべての要素を順番に加算していきます。
100に-20を足し、50を足し、最後に-80を足すことで、最終的な増減の合計値「50」を$netChangeに返します。
数値要素ではない場合や空の配列のとき
数値要素じゃないときや空配列の場合についてです。
数値要素ではないとき
array_sum は、配列内の非数値要素を「0」として扱います。
これは、数値計算において予期しない結果を生む可能性があるため、注意が必要です。
<?php
$mixedArray = [10, 'text', 20, true, '50']; // 'text' は 0, true は 1, '50' は 50 として扱われる
$sum = array_sum($mixedArray);
echo "混合配列の合計: " . $sum . PHP_EOL; // 出力: 混合配列の合計: 81 (10 + 0 + 20 + 1 + 50 = 81)
?>
このように、「text」は「0」に、「true」は「1」に、数値文字列「'50'」は「50」に自動的に変換されて計算されます。
数値要素以外が含まれる可能性がある場合は、事前にフィルタリングするなどの処理が必要です。
空の配列のとき
空の配列を array_sum に渡すと、「0」が返されます。
これは、合計の単位元が「0」であるため、数学的に妥当な挙動です。
<?php
$emptyArray = [];
$total = array_sum($emptyArray);
echo "空の配列の合計: " . $total . PHP_EOL; // 出力: 空の配列の合計: 0
?>
array_sum関数を使う際の注意点
array_sum関数を使う際の注意点です。
数値要素ではないときの自動変換
配列に文字列などの非数値要素が含まれている場合、それらは数値に変換されます。
意図しない変換を防ぐために、合計する前に is_numericやarray_filterを使って数値要素のみを抽出することを検討してください。
浮動小数点数の精度
浮動小数点数の合計を計算する場合、浮動小数点演算の特性上、結果に微細な誤差が生じる可能性があります。
厳密な計算が必要な場合は、BC Math関数（bcaddなど）の使用を検討してください。
非常に大きな数の場合
非常に大きな数の合計を計算すると、PHPの数値型の最大値を超えてしまう可能性があります。（整数型の場合はオーバーフロー、浮動小数点型の場合は精度が失われる）
そのような場合も、BC Math関数が役立ちます。
多次元配列には直接適用できない
array_sumは一次元配列の要素のみを合計します。
多次元配列の合計を計算したい場合は、array_mapとarray_sumを組み合わせるか、ループで処理する必要があります。
<?php
$data = [
['score' => 10],
['score' => 20],
['score' => 30]
];
// 各サブ配列から 'score' の値だけを抽出し、合計する
$scores = array_map(function($item) {
return $item['score'];
}, $data);
$totalScore = array_sum($scores);
echo "多次元配列のスコア合計: " . $totalScore . PHP_EOL; // 出力: 60
?>
まとめ
PHPの array_sum 関数は、配列内のすべての数値要素を効率的に合計するための簡潔なツールです。
合計値の計算、点数の総計など、様々な集計操作を簡単に行うことができます。
数値要素以外は自動変換される点や、空の配列が「0」を返す点に注意しましょう。
必要に応じて事前に配列のフィルタリングや、より高精度な数学関数（BC Math）の使用を検討して、array_sum関数を効果的に活用しましょう。
コメント