<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"  xml:lang="en" xml:id="scaling">
    <refnamediv>
        <refname>scaling</refname>
        <refpurpose>affine transformation of a set of points</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>xy1=scaling(xy,scalingFactor,[orig])</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>xy1</term>
                <listitem>
                    <para>matrix of size (2,.).</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>xy</term>
                <listitem>
                    <para>matrix of size (2,.).</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>scalingFactor</term>
                <listitem>
                    <para>real scalar, coefficient of the linear transformation.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>orig</term>
                <listitem>
                    <para>shift vector; default value is [0;0].</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <literal>scaling</literal> performs an affine transformation on the set of points defined
            by the coordinates <literal>xy</literal>:
        </para>
        <para>
            <literal>xy1(:,i) = scalingFactor * (xy(:,i) - orig) + orig</literal>.
        </para>
    </refsection>
</refentry>
