Salome HOME
Code and documentation update
[modules/adao.git] / doc / en / scripts / simple_FunctionTest.rst
1 .. index:: single: FunctionTest (example)
2
3 This example describes the test of the correct operation of a given operator,
4 and that its call proceeds in a way compatible with its common use in the ADAO
5 algorithms. The required information are minimal, namely here an operator
6 :math:`F` (described for the test by the observation command
7 "*ObservationOperator*"), and a state :math:`\mathbf{x}^b` to test it on
8 (described for the test by the command "*CheckingPoint*").
9
10 The test is repeated a configurable number of times, and a final statistic
11 makes it possible to quickly verify the operator's good behavior. The simplest
12 diagnostic consists in checking, at the very end of the display, the order of
13 magnitude of the values indicated as the mean of the differences between the
14 repeated outputs and their mean, under the part entitled "*Characteristics of
15 the mean of the differences between the outputs Y and their mean Ym*". For a
16 satisfactory operator, these values should be close to the numerical zero.