<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2009 - DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
 * Copyright (C) 2013 - Samuel GOUGEON : traduction et extension aux tlist et mlist
 *
 * 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="isfield">
    <refnamediv>
        <refname>isfield</refname>
        <refpurpose>teste l'existence d'un ou plusieurs champs pour une structure, une tlist ou une mlist</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Séquence d'appel</title>
        <synopsis>bool = isfield(s, fieldname)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Paramètres</title>
        <variablelist>
            <varlistentry>
                <term>s</term>
                <listitem>
                    <para>un tableau de structures, ou une liste typée tlist ou mlist</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>fieldname</term>
                <listitem>
                    <para>matrice de textes : noms des champs à détecter</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>bool</term>
                <listitem>
                    <para>
                        matrice booléenne (même format que <varname>fieldname</varname>)
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            bool(i,j) vaut <constant>%t</constant> si le champ nommé <varname>fieldname(i,j)</varname> existe pour le tableau de structure ou tlist ou mlist <varname>s</varname>(indépendamment de la valeur éventuellement affectée à ce champ). Si <varname>s</varname> est une structure, son champ caché <code class="literal">dims</code> est ignoré.
        </para>
    </refsection>
    <refsection>
        <title>Exemples</title>
        <programlisting role="example"><![CDATA[
s = struct("field_1",123,"field_2",456,"field_4",789)

// Test pour un nom de champ unique :
isfield( s , "field_1"  )

// Test simultané pour plusieurs noms de champs :
isfield( s , [ "field_1" "field_2" ; "field_3" "field_4" ] )

// Test sur une liste typée tlist:
s = tlist(["test" "t" "n","","p"], "Hello", %pi, "anonymous", (1-%z)^3)
isfield( s, ["b" "t" ""])
   // =>  F  T  T  (la présence de champs anonymes peut être détectée)

 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>Voir aussi</title>
        <simplelist type="inline">
            <member>
                <link linkend="struct">struct</link>
            </member>
            <member>
                <link linkend="tlist">tlist</link>
            </member>
            <member>
                <link linkend="mlist">mlist</link>
            </member>
            <member>
                <link linkend="getfield">getfield</link>
            </member>
            <member>
                <link linkend="definedfields">definedfields</link>
            </member>
        </simplelist>
    </refsection>
    <refsection>
        <title>Historique</title>
        <revhistory>
            <revision>
                <revnumber>5.5</revnumber>
                <revremark>
                    Extension aux mlist et tlist
                </revremark>
            </revision>
        </revhistory>
    </refsection>
</refentry>
