summaryrefslogtreecommitdiff
path: root/modules/elementary_functions/macros/complex.sci
blob: 0bd3a2d2dfb305b5e742285bc4d57588d9e61618 (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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
// Copyright (C) INRIA - Farid BELAHCENE
// Copyright (C) 2011 - DIGITEO - Michael Baudin
//
// 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  y=complex(varargin)

    // COMPLEX function
    // Given the real part and the imaginary part this function constructs the complex form : y=complex(a,b) returns y=a+b*i
    // Inputs :
    //  a, b : real scalars/vectors/matrices
    // output :
    // y : complex form

    [lhs,rhs]=argn(0)
    if ( rhs<1 | rhs>2 ) then
        error(msprintf(gettext("%s: Wrong number of input arguments: %d to %d expected.\n"),"complex",1,2));
    end

    // Get input arguments
    a = varargin(1)
    if ( rhs == 1 ) then
        b = zeros(a)
    else
        b = varargin(2)
    end
    //
    // Check type of input arguments
    if ( typeof(a)<>"constant" ) then
        error(msprintf(gettext("%s: Wrong type for argument #%d: Matrix expected.\n"),"complex",1));
    end
    if ( typeof(b)<>"constant" ) then
        error(msprintf(gettext("%s: Wrong type for argument #%d: Matrix expected.\n"),"complex",2));
    end
    //
    // Check size
    if ( size(a,"*") <> 1 & size(b,"*") <> 1 & size(a)<>size(b) ) then
        error(msprintf(gettext("%s: Incompatible input arguments #%d and #%d: Same sizes expected.\n"),"complex",1,2));
    end
    //
    // Check content of input arguments
    if ( ~isreal(a) ) then
        error(msprintf(gettext("%s: Wrong type for input argument #%d: Real matrix expected.\n"),"complex",1));
    end
    if ( ~isreal(b) ) then
        error(msprintf(gettext("%s: Wrong type for input argument #%d: Real matrix expected.\n"),"complex",2));
    end

    // Proceed...
    y = a+imult(b);
endfunction