<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) INRIA - Farid Belahcene
 *
 * 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="ja" xml:id="barhomogenize">
    <refnamediv>
        <refname>barhomogenize</refname>
        <refpurpose>カレントの軸に含まれる棒グラフを均質化する</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>呼び出し手順</title>
        <synopsis>
            barhomogenize()
            barhomogenize(h)
            barhomogenize([h,] style)
            barhomogenize([h,] width)
            barhomogenize([h,] style, width)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>パラメータ</title>
        <variablelist>
            <varlistentry>
                <term>h</term>
                <listitem>
                    <para>軸ハンドル, (デフォルト: h=gca() ).</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>style</term>
                <listitem>
                    <para>
                        文字列, <literal>'grouped'</literal> (デフォルト), または <literal>'stacked'</literal>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>width</term>
                <listitem>
                    <para>(オプション), 実数スカラー, bar の幅 (利用可能な空間の割合) を定義
                        (デフォルト: 0.8).
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>説明</title>
        <para>
            bar を複数回コールする場合,
            <literal>barhomogenize</literal> 関数は,カレントの軸に含まれる
            全ての棒(すなわち,<literal>polyline_style</literal> 6型)の幅とスタイルを
            均質化します.
            これらの棒は同じxデータを有する必要があります
        </para>
        <para>
            <literal>barhomogenize( )</literal> : この場合,
            デフォルト値,<literal>h=gca(), width=0.8, style='grouped'</literal> が使用されます.
        </para>
        <para>
            <literal>barhomogenize(h,...)</literal> :
            描画対象のカレントの軸を定義します.
        </para>
        <para>
            <literal>barhomogenize(...,style,...)</literal> :
            棒の描画方法を定義します.
            オプション = 'grouped'により,
            M個のポリラインをxの各要素に対して中心に置くことができ,
            そして, オプション 'stacked' によりこれらをスタックすることができます.
        </para>
        <para>
            <literal>barhomogenize(...,width)</literal> :
            棒の幅をパーセント単位で定義します
            (通常: 0&lt;width&lt;=1).
        </para>
    </refsection>
    <refsection>
        <title>例</title>
        <para>
            <emphasis role="bold">最初の例:</emphasis> 黄色の棒を1つ (polyline_style=6のポリラインを1本)と棒を3つ
            (polyline_style=6のポリラインを3本)
        </para>
        <programlisting role="example"><![CDATA[
            subplot(2,3,1)
            xtitle('ex1: creation of 1 yellow bar and 3 bars ')
            x=1:3; y1=1:3; y2=[4 3 5;6 7 8;9 10 11];
            bar(x,y1,'yellow');bar(x,y2);

            // これら4本の棒のグループとして均質化
            subplot(2,3,2)
            xtitle('grouped homogenization')
            x=1:3; y1=1:3; y2=[4 3 5;6 7 8;9 10 11];
            bar(x,y1,'yellow');bar(x,y2);
            barhomogenize('grouped',1);

            // これら4本の棒のスタックとして統一化
            subplot(2,3,3)
            xtitle('stacked homogenization')
            x=1:3; y1=1:3; y2=[4 3 5;6 7 8;9 10 11];
            bar(x,y1,'yellow');bar(x,y2);
            barhomogenize('stacked',1);
 ]]></programlisting>
        <scilab:image>
            gcf().axes_size = [800 270];
            subplot(1,3,1)
            xtitle('ex1: creation of 1 yellow bar and 3 bars')
            x=1:3;
            y1=1:3;
            y2=[4 3 5;6 7 8;9 10 11];
            bar(x,y1,'yellow');bar(x,y2);

            subplot(1,3,2)
            xtitle('grouped homogenization')
            x=1:3;
            y1=1:3;
            y2=[4 3 5;6 7 8;9 10 11];
            bar(x,y1,'yellow');bar(x,y2);
            barhomogenize();

            subplot(1,3,3)
            xtitle('stacked homogenization')
            x=1:3; y1=1:3; y2=[4 3 5;6 7 8;9 10 11];
            bar(x,y1,'yellow');bar(x,y2);
            barhomogenize('stacked',1);
        </scilab:image>
        <para>
            <emphasis role="bold">第2の例 :</emphasis> 赤色の棒を1つ (polyline_style=6のポリラインを1本) と
            type=1のポリラインを2本 (plot 関数をコール)
        </para>
        <programlisting role="example"><![CDATA[
            subplot(2,3,4)
            xtitle('ex2: creation of 1 bar and 2 polylines')
            x=1:10; y=sin(x)/2;
            bar(x,y,'red')
            x1=1:10;y1=[sin(x);cos(x)]
            plot(x1,y1)

            // 2本目のポリラインのpolyline_style 型をplotから修正 (このポリラインは棒になります)
            subplot(2,3,5)
            xtitle('transformation of the second polyline to bar')
            x=1:10; y=sin(x)/2;
            bar(x,y,'red')
            x1=1:10;y1=[sin(x);cos(x)]
            plot(x1,y1)
            e=gce(); e2=e.children(2); e2.polyline_style=6;

            // (bar 関数による)最初の棒(修正による)と2個目の棒の均質化.
            subplot(2,3,6)
            xtitle('grouped homogenization')
            x=1:10; y=sin(x)/2;
            bar(x,y,'red')
            x1=1:10;y1=[sin(x);cos(x)]
            plot(x1,y1)
            e=gce(); e2=e.children(2); e2.polyline_style=6;
            barhomogenize();
            // 幅とスタイルを変更
            //barhomogenize('stacked',0.5);
            //barhomogenize('stacked',1);
 ]]></programlisting>
        <scilab:image>
            gcf().axes_size = [800 270];
            // Second example : creation of 1 red bar (i.e 1 polyline with polyline_style=6)
            //  and 2 polylines with type=1 (calling plot function)
            subplot(1,3,1)
            xtitle('ex2: creation of 1 bar and 2 polylines')
            x=1:10;
            y=sin(x)/2;
            bar(x,y,'red')
            x1=1:10;
            y1=[sin(x);cos(x)]
            plot(x1',y1')

            // modify the polyline_style type of the second polyline from plot (this polyline becomes a bar)
            subplot(1,3,2)
            xtitle('transformation of the second polyline to bar')
            x=1:10;
            y=sin(x)/2;
            bar(x,y,'red')
            x1=1:10;
            y1=[sin(x);cos(x)]
            plot(x1',y1')
            e=gce();
            e2=e.children(2);
            e2.polyline_style=6;

            // homogenization of the first bar (from bar function) and second bar (from the modification).
            subplot(1,3,3)
            xtitle('grouped homogenization')
            x=1:10;
            y=sin(x)/2;
            bar(x,y,'red')
            x1=1:10;
            y1=[sin(x);cos(x)]
            plot(x1',y1')
            e=gce();
            e2=e.children(2);
            e2.polyline_style=6;
            barhomogenize();
            // change the style and the width
            //barhomogenize('stacked',0.5);
            //barhomogenize('stacked',1);
        </scilab:image>
    </refsection>
    <refsection role="see also">
        <title>参照</title>
        <simplelist type="inline">
            <member>
                <link linkend="bar">bar</link>
            </member>
            <member>
                <link linkend="histplot">histplot</link>
            </member>
            <member>
                <link linkend="polyline_properties">polyline_properties</link>
            </member>
        </simplelist>
    </refsection>
</refentry>