# assert_checkequal

計算値と予測値が等しいことを確認する.

## 呼び出し手順

                assert_checkequal ( computed , expected )
                flag = assert_checkequal ( computed , expected )
                [flag,errmsg] = assert_checkequal ( computed , expected )

## パラメータ

computed:

  計算結果

expected :

  予測された結果

flag :

  1行1列の論理値行列で, 計算値が予測値と等しい場合に%t,そうでない場合に%f

errmsg :

  1行1列の文字列行列で,エラーメッセージ. flag==%t の場合, errormsg==""となります. flag==%f の場合, errmsgにはエラーメッセージが出力されます.

## 説明

computedとexpectedが等しい場合,そのまま実行されます.

入力引数の型が共に1 (すなわち実数行列)の場合, nan以外の値が等しいことが確認されます.

まず実部を確認し,それが等しい場合に虚部を確認します.

比較がcomputedがexpectedに等しくないことを示す場合,

- errmsg出力変数が使用されない場合,エラーが生成され,

- errmsg出力変数が使用される場合,エラーは生成されません.

## 例

    // 成功するテスト
    assert_checkequal ( %T , %T );
    flag = assert_checkequal ( list() , list() );
    [flag , errmsg] = assert_checkequal ( [%T %F], [%T %F] );
    assert_checkequal ( %nan , %nan );

    // 失敗するテスト
    assert_checkequal ( %F , %T );
    flag = assert_checkequal ( %F , %T );
    // エラーは発生しません :
    [flag , errmsg] = assert_checkequal ( %F , %T )
    assert_checkequal ( [1 2], [3 4] )
    assert_checkequal ( 1 , [2 3] )
    assert_checkequal ( 1 , "b" )

## 履歴

5.4.0
関数が導入されました

## 参考文献

"Automated Software Testing for Matlab", Steven Eddins, 2009