<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2000 - INRIA - Carlos Klimann
 * Copyright (C) 2014 - Scilab Enterprises - Pierre-Aime Agnel
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="sample">
    <refnamediv>
        <refname>sample</refname>
        <refpurpose>Tirage avec remise.</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Séquence d'appel</title>
        <synopsis>s = sample(n,X,orient)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Paramètres</title>
        <variablelist>
            <varlistentry>
                <term>n</term>
                <listitem>
                    <para>Entier positif (taille de l'échantillon)</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>X</term>
                <listitem>
                    <para>Matrice. Population, les échantillons sont tirés de cette matrice.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>orient</term>
                <listitem>
                    <para>
                        Paramètre optionnel. Les valeurs possibles sont <literal>{'*'}, 1, 2, 'r' </literal> ou <literal>'c'</literal>. Orientations possibles pour le tirage de valeurs de X. Voir la description ci-dessous.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>s</term>
                <listitem>
                    <para>
                        Vecteur ou matrice contenant le tirage de valeurs de <literal>X</literal>.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            Cette fonction renvoie un vecteur ou une matrice. Elle contient un tirage
            de <literal>n</literal> échantillons,  avec remise, d'éléments
            de la matrice <literal>X</literal>.
        </para>
        <para>
            <literal>s = sample(n, X)</literal>
            (ou <literal>s = sample(n, X, '*')</literal>)
            renvoie un vecteur <literal>s</literal>
            dont les <literal>n</literal> valeurs sont tirées aléatoirement,
            avec remise, de <literal>X</literal>.
        </para>
        <para>
            <literal>s = sample(n, X, 'r')</literal>   (ou,   de manière équivalente,
            <literal>s = sample(n, X, 1)</literal>)
            renvoie une matrice de taille  <literal>size(X,'r') * n</literal>.
            Elle contient un échantillon de <literal>n</literal> lignes,
            extraites avec remise, des lignes de <literal>X</literal>.
        </para>
        <para>
            <literal>s = sample(n, X, 'c')</literal>   (ou,   de manière équivalente,
            <literal>s = sample(n, X, 2)</literal>)
            renvoie une matrice de taille  <literal>n * size(X, 'c')</literal>.
            Elle contient un échantillon de <literal>n</literal> colonnes,
            extraites avec remise, des colonnes de <literal>X</literal>.
        </para>
    </refsection>
    <refsection>
        <title>Générateur de nombres aléatoires</title>
        <para>
             <literal>sample</literal> se fonde sur la fonction <link linkend="grand">grand</link> pour générer les tirages aléatoires. Utiliser <literal>grand("setsd", seed)</literal> pour changer la graine aléatoire de <literal>sample</literal>.
        </para>
        <programlisting role="example"><![CDATA[
            seed = getdate("s");
            grand("setsd", seed); //positionne la graine à la date du jour

            seed = 0;
            grand("setsd", seed); //positionne la graine à sa valeur par défaut
            ]]>
        </programlisting>
    </refsection>
    <refsection>
        <title>Exemples</title>
        <programlisting role="example"><![CDATA[
X = ['a' 'dd' 'arreu'; 'ber' 'car' 'zon']
s = sample(25, X)
s = sample(25, X, 'r')
s = sample(25, X, 'c')
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>Voir aussi</title>
        <simplelist type="inline">
            <member>
                <link linkend="samplef">samplef</link>
            </member>
            <member>
                <link linkend="samwr">samwr</link>
            </member>
            <member>
                <link linkend="grand">grand</link>
            </member>
        </simplelist>
    </refsection>
</refentry>

