* Bug 14741: frexp() actually undocumented 03/21003/3
Samuel GOUGEON [Mon, 10 Jun 2019 03:34:24 +0000 (05:34 +0200)]
 Comes after https://codereview.scilab.org/21002

Change-Id: I8280e2488b91fd93bae78939cda9730c7c595771

scilab/modules/elementary_functions/help/en_US/floating_point/frexp.xml [deleted file]
scilab/modules/elementary_functions/help/fr_FR/floating_point/frexp.xml [deleted file]
scilab/modules/elementary_functions/help/ja_JP/floating_point/frexp.xml [deleted file]
scilab/modules/elementary_functions/help/pt_BR/floating_point/frexp.xml [deleted file]
scilab/modules/elementary_functions/help/ru_RU/floating_point/frexp.xml [deleted file]

diff --git a/scilab/modules/elementary_functions/help/en_US/floating_point/frexp.xml b/scilab/modules/elementary_functions/help/en_US/floating_point/frexp.xml
deleted file mode 100644 (file)
index 4805a6f..0000000
+++ /dev/null
@@ -1,101 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- * Scilab ( http://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.
- *
- -->
-<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
-          xmlns:scilab="http://www.scilab.org" xml:id="frexp" xml:lang="en">
-    <refnamediv>
-        <refname>frexp</refname>
-        <refpurpose>dissect floating-point numbers into base 2 exponent and mantissa
-            <emphasis role="bold">(deprecated)</emphasis>
-        </refpurpose>
-    </refnamediv>
-    <refsynopsisdiv>
-        <title>Syntax</title>
-        <synopsis>[f, e] = frexp(x)</synopsis>
-    </refsynopsisdiv>
-    <refsection>
-        <title>Arguments</title>
-        <variablelist>
-            <varlistentry>
-                <term>x</term>
-                <listitem>
-                    <para>real vector or matrix</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>f</term>
-                <listitem>
-                    <para>array of real values, usually in the range 0.5 ≤ abs(f) &lt; 1.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>e</term>
-                <listitem>
-                    <para>
-                        array of integers that satisfy the equation: <literal>x=f.*2.^e</literal>
-                    </para>
-                </listitem>
-            </varlistentry>
-        </variablelist>
-    </refsection>
-    <refsection>
-        <title>Description</title>
-        <warning>
-            <literal>frexp()</literal> becomes an internal function in Scilab 6.1.x.
-            Please use <literal>[f,e] = log2(x)</literal> instead.
-        </warning>
-        <para>This function corresponds to the ANSI C function frexp(). Any zeros
-            in <literal>x</literal> produce <literal>f=0</literal> and
-            <literal>e=0</literal>.
-        </para>
-    </refsection>
-    <refsection>
-        <title>Examples</title>
-        <programlisting role="example"><![CDATA[
-[f,e]=frexp([1,%pi,-3,%eps])
- ]]></programlisting>
-    </refsection>
-    <refsection role="see also">
-        <title>See also</title>
-        <simplelist type="inline">
-            <member>
-                <link linkend="log">log</link>
-            </member>
-            <member>
-                <link linkend="hat">hat</link>
-            </member>
-            <member>
-                <link linkend="ieee">ieee</link>
-            </member>
-            <member>
-                <link linkend="log2">log2</link>
-            </member>
-        </simplelist>
-    </refsection>
-    <refsection role="history">
-        <title>History</title>
-        <revhistory>
-            <revision>
-                <revnumber>6.1.0</revnumber>
-                <revdescription>
-                    frexp() becomes internal. It is publicly replaced with [f,e]=log2(x).
-                </revdescription>
-            </revision>
-        </revhistory>
-    </refsection>
-</refentry>
diff --git a/scilab/modules/elementary_functions/help/fr_FR/floating_point/frexp.xml b/scilab/modules/elementary_functions/help/fr_FR/floating_point/frexp.xml
deleted file mode 100644 (file)
index 5f5becd..0000000
+++ /dev/null
@@ -1,103 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- * Scilab ( http://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.
- *
- -->
-<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
-          xmlns:scilab="http://www.scilab.org" xml:id="frexp" xml:lang="fr">
-    <refnamediv>
-        <refname>frexp</refname>
-        <refpurpose>calcule la représentation en base 2 (mantisse et exposant) d'un nombre décimal
-            <emphasis role="bold">(dépréciée)</emphasis>
-        </refpurpose>
-    </refnamediv>
-    <refsynopsisdiv>
-        <title>Séquence d'appel</title>
-        <synopsis>[f, e] = frexp(x)</synopsis>
-    </refsynopsisdiv>
-    <refsection>
-        <title>Paramètres</title>
-        <variablelist>
-            <varlistentry>
-                <term>x</term>
-                <listitem>
-                    <para>matrice ou vecteur réel</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>f</term>
-                <listitem>
-                    <para>matrice ou vecteur réel, habituellement dans l'intervalle 0.5
-                        &lt;= abs(f) &lt; 1.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>e</term>
-                <listitem>
-                    <para>matrice ou vecteur d'entiers satisfaisant l'équation: x =
-                        f.*2.^e
-                    </para>
-                </listitem>
-            </varlistentry>
-        </variablelist>
-    </refsection>
-    <refsection>
-        <title>Description</title>
-        <warning>
-            <literal>frexp()</literal> devient une fonction interne à compter de Scilab 6.1.x.
-            SVP utiliser désormais <literal>[f,e] = log2(x)</literal> à la place.
-        </warning>
-        <para>Cette fonction correspond à la fonction ANSI C frexp(). Chaque 0
-            dans <literal>x</literal> produit <literal>f=0</literal> et
-            <literal>e=0</literal>.
-        </para>
-    </refsection>
-    <refsection>
-        <title>Exemples</title>
-        <programlisting role="example"><![CDATA[
-[f,e]=frexp([1,%pi,-3,%eps])
- ]]></programlisting>
-    </refsection>
-    <refsection role="see also">
-        <title>Voir aussi</title>
-        <simplelist type="inline">
-            <member>
-                <link linkend="log">log</link>
-            </member>
-            <member>
-                <link linkend="hat">hat</link>
-            </member>
-            <member>
-                <link linkend="ieee">ieee</link>
-            </member>
-            <member>
-                <link linkend="log2">log2</link>
-            </member>
-        </simplelist>
-    </refsection>
-    <refsection role="history">
-        <title>Historique</title>
-        <revhistory>
-            <revision>
-                <revnumber>6.1.0</revnumber>
-                <revdescription>
-                    frexp() devient une fonction interne. Elle est publiquement remplacée par
-                    [f,e]=log2(x).
-                </revdescription>
-            </revision>
-        </revhistory>
-    </refsection>
-</refentry>
diff --git a/scilab/modules/elementary_functions/help/ja_JP/floating_point/frexp.xml b/scilab/modules/elementary_functions/help/ja_JP/floating_point/frexp.xml
deleted file mode 100644 (file)
index c9b9b74..0000000
+++ /dev/null
@@ -1,105 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- * Scilab ( http://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.
- *
- -->
-<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
-          xmlns:scilab="http://www.scilab.org" xml:id="frexp" xml:lang="ja">
-    <refnamediv>
-        <refname>frexp</refname>
-        <refpurpose>
-            浮動小数点数を2を基底とする指数部と仮数部に分解する
-            <emphasis role="bold">(deprecated)</emphasis>
-        </refpurpose>
-    </refnamediv>
-    <refsynopsisdiv>
-        <title>呼び出し手順</title>
-        <synopsis>[f, e] = frexp(x)</synopsis>
-    </refsynopsisdiv>
-    <refsection>
-        <title>引数</title>
-        <variablelist>
-            <varlistentry>
-                <term>x</term>
-                <listitem>
-                    <para>実数のベクトルまたは行列</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>f</term>
-                <listitem>
-                    <para>実数の値の配列, 通常は 0.5 &lt;= abs(f) の範囲
-                        &lt; 1.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>e</term>
-                <listitem>
-                    <para>
-                        以下の式を満たす整数の配列: <literal>x =
-                            f.*2.^e
-                        </literal>
-                    </para>
-                </listitem>
-            </varlistentry>
-        </variablelist>
-    </refsection>
-    <refsection>
-        <title>説明</title>
-        <warning>
-            <literal>frexp()</literal> becomes an internal function in Scilab 6.1.x.
-            Please use <literal>[f,e] = log2(x)</literal> instead.
-        </warning>
-        <para>この関数は ANSI C 関数 frexp()に一致します.
-            <literal>x</literal>の中の 0 は <literal>f=0</literal> かつ
-            <literal>e=0</literal>となります.
-        </para>
-    </refsection>
-    <refsection>
-        <title>例</title>
-        <programlisting role="example"><![CDATA[
-[f,e]=frexp([1,%pi,-3,%eps])
- ]]></programlisting>
-    </refsection>
-    <refsection role="see also">
-        <title>参照</title>
-        <simplelist type="inline">
-            <member>
-                <link linkend="log">log</link>
-            </member>
-            <member>
-                <link linkend="hat">hat</link>
-            </member>
-            <member>
-                <link linkend="ieee">ieee</link>
-            </member>
-            <member>
-                <link linkend="log2">log2</link>
-            </member>
-        </simplelist>
-    </refsection>
-    <refsection role="history">
-        <title>履歴</title>
-        <revhistory>
-            <revision>
-                <revnumber>6.1.0</revnumber>
-                <revdescription>
-                    frexp() becomes internal. It is publicly replaced with [f,e]=log2(x).
-                </revdescription>
-            </revision>
-        </revhistory>
-    </refsection>
-</refentry>
\ No newline at end of file
diff --git a/scilab/modules/elementary_functions/help/pt_BR/floating_point/frexp.xml b/scilab/modules/elementary_functions/help/pt_BR/floating_point/frexp.xml
deleted file mode 100644 (file)
index 3d390b0..0000000
+++ /dev/null
@@ -1,104 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- * Scilab ( http://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.
- *
- -->
-<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
-          xmlns:scilab="http://www.scilab.org" xml:id="frexp" xml:lang="pt">
-    <refnamediv>
-        <refname>frexp</refname>
-        <refpurpose>separa um número em ponto flutuante em potência de base 2 e mantissa
-            <emphasis role="bold">(deprecated)</emphasis>
-        </refpurpose>
-    </refnamediv>
-    <refsynopsisdiv>
-        <title>Seqüência de Chamamento</title>
-        <synopsis>[f, e] = frexp(x)</synopsis>
-    </refsynopsisdiv>
-    <refsection>
-        <title>Parâmetros</title>
-        <variablelist>
-            <varlistentry>
-                <term>x</term>
-                <listitem>
-                    <para>vetor ou matriz de reais </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>f</term>
-                <listitem>
-                    <para>array de valores reais, geralmente no intervalo 0.5 &lt;=
-                        abs(f) &lt; 1.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>e</term>
-                <listitem>
-                    <para>
-                        array de inteiros que satisfazem a equação: <literal>x=
-                            f.*2.^e
-                        </literal>
-                    </para>
-                </listitem>
-            </varlistentry>
-        </variablelist>
-    </refsection>
-    <refsection>
-        <title>Descrição</title>
-        <warning>
-            <literal>frexp()</literal> becomes an internal function in Scilab 6.1.x.
-            Please use <literal>[f,e] = log2(x)</literal> instead.
-        </warning>
-        <para>Esta função corresponde à função ANSI C frexp(). Quaisquer zeros em
-            <literal>x</literal> produzem <literal>f=0</literal> e
-            <literal>e=0</literal>.
-        </para>
-    </refsection>
-    <refsection>
-        <title>Exemplos</title>
-        <programlisting role="example"><![CDATA[
-[f,e]=frexp([1,%pi,-3,%eps])
- ]]></programlisting>
-    </refsection>
-    <refsection role="see also">
-        <title>Ver Também</title>
-        <simplelist type="inline">
-            <member>
-                <link linkend="log">log</link>
-            </member>
-            <member>
-                <link linkend="hat">hat</link>
-            </member>
-            <member>
-                <link linkend="ieee">ieee</link>
-            </member>
-            <member>
-                <link linkend="log2">log2</link>
-            </member>
-        </simplelist>
-    </refsection>
-    <refsection role="history">
-        <title>Histórico</title>
-        <revhistory>
-            <revision>
-                <revnumber>6.1.0</revnumber>
-                <revdescription>
-                    frexp() becomes internal. It is publicly replaced with [f,e]=log2(x).
-                </revdescription>
-            </revision>
-        </revhistory>
-    </refsection>
-</refentry>
diff --git a/scilab/modules/elementary_functions/help/ru_RU/floating_point/frexp.xml b/scilab/modules/elementary_functions/help/ru_RU/floating_point/frexp.xml
deleted file mode 100644 (file)
index 716a8b2..0000000
+++ /dev/null
@@ -1,104 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- * Scilab ( http://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.
- *
- -->
-<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
-          xmlns:scilab="http://www.scilab.org" xml:id="frexp" xml:lang="ru">
-    <refnamediv>
-        <refname>frexp</refname>
-        <refpurpose>делит числа с плавающей запятой на показатель по основанию 2 и мантиссу
-            <emphasis role="bold">(устарело)</emphasis>
-        </refpurpose>
-    </refnamediv>
-    <refsynopsisdiv>
-        <title>Синтаксис</title>
-        <synopsis>[f, e] = frexp(x)</synopsis>
-    </refsynopsisdiv>
-    <refsection>
-        <title>Аргументы</title>
-        <variablelist>
-            <varlistentry>
-                <term>x</term>
-                <listitem>
-                    <para>вещественный вектор или матрица</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>f</term>
-                <listitem>
-                    <para>массив вещественных значений, обычно в диапазоне 0.5 &lt;= abs(f)
-                        &lt; 1.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>e</term>
-                <listitem>
-                    <para>
-                        массив целых чисел, который удовлетворяет уравнению: <literal>x=
-                            f.*2.^e
-                        </literal>
-                    </para>
-                </listitem>
-            </varlistentry>
-        </variablelist>
-    </refsection>
-    <refsection>
-        <title>Описание</title>
-        <warning>
-            <literal>frexp()</literal> становится внутренней функцией в Scilab 6.1.x.
-            Пожалуйста, используйте вместо неё <literal>[f,e] = log2(x)</literal>.
-        </warning>
-        <para>Эта функция соответствует функции C ANSI frexp(). Любые нули в
-            <literal>x</literal> производят <literal>f=0</literal> и
-            <literal>e=0</literal>.
-        </para>
-    </refsection>
-    <refsection>
-        <title>Примеры</title>
-        <programlisting role="example"><![CDATA[
-[f,e]=frexp([1,%pi,-3,%eps])
- ]]></programlisting>
-    </refsection>
-    <refsection role="see also">
-        <title>Смотрите также</title>
-        <simplelist type="inline">
-            <member>
-                <link linkend="log">log</link>
-            </member>
-            <member>
-                <link linkend="hat">hat</link>
-            </member>
-            <member>
-                <link linkend="ieee">ieee</link>
-            </member>
-            <member>
-                <link linkend="log2">log2</link>
-            </member>
-        </simplelist>
-    </refsection>
-    <refsection role="history">
-        <title>История</title>
-        <revhistory>
-            <revision>
-                <revnumber>6.1.0</revnumber>
-                <revdescription>
-                    frexp() становится внутренней. Она публично заменена функцией [f,e]=log2(x).
-                </revdescription>
-            </revision>
-        </revhistory>
-    </refsection>
-</refentry>