【PHP8.x】sin()関数の使い方

Copy
1<?php
2
3/**
4 * MathHelperSingleton クラスは、数学計算ユーティリティへのシングルトンアクセスを提供します。
5 * このパターンにより、クラスのインスタンスがシステム全体で常に一つであることを保証し、
6 * グローバルなアクセスポイントを提供します。
7 *
8 * シングルトンは、リソースマネージャや設定オブジェクトなど、
9 * システム内で一意であるべきオブジェクトに役立ちます。
10 */
11class MathHelperSingleton
12{
13    /**
14     * @var MathHelperSingleton|null シングルトンのインスタンスを保持する静的プロパティ。
15     *                               nullの場合はまだインスタンスが作成されていないことを示します。
16     */
17    private static ?MathHelperSingleton $instance = null;
18
19    /**
20     * コンストラクタをプライベートにすることで、外部からの直接的なインスタンス化を防ぎます。
21     * シングルトンパターンでは、インスタンスは getInstance() メソッドを通じてのみ作成されます。
22     */
23    private function __construct()
24    {
25        // 必要に応じて、ここで初期化処理を行うことができます。
26        // 例: ログの初期化、データベース接続など
27    }
28
29    /**
30     * クローン作成を防ぎます。
31     * これにより、既存のシングルトンインスタンスを複製して、
32     * 複数のインスタンスが作成されるのを防ぎます。
33     */
34    private function __clone()
35    {
36    }
37
38    /**
39     * シングルトンインスタンスへのアクセスを提供します。
40     * このメソッドは、クラスの唯一のインスタンスを返します。
41     * まだインスタンスが存在しない場合は、新しく作成します。
42     *
43     * @return MathHelperSingleton クラスの唯一のインスタンス。
44     */
45    public static function getInstance(): MathHelperSingleton
46    {
47        if (self::$instance === null) {
48            self::$instance = new self();
49        }
50        return self::$instance;
51    }
52
53    /**
54     * 与えられた角度のサイン（正弦）値を計算して返します。
55     * PHPの組み込み関数 `sin()` を使用します。
56     * 引数 `$num` はラジアン単位の角度でなければなりません。
57     *
58     * @param float $num ラジアン単位の角度。
59     * @return float 指定された角度のサイン値。
60     */
61    public function getSine(float $num): float
62    {
63        return sin($num);
64    }
65}
66
67// --- サンプルコードの実行例 ---
68
69// シングルトンインスタンスを取得します。
70// 最初に呼び出されたときにインスタンスが作成されます。
71$mathHelper1 = MathHelperSingleton::getInstance();
72
73// 同じインスタンスを再度取得します。
74// 常に同じインスタンスが返されるため、これは $mathHelper1 と同じオブジェクトを参照します。
75$mathHelper2 = MathHelperSingleton::getInstance();
76
77// 角度90度（π/2ラジアン）のサイン値を計算します。
78// PHPの定数 M_PI は円周率πを表します。
79$angleRad = M_PI / 2;
80$sineValue = $mathHelper1->getSine($angleRad);
81
82echo "角度 " . $angleRad . " ラジアン (90度) のサイン値は: " . $sineValue . "\n"; // 出力: 1
83
84// 別のインスタンス（実際には同じインスタンス）を使って、角度0度（0ラジアン）のサイン値を計算します。
85$angleRad2 = 0.0;
86$sineValue2 = $mathHelper2->getSine($angleRad2);
87
88echo "角度 " . $angleRad2 . " ラジアン (0度) のサイン値は: " . $sineValue2 . "\n"; // 出力: 0
89
90// $mathHelper1 と $mathHelper2 が同じインスタンスであることを確認できます。
91// (例えば var_dump($mathHelper1 === $mathHelper2); は true を出力します)
92
93?>

このPHPサンプルコードは、シングルトンデザインパターンを適用したMathHelperSingletonクラスで、サイン（正弦）値の計算機能を提供する方法を示しています。シングルトンパターンとは、特定のクラスのインスタンスがシステム全体で常に一つだけ存在することを保証し、その唯一のインスタンスへのグローバルなアクセスポイントを提供するデザインパターンです。これにより、リソースマネージャや設定オブジェクトなど、システム内で一意であるべきオブジェクトに役立ちます。

MathHelperSingletonクラスは、コンストラクタとクローンメソッドをprivateに設定することで、外部からの直接的なインスタンス化や複製を防いでいます。クラスの唯一のインスタンスは、public staticなgetInstance()メソッドを通じてのみ取得できます。このメソッドは、初回呼び出し時にインスタンスを生成し、以降の呼び出しでは常に同じインスタンスをMathHelperSingleton型として返します。

提供されるgetSine(float $num)メソッドは、PHPの組み込み関数sin()を利用して、引数$numで指定されたラジアン単位の角度のサイン値を計算します。$numは浮動小数点数で、例えばM_PI / 2（90度）や0.0（0度）といった角度を表します。このメソッドは計算結果をfloat型のサイン値として返します。サンプルコードの実行例では、getInstance()を複数回呼び出しても常に同じインスタンスが返され、それを使って異なる角度のサイン値が正しく計算される様子が示されています。

Copy
1<?php
2
3/**
4 * 角度計算に関連するユーティリティ機能を提供するクラス。
5 *
6 * システムエンジニアの皆さん、このクラスは、幾何学的な計算や物理演算が必要な場合に利用できます。
7 * 例えば、Symfonyアプリケーションのサービス層で、特定の計算ロジックをカプセル化するために
8 * このようなユーティリティクラスが作成されることがあります。
9 */
10class AngleCalculator
11{
12    /**
13     * 指定された角度（度数法）のサイン（正弦）を計算します。
14     *
15     * PHPの組み込み関数である `sin` はラジアン単位の角度を引数として受け取ります。
16     * そのため、このメソッドではまず度数法をラジアンに変換してから計算を行います。
17     *
18     * @param float $degrees 角度（度数法）。例: 30.0, 90.0
19     * @return float 指定された角度のサイン値。
20     */
21    public function calculateSine(float $degrees): float
22    {
23        // 度数法をラジアンに変換します。
24        $radians = deg2rad($degrees);
25
26        // sin関数を使用してサイン値を計算します。
27        $sineValue = sin($radians);
28
29        return $sineValue;
30    }
31}
32
33// --- 以下は AngleCalculator クラスの利用例です ---
34
35$calculator = new AngleCalculator();
36
37// 角度30度のサイン値を計算し、表示します。
38$angleInDegrees1 = 30.0;
39$sineResult1 = $calculator->calculateSine($angleInDegrees1);
40echo "{$angleInDegrees1} 度のサイン値: " . $sineResult1 . PHP_EOL;
41
42// 角度90度のサイン値を計算し、表示します。
43$angleInDegrees2 = 90.0;
44$sineResult2 = $calculator->calculateSine($angleInDegrees2);
45echo "{$angleInDegrees2} 度のサイン値: " . $sineResult2 . PHP_EOL;
46
47// 角度180度のサイン値を計算し、表示します。
48$angleInDegrees3 = 180.0;
49$sineResult3 = $calculator->calculateSine($angleInDegrees3);
50echo "{$angleInDegrees3} 度のサイン値: " . $sineResult3 . PHP_EOL;
51
52// 角度270度のサイン値を計算し、表示します。
53$angleInDegrees4 = 270.0;
54$sineResult4 = $calculator->calculateSine($angleInDegrees4);
55echo "{$angleInDegrees4} 度のサイン値: " . $sineResult4 . PHP_EOL;

このPHPコードは、角度計算に関連する機能を提供するAngleCalculatorクラスと、その利用例を示しています。システム開発において、幾何学的な計算や物理演算が必要な場面で、このようなユーティリティクラスが利用されます。特にSymfonyのようなフレームワークを使用する際、計算ロジックを特定のサービスとして切り出す場合に役立ちます。

AngleCalculatorクラス内のcalculateSineメソッドは、指定された角度（度数法）のサイン（正弦）を計算します。引数$degreesには、例えば「30.0」や「90.0」のような度数で表現された角度をfloat型で渡します。PHPの組み込み関数であるsinはラジアン単位の角度を引数として受け取るため、このメソッドではまずdeg2rad関数を使って度数法をラジアンに変換してからsin関数を呼び出しています。最終的に、計算されたサイン値がfloat型で戻り値として返されます。

コードの後半では、AngleCalculatorクラスのインスタンスを作成し、calculateSineメソッドを使って30度、90度、180度、270度のサイン値を順に計算し、その結果を表示しています。これにより、メソッドの具体的な使い方と、各角度に対するサイン値がどのように求められるかを確認できます。

Copy
1<?php
2
3/**
4 * 指定されたラジアン角度のサイン値を計算し、
5 * 結果をダブルクォーテーションとシングルクォーテーションを用いた文字列で表示します。
6 *
7 * この関数は、PHPにおける文字列の扱い、特に変数展開の違いを初心者向けに示します。
8 *
9 * @param float $angleRadians ラジアン単位の角度（例: M_PI / 2 は90度）
10 * @return void
11 */
12function demonstrateSineAndStringQuotes(float $angleRadians): void
13{
14    // sin() 関数は引数としてラジアン単位の角度を取り、そのサイン値を float で返します。
15    // 例: M_PI / 2 (90度) のサイン値は 1.0 です。
16    $sineValue = sin($angleRadians);
17
18    echo "--- sin() 関数の結果と文字列の表示 ---" . PHP_EOL;
19    echo "計算対象の角度 (ラジアン): {$angleRadians}" . PHP_EOL;
20    echo "計算されたサイン値: {$sineValue}" . PHP_EOL . PHP_EOL;
21
22    // ダブルクォーテーション ("...") の文字列:
23    // 文字列内で $変数名 を記述すると、PHPが自動的にその変数の値に展開します（変数展開）。
24    echo "■ ダブルクォーテーションの例 (変数展開あり):" . PHP_EOL;
25    echo "「{$angleRadians}ラジアンのサイン値は {$sineValue} です。」" . PHP_EOL . PHP_EOL;
26
27    // シングルクォーテーション ('...') の文字列:
28    // 文字列内で $変数名 を記述しても、PHPは変数を展開せず、リテラル（そのままのテキスト）として扱います。
29    // 変数の値を含めたい場合は、ドット(.)演算子を使って文字列を結合する必要があります。
30    echo "■ シングルクォーテーションの例 (変数展開なし):" . PHP_EOL;
31    echo '「$angleRadians ラジアンのサイン値は $sineValue です。」' . PHP_EOL;
32    echo '※ このように、シングルクォーテーション内では変数は展開されません。' . PHP_EOL . PHP_EOL;
33
34    echo "■ シングルクォーテーションの例 (ドット結合で変数を組み込む):" . PHP_EOL;
35    echo '「' . $angleRadians . 'ラジアンのサイン値は ' . $sineValue . ' です。」' . PHP_EOL;
36    echo '※ 変数の値を含めるには、ドット(.)演算子で文字列を結合します。' . PHP_EOL;
37}
38
39// サンプルとして、90度（π/2ラジアン）のサイン値を計算し、表示します。
40// M_PI はPHPに組み込まれている円周率の定数です。
41$angleForCalculation = M_PI / 2;
42
43// 関数を呼び出して実行します。
44demonstrateSineAndStringQuotes($angleForCalculation);
45
46// 別の例: 0ラジアンの場合 (サイン値は0)
47// demonstrateSineAndStringQuotes(0.0);

PHPのsin関数は、引数として渡されたラジアン単位の浮動小数点数（角度）のサイン値を計算し、float型で返します。例えば、90度（M_PI / 2ラジアン）のサイン値は1.0です。

このサンプルコードでは、sin関数の利用に加え、PHPにおける文字列の表現方法である「ダブルクォーテーション」と「シングルクォーテーション」の挙動の違いを解説しています。

ダブルクォーテーション（"）で囲まれた文字列内では、$変数名と記述すると、その変数の値が自動的に文字列内に展開されます。

一方、シングルクォーテーション（'）で囲まれた文字列内では、変数は展開されず、$変数名がそのままの文字列として扱われます。変数の値を含めるには、文字列と変数をドット（.）演算子で結合する必要があります。PHPで文字列を効果的に扱うために、これらの引用符による挙動の違いを理解することは大切です。

Copy
1<?php
2
3/**
4 * 指定されたラジアン角度のサイン値を計算し、結果を出力する関数。
5 * システムエンジニアを目指す初心者向けに、PHPのsin関数の基本的な使い方を示します。
6 *
7 * @param float $angleInRadians 計算したい角度（ラジアン単位）
8 * @return void
9 */
10function calculateAndDisplaySine(float $angleInRadians): void
11{
12    // sin()関数を使ってサイン値を計算します。
13    // sin()は引数としてfloat型の数値（ラジアン単位の角度）を受け取り、
14    // float型のサイン値を返します。
15    $sineValue = sin($angleInRadians);
16
17    // 計算結果を出力します。
18    // 参考のため、ラジアン角度を度数法に変換して表示します。
19    $angleInDegrees = rad2deg($angleInRadians);
20
21    echo "角度: " . $angleInDegrees . "度 (" . $angleInRadians . "ラジアン)\n";
22    echo "サイン値: " . $sineValue . "\n";
23}
24
25// --- サンプルコードの実行例 ---
26
27// 例1: 90度（π/2ラジアン）のサイン値を計算
28// M_PI はPHPが提供する円周率πの定数です。
29calculateAndDisplaySine(M_PI / 2);
30
31// 例2: 0度（0ラジアン）のサイン値を計算
32calculateAndDisplaySine(0.0);
33
34// 例3: 180度（πラジアン）のサイン値を計算
35calculateAndDisplaySine(M_PI);
36
37// 例4: 30度（π/6ラジアン）のサイン値を計算
38calculateAndDisplaySine(M_PI / 6);
39
40?>

PHPのsin関数は、指定された角度のサイン（正弦）を計算するために利用されます。この関数は、引数として計算したい角度を浮動小数点数（float）で一つ受け取ります。ここで最も重要なのは、引数に渡す角度がラジアン単位であるという点です。例えば、90度を計算したい場合は、PHPの定数M_PI（円周率π）を利用してM_PI / 2として渡します。戻り値は、計算されたサイン値であり、これも浮動小数点数（float）で返されます。サイン値は必ず-1から1の範囲内の数値です。

提供されたサンプルコードでは、calculateAndDisplaySineという関数が定義されており、その中でsin()関数の具体的な使用例が示されています。この関数は、引数として受け取ったラジアン角度をsin()関数に渡し、得られたサイン値を画面に出力します。例として、90度（M_PI / 2ラジアン）、0度（0ラジアン）、180度（M_PIラジアン）、30度（M_PI / 6ラジアン）といった、よく使われる角度でのサイン値の計算結果が示されており、それぞれの角度に対するsin()関数の挙動を直接確認することができます。このように、数学関数を扱う際には、引数の単位を正しく理解することが重要となります。