<?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: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="ndgrid" xml:lang="ru">
    <refnamediv>
        <refname>ndgrid</refname>
        <refpurpose>строит матрицы или N-мерные массивы путем репликации данных векторов
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Синтаксис</title>
        <synopsis>
            [X, Y] = ndgrid(x)
            [X, Y] = ndgrid(x,y)
            [X, Y, Z] = ndgrid(x,y,z)
            [X, Y, Z, T] = ndgrid(x,y,z,t)
            [X1, X2, ..., Xm] = ndgrid(x1,x2,...,xm)
        </synopsis>
    </refsynopsisdiv>
    <refsection role="arguments">
        <title>Аргументы</title>
        <variablelist>
            <varlistentry>
                <term>x, y, z, ...</term>
                <listitem>
                    <para>векторы любых типов данных. Они могут иметь различные типы данных.
                        По умолчанию <literal>y=x</literal>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>X, Y, Z, ...</term>
                <listitem>
                    <para>
                        В случае двух входных аргументов это матрицы, в противном случае это гиперматрицы.
                        Все они имеют одинаковые размеры: <literal>size(x,"*")</literal> строк, <literal>size(y,"*")</literal>
                        столбцов, <literal>size(z,"*")</literal> слоёв и так далее.
                    </para>
                    <para>
                        Они имеют одинаковые типы данных соответствющих входных векторов:
                        <literal>typeof(X)==typeof(x)</literal>,
                        <literal>typeof(Y)==typeof(y)</literal>, и т.д.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection role="description">
        <title>Описание</title>
        <para>
            Первое применение функции <function>ndgrid</function> заключается в построении сетки
            узлов, формирующих двумерное, трёхмерное или N-мерное пространство в соответствии с
            2, 3  и более наборами <varname>x</varname>, <varname>y</varname> и т.д. координат
            "шаблона" продискретизированных вдоль каждого направления/размерности пространства,
            которое вы желаете сформировать.
        </para>
        <para>
            Следовательно, матрица или гиперматрица <varname>X</varname> сделана через копирование
            вектора <varname>x</varname> по столбцам; матрица или гиперматрица <varname>Y</varname>
            сделана через копирование вектора <varname>y</varname> по строкам; матрица <varname>Z</varname>
            сделана через копирование вектора <varname>z</varname> по всем слоям (третье измерение);
            и т.д
        </para>
        <screen><![CDATA[--> [X, Y] = ndgrid([1 3 4], [0 2 4 6])
 X  =
   1.   1.   1.   1.
   3.   3.   3.   3.
   4.   4.   4.   4.

 Y  =
   0.   2.   4.   6.
   0.   2.   4.   6.
   0.   2.   4.   6.
]]></screen>
        <para>
            Эта схема копирования может быть обобщена к любому числу измерений, а также
            к любому типу универсальных данных. Давайте, например, возьмём 2 атрибута:
            <orderedlist>
                <listitem>Первый - это число, которое нужно выбрать из вектора, скажем
                    <literal>n = [ 3 7 ]</literal>
                </listitem>
                <listitem>Второй - это буква, которую нужно выбрать из вектора, скажем
                    <literal>c = ["a" "e" "i" "o" "u" "y"]</literal>
                </listitem>
            </orderedlist>
            Тогда мы хотим построить множество всех <literal>{n,c}</literal> возможных пар.
            Это будет просто двумерная сетка:
        </para>
        <screen><![CDATA[--> [N, C] = ndgrid([3 7],["a" "e" "i" "o" "u" "y"])
 C  =
!a  e  i  o  u  y  !
!a  e  i  o  u  y  !

 N  =
   3.   3.   3.   3.   3.   3.
   7.   7.   7.   7.   7.   7.
]]></screen>
        <para>
            Тогда <literal>object(i,j)</literal> будет иметь свойства <literal>{n(i) c(j)}</literal>,
            которые темер могут быть адресованы как <literal>{N(i,j) C(i,j)}</literal>.
            Такой вид сетки может быть полезен для инициализации массива структур.
        </para>
        <para>
            Следующие примеры показывают как использовать <varname>X, Y, Z</varname> в
            наиболее распространёных приложениях
        </para>
    </refsection>
    <refsection role="examples">
        <title>Примеры</title>
        <para>
            <emphasis role="bold">Пример #1:</emphasis>
        </para>
        <programlisting role="example"><![CDATA[
// создание простой двухмерной координатной сетки
x = linspace(-10,2,40);
y = linspace(-5,5,40);
[X,Y] = ndgrid(x,y);

// Compute ordinates Z(X,Y) on the {X, Y} grid and plot Z(X,Y)
Z = X - 3*X.*sin(X).*cos(Y-4) ;

clf()
plot3d(x,y,Z, flag=[color("green") 2 4], alpha=7, theta=60); show_window()
 ]]>    </programlisting>
        <scilab:image>
            x = linspace(-10,2,40);
            y = linspace(-5,5,40);
            [X,Y] = ndgrid(x,y);
            Z = X - 3*X.*sin(X).*cos(Y-4) ;
            clf()
            plot3d(x,y,Z, flag=[color("green") 2 4], alpha=7, theta=60); show_window()
        </scilab:image>
        <para>
            <emphasis role="bold">Пример #2:</emphasis>
        </para>
        <programlisting role="example"><![CDATA[
// создание простой трёхмерной координатной сетки
nx = 10; ny = 6; nz = 4;
x = linspace(0,2,nx);
y = linspace(0,1,ny);
z = linspace(0,0.5,nz);
[X,Y,Z] = ndgrid(x,y,z);

// попытаемся отобразить эту трёхмерную координатную сетку ...
XF=[]; YF=[]; ZF=[];
for k=1:nz
   [xf,yf,zf] = nf3d(X(:,:,k), Y(:,:,k), Z(:,:,k));
   XF = [XF xf]; YF = [YF yf]; ZF = [ZF zf];
end
for j=1:ny
   [xf,yf,zf] = nf3d(matrix(X(:,j,:),[nx,nz]),..
                     matrix(Y(:,j,:),[nx,nz]),..
                     matrix(Z(:,j,:),[nx,nz]));
   XF = [XF xf]; YF = [YF yf]; ZF = [ZF zf];
end

clf()
plot3d(XF,YF,ZF, flag=[0 6 3], 66, 61, leg="X@Y@Z")
xtitle("Трёхмерная сетка!"); show_window()
 ]]></programlisting>
        <scilab:image localized="true">
            nx = 10; ny = 6; nz = 4;
            x = linspace(0,2,nx);
            y = linspace(0,1,ny);
            z = linspace(0,0.5,nz);
            [X,Y,Z] = ndgrid(x,y,z);
            XF=[]; YF=[]; ZF=[];
            for k=1:nz
            [xf,yf,zf] = nf3d(X(:,:,k), Y(:,:,k), Z(:,:,k));
            XF = [XF xf]; YF = [YF yf]; ZF = [ZF zf];
            end
            for j=1:ny
            [xf,yf,zf] = nf3d(matrix(X(:,j,:),[nx,nz]),..
            matrix(Y(:,j,:),[nx,nz]),..
            matrix(Z(:,j,:),[nx,nz]));
            XF = [XF xf]; YF = [YF yf]; ZF = [ZF zf];
            end
            clf()
            plot3d(XF,YF,ZF, flag=[0 6 3], 66, 61, leg="X@Y@Z")
            xtitle("Трёхмерная сетка!"); show_window()
        </scilab:image>
        <para>
            <emphasis role="bold">Пример #3: Создание таблицы пар символов:</emphasis>
        </para>
        <programlisting role="example"><![CDATA[
[c1, c2] = ndgrid(["a" "b" "c"], ["a" "b" "c" "d" "e" "f" "g" "h"])
c1+c2
 ]]>    </programlisting>
        <screen><![CDATA[--> [c1, c2] = ndgrid(["a" "b" "c"], ["a" "b" "c" "d" "e" "f" "g" "h"])
 c2  =
!a  b  c  d  e  f  g  h  !
!a  b  c  d  e  f  g  h  !
!a  b  c  d  e  f  g  h  !

 c1  =
!a  a  a  a  a  a  a  a  !
!b  b  b  b  b  b  b  b  !
!c  c  c  c  c  c  c  c  !

--> c1+c2
 ans  =
!aa  ab  ac  ad  ae  af  ag  ah  !
!ba  bb  bc  bd  be  bf  bg  bh  !
!ca  cb  cc  cd  ce  cf  cg  ch  !
]]></screen>
    </refsection>
    <refsection role="see also">
        <title>Смотрите также</title>
        <simplelist type="inline">
            <member>
                <link linkend="meshgrid">meshgrid</link>
            </member>
            <member>
                <link linkend="kron">kron</link>
            </member>
            <member>
                <link linkend="feval">feval</link>
            </member>
            <member>
                <link linkend="nf3d">nf3d</link>
            </member>
        </simplelist>
    </refsection>
    <refsection role="history">
        <title>История</title>
        <revhistory>
            <revision>
                <revnumber>6.0.0</revnumber>
                <revdescription>
                    Расширение до всех однородных типов данных ([], логические, закодированные целые числа,
                    многочлены, дроби, строковые значения). Пересмотр  этой странички справки.
                </revdescription>
            </revision>
            <revision>
                <revnumber>6.0.1</revnumber>
                <revdescription>
                    <literal>ndgrid(x)</literal> теперь принимает по умолчанию <literal>y=x</literal>.
                </revdescription>
            </revision>
        </revhistory>
    </refsection>
</refentry>
