【PHP8.x】NEGATIVE_SIGN定数の使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定された数値から負の符号を取り除き、絶対値を返します。
7 *
8 * 例:
9 *   -10 を渡すと 10 を返します。
10 *   5 を渡すと 5 を返します。
11 *   0 を渡すと 0 を返します。
12 *
13 * @param int|float $number 負の符号を取り除きたい数値。
14 * @return int|float 引数 `$number` の絶対値。
15 */
16function removeNegativeSign(int|float $number): int|float
17{
18    // PHPの組み込み関数 abs() は、数値の絶対値を返します。
19    // 数値が負の場合、その正の値を返し、正の場合やゼロの場合はそのままの値を返します。
20    return abs($number);
21}
22
23// --- サンプルコードの動作確認 ---
24
25// 負の数値
26$negativeValue = -123.45;
27echo "元の数値: " . $negativeValue . ", 負の符号を取り除いた数値: " . removeNegativeSign($negativeValue) . PHP_EOL;
28
29// 正の数値
30$positiveValue = 678;
31echo "元の数値: " . $positiveValue . ", 負の符号を取り除いた数値: " . removeNegativeSign($positiveValue) . PHP_EOL;
32
33// ゼロ
34$zeroValue = 0;
35echo "元の数値: " . $zeroValue . ", 負の符号を取り除いた数値: " . removeNegativeSign($zeroValue) . PHP_EOL;
36
37// 負の整数
38$negativeInteger = -50;
39echo "元の数値: " . $negativeInteger . ", 負の符号を取り除いた数値: " . removeNegativeSign($negativeInteger) . PHP_EOL;

このPHPのサンプルコードは、与えられた数値から負の符号を取り除き、その数値の絶対値を返す removeNegativeSign 関数について説明しています。絶対値とは、数値の符号に関わらず、ゼロからの距離を示す非負の値のことです。

removeNegativeSign 関数は、引数として int 型または float 型の $number を受け取ります。この $number は、負の符号を取り除きたい元の数値です。関数は、この $number が負の数であればその正の値を返し、正の数やゼロであればその値を変更せずにそのまま返します。戻り値も int 型または float 型となり、常に非負の値（絶対値）となります。

この絶対値の計算には、PHPに標準で組み込まれている abs() 関数が使用されています。abs() 関数は、"absolute value"（絶対値）の略で、渡された数値の絶対値を簡単に取得できる便利な関数です。例えば、-10 を abs() に渡すと 10 を返し、5 を渡すと 5 を、0 を渡すと 0 を返します。

サンプルコードでは、負の小数、正の整数、ゼロ、負の整数など、様々な数値を使って removeNegativeSign 関数が期待通りに動作することを確認し、出力結果を表示しています。この関数を使用することで、常に符号を持たない数値、またはゼロを確実に得ることができます。