summaryrefslogtreecommitdiff
path: root/modules/elementary_functions/macros/sqrtm.sci
blob: 7f9736c36a5cbdbdf0e789a68c2771143d9fef3e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
// Copyright (C) INRIA
// Copyright (C) DIGITEO - 2011 - Allan CORNET
//
// This file must be used under the terms of the CeCILL.
// This source file is licensed as described in the file COPYING, which
// you should have received as part of this distribution.  The terms
// are also available at
// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt

function x = sqrtm(a)
    //   sqrtm - computes the matrix square root.
    //%CALLING SEQUENCE
    //   x=sqrtm(a)
    //%PARAMETERS
    //   a   : square hermitian or diagonalizable matrix
    //   x   : square matrix
    //!

    rhs = argn(2);
    if rhs <> 1 then
        error(msprintf(_("%s: Wrong number of input argument(s): %d expected.\n"),"sqrtm", 1));
    end
    if type(a) <> 1 then
        error(msprintf(_("%s: Wrong type for input argument #%d: A real or complex matrix expected.\n"),"sqrtm", 1));
    end
    if ~issquare(a) then
        error(msprintf(_("%s: Wrong size for input argument #%d: A square matrix expected.\n"),"sqrtm", 1));
    end

    x = %s_pow(a, 0.5);

endfunction