* Bug 16274 fixed: assert_checkequal() with Nan or void in containers
[scilab.git] / scilab / modules / development_tools / help / ja_JP / assert / assert_checkequal.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  *
4  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
5  * Copyright (C) 2010 - 2011 - DIGITEO - Michael Baudin
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  * Copyright (C) 2019 - Samuel GOUGEON
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15  *
16  -->
17 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
18           xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml"
19           xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
20           xmlns:scilab="http://www.scilab.org" xml:id="assert_checkequal" xml:lang="ja">
21     <refnamediv>
22         <refname>assert_checkequal</refname>
23         <refpurpose>計算値と予測値が等しいことを確認する.</refpurpose>
24     </refnamediv>
25     <refsynopsisdiv>
26         <title>呼び出し手順</title>
27         <synopsis>
28             assert_checkequal ( computed , expected )
29             flag = assert_checkequal ( computed , expected )
30             [flag,errmsg] = assert_checkequal ( computed , expected )
31         </synopsis>
32     </refsynopsisdiv>
33     <refsection>
34         <title>パラメータ</title>
35         <variablelist>
36             <varlistentry>
37                 <term>computed:</term>
38                 <listitem>
39                     <para>計算結果</para>
40                 </listitem>
41             </varlistentry>
42             <varlistentry>
43                 <term>expected :</term>
44                 <listitem>
45                     <para>予測された結果</para>
46                 </listitem>
47             </varlistentry>
48             <varlistentry>
49                 <term>flag :</term>
50                 <listitem>
51                     <para>1行1列の論理値行列で, 計算値が予測値と等しい場合に%t,そうでない場合に%f
52                     </para>
53                 </listitem>
54             </varlistentry>
55             <varlistentry>
56                 <term>errmsg :</term>
57                 <listitem>
58                     <para>1行1列の文字列行列で,エラーメッセージ.
59                         flag==%t の場合, errormsg==""となります.
60                         flag==%f の場合, errmsgにはエラーメッセージが出力されます.
61                     </para>
62                 </listitem>
63             </varlistentry>
64         </variablelist>
65     </refsection>
66     <refsection>
67         <title>説明</title>
68         <para>
69             computedとexpectedが等しい場合,そのまま実行されます.
70         </para>
71         <para>
72             For complex numbers: まず実部を確認し,それが等しい場合に虚部を確認します.
73         </para>
74         <para>
75             Matching Nan values are always considered equal.
76         </para>
77         <para>
78             <literal>1/%z</literal> and <literal>2/(2*%z)</literal> are not equal: For the time
79             being, Scilab does not normalize equivalent rationals.
80         </para>
81         <para>
82              In containers, matching <literal>void</literal> elements are considered equal.
83         </para>
84         <para>
85             比較がcomputedがexpectedに等しくないことを示す場合,
86             <itemizedlist>
87                 <listitem>
88                     <para>
89                         errmsg出力変数が使用されない場合,エラーが生成され,
90                     </para>
91                 </listitem>
92                 <listitem>
93                     <para>
94                         errmsg出力変数が使用される場合,エラーは生成されません.
95                     </para>
96                 </listitem>
97             </itemizedlist>
98         </para>
99     </refsection>
100     <refsection>
101         <title>例</title>
102         <para>
103             成功するテスト:
104         </para>
105         <programlisting role="example"><![CDATA[
106 assert_checkequal ( %T , %T );
107 [flag , errmsg] = assert_checkequal ( [%T %F], [%T %F] );
108 assert_checkequal ( %nan , %nan );
109 c = complex(1, %nan)
110 assert_checkequal (c, c);
111 assert_checkequal ( sparse(%nan) , sparse(%nan) );
112 assert_checkequal ( 2:$-1, 2:$-1 );
113
114 assert_checkequal ( ["abc" "" ascii([9 10 13])],  ["abc" "" ascii([9 10 13])] );
115 assert_checkequal ( [gdf(), gda()], [gdf(), gda()]);
116
117 assert_checkequal ( list() , list() );
118 assert_checkequal ( list(1,,3), list(1,,3) );
119 assert_checkequal ( list(1,,list(,4)), list(1,,list(,4)) );
120 assert_checkequal ( list(%nan,,7) , list(%nan,,7) );
121
122 sine = sin;
123 assert_checkequal ( sin, sine );
124 cosinus = cosd;
125 assert_checkequal ( cosinus, cosd );
126 assert_checkequal( iolib, iolib );
127    ]]></programlisting>
128         <para>
129             失敗するテスト:
130         </para>
131         <programlisting role="example"><![CDATA[
132 assert_checkequal ( %F , %T );
133 flag = assert_checkequal ( %F , %T );
134 // エラーは発生しません :
135 [flag , errmsg] = assert_checkequal ( %F , %T )
136
137 assert_checkequal ( [1 2], [3 4] )
138 assert_checkequal ( 1 , [2 3] )
139 assert_checkequal ( 1 , "b" )
140 assert_checkequal ( "b", "B" )
141 assert_checkequal ( 1+%s, 1+%z )
142 assert_checkequal ( 1/%s, 2/(2*%s) )
143
144 assert_checkequal (list(2,,7), list(2,%F,8));
145 assert_checkequal ( [gdf(), gda()], [gdf(), gdf()] );
146 assert_checkequal ( sind, cosd );
147 assert_checkequal ( iolib, corelib );
148    ]]></programlisting>
149    <screen><![CDATA[
150 ...
151 --> assert_checkequal (list(2,,7), list(2,%F,8));
152 at line    22 of function assert_generror   ( SCI\modules\..\assert_generror.sci line 33 )
153 at line   178 of function assert_checkequal ( SCI\modules\..\assert_checkequal.sci line 190 )
154
155 assert_checkequal: Assertion failed: expected(2)= F  while computed(2)= (void)
156
157 --> assert_checkequal ( [gdf(), gda()], [gdf(), gdf()] );
158 at line    22 of function assert_generror   ( SCI\modules\..\assert_generror.sci line 33 )
159 at line   178 of function assert_checkequal ( SCI\modules\..\assert_checkequal.sci line 190 )
160
161 assert_checkequal: Assertion failed: expected(2)= Figure(uid:55)  while computed(2)= Axes(uid:85)
162
163 --> assert_checkequal ( sind, cosd );
164 at line    22 of function assert_generror   ( SCI\modules\..\assert_generror.sci line 33 )
165 at line    82 of function assert_checkequal ( SCI\modules\..\assert_checkequal.sci line 94 )
166
167 assert_checkequal: Assertion failed: expected= cosd()  while computed= sind()
168
169 --> assert_checkequal ( iolib, corelib );
170 at line    22 of function assert_generror   ( SCI\modules\..\assert_generror.sci line 33 )
171 at line    95 of function assert_checkequal ( SCI\modules\..\assert_checkequal.sci line 107 )
172
173 assert_checkequal: Assertion failed: expected= lib@SCI\modules\core\macros\  while ..
174                                      computed= lib@SCI\modules\io\macros\
175 ]]></screen>
176     </refsection>
177     <refsection>
178         <title>参考文献</title>
179         <para>"Automated Software Testing for Matlab", Steven Eddins, 2009</para>
180     </refsection>
181     <refsection>
182         <title>履歴</title>
183         <revhistory>
184             <revision>
185                 <revnumber>5.4.0</revnumber>
186                 <revdescription>関数が導入されました
187                 </revdescription>
188             </revision>
189             <revision>
190                 <revnumber>6.1.0</revnumber>
191                 <revdescription>
192                     <itemizedlist>
193                       <listitem>
194                           The comparison of two implicit lists, Scilab functions, Scilab libraries,
195                           built-in functions or graphic handles is now always possible and properly
196                           done.
197                       </listitem>
198                       <listitem>
199                           In two lists, void and Nan elements are now supported, and matching ones
200                           are considered as equal.
201                       </listitem>
202                       <listitem>
203                           Nan are now supported in input sparse matrices and are considered as equal.
204                       </listitem>
205                       <listitem>
206                           When the test fails while inputs are arrays, the message now indicates
207                           the index of the first mismatching element.
208                       </listitem>
209                    </itemizedlist>
210                 </revdescription>
211             </revision>
212             <revision>
213                 <revnumber>6.1.1</revnumber>
214                 <revdescription>
215                     Matching NaN or void elements in simple or nested containers are now considered equal.
216                 </revdescription>
217             </revision>
218         </revhistory>
219     </refsection>
220 </refentry>