------------------------------------------------
lines 5-63 of file: xrst/table/sample_table.xrst
------------------------------------------------

{xrst_begin sample_table}

The Sample Table: Samples of Variable Values
############################################

Simulated Data
**************
The :ref:`sample_command-name` creates this table with
one optimal estimates of the :ref:`model_variables-name` .
For each valid :ref:`data_sim_table@simulate_index` .
in the :ref:`data_sim_table-name` , there is an equal
*sample_index* in the table with the optimal variables
for the corresponding measurement.

User's Choice
*************
This table may also be created directly by the user,
with the aid of the :ref:`var_table-name` .
This is useful when one wants to use the
:ref:`predict_command-name` with a specific set of variable values; e.g.,
the values in the :ref:`fit_var_table-name` .

sample_id
*********
This column has type ``integer`` and is the primary key for this table.
Its initial value is zero, and it increments by one for each row.

sample_index
************
This column has type ``integer`` and specifies the index,
for each complete set of :ref:`model_variables-name` ,
in the ``sample`` table.
If *n_var* is the number of rows in the :ref:`var_table-name` ,

    *sample_index* = ``mod`` ( *sample_id* , *n_var* )

The range of *sample_index* is form zero to
:ref:`simulate_command@number_simulate` minus one.

var_id
******
This column has type ``integer`` and specifies the
:ref:`model_variables-name`
that *var_value* corresponds to;
see :ref:`var_table@var_id` .
If *n_var* and *sample* index are as above,

    *sample_id* = *sample_index* * *n_var* + *var_id*

var_value
*********
This column type ``real`` and is the variable value
for this *var_id* and *sample_index* .

Example
*******
The :ref:`sample_command.py-name` is an example that creates this table.

{xrst_end sample_table}