<?xml version="1.0" encoding="UTF-8"?>
<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="clear">
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2008 - INRIA
 *
 * 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.
 *
 -->
    <refnamediv>
        <refname>clear</refname>
        <refpurpose>Suppression de variables</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Séquence d'appel</title>
        <synopsis>
            clear a b c
            clear('a', 'b', 'c')
            clear(['a' 'b' 'c'])
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Paramètres</title>
        <variablelist>
            <varlistentry>
                <term>a, b, c...</term>
                <listitem>
                    <para>variables de n'importe quel type et taille, non protégées</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            Cette commande supprime des variables non-protégées. Elle supprime de l'environnement les variables dont les noms sont spécifiés.
            Sans argument, <literal>clear</literal> supprime toutes les variables sauf celles qui ont été protégées par <literal>predef</literal>. La succession des commandes <literal>predef(0)</literal> et <literal>clear</literal> supprime toutes les variables.
        </para>
        <para>
            Habituellement, les variables protégées sont les bibliothèques standard et les variables dont le nom commence par le caractère "%".
        </para>
        <para>
            Notez la syntaxe particulière :  <literal>clear a</literal> et non <literal>clear(a)</literal>.
            Notez aussi que <literal>a=[]</literal> ne supprime pas <literal>a</literal>
            mais affecte à <literal>a</literal> une matrice vide.
        </para>
        <para>
            Si un nom <emphasis>Var</emphasis> ne correspond à aucune variable,
            <literal>clear Var</literal> sera simplement ignoré.
        </para>
    <note>
       <literal>clear</literal> peut être surchargée pour toute <literal>mlist("foo")</literal>,
       en définissant la fonction <literal>%foo_clear()</literal>. Celle-ci sera appelée autant
       lors des appels explicites à <literal>clear</literal>, qu'en quittant l'environnement
       où la mlist a été définie.
    </note>
    </refsection>
    <refsection>
        <title>Exemples</title>
        <programlisting role="example"><![CDATA[
a = 2;
b = 3;
c = 4;
clear a
isdef("a") // F
isdef("b") // T
clear("b");
isdef("b") // F

a = 2;
b = 3;
c = 4;
clear(['a' 'b' 'c'])
isdef("a") | isdef("b") | isdef("c") // F
        ]]></programlisting>
        <programlisting role="example"><![CDATA[
function %foo_clear(o)
    disp("deleted");
endfunction

value = mlist("foo");
clear value // will print "deleted"
]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>Voir aussi</title>
        <simplelist type="inline">
            <member>
                <link linkend="predef">predef</link>
            </member>
            <member>
                <link linkend="clearglobal">clearglobal</link>
            </member>
            <member>
                <link linkend="funcprot">funcprot</link>
            </member>
            <member>
                <link linkend="who">who</link>
            </member>
            <member>
                <link linkend="xmlDelete">xmlDelete</link>
            </member>
        </simplelist>
    </refsection>
    <refsection>
        <title>Historique</title>
        <revhistory>
            <revision>
                <revnumber>5.5.0</revnumber>
                <revdescription>Peut prendre une matrice de chaînes de caractères en argument</revdescription>
            </revision>
            <revision>
                <revnumber>6.0.0</revnumber>
                <revdescription>
                  <literal>clear</literal> est désormais protégé. Les affectations telles que
                  <literal>clear=1</literal> ne sont plus possibles.
                </revdescription>
            </revision>
            <revision>
                <revnumber>6.1.0</revnumber>
                <revdescription>
                    <literal>clear</literal> devient surchargeable pour toute
                    <literal>mlist("foo")</literal>, avec <literal>%foo_clear</literal>.
                </revdescription>
            </revision>
        </revhistory>
    </refsection>
</refentry>
