Complex management
==================

How to manage Scilab's complex variable read and write process using
call_scilab



Description
~~~~~~~~~~~

This help describes how doubles and matrix of complex can be handle
through the Call Scilab API.

There are several functions which can be used to read / write from the
memory of Scilab. These functions are described in dedicated pages.

Note: Access to variables is done through `api Scilab`_ (named
variable).



Examples
~~~~~~~~


::

    /* 
     * Write a `matrix`_ into Scilab
     * B=[1+%i 4-%i 2+1/2*%i 3; 
     *    3 9 8+42*%i 2 ]
     * Note that it is done column by column
     */ 
    
    `double`_ B[]={1,3,4,9,2,8,3,2};
    `double`_ B_img[]={1,0.233,-1,-0.2,0.5,42,-23,123};   /* Declare the `matrix`_ */
    
    /*
     * Prior to Scilab 5.2:
     * `double`_ B[]={1,3,4,9,2,8,3,2,1,0.233,-1,-0.2,0.5,42,-23,123};
    */
    
    `int`_ rowB=2, colB=4; /* Size of the `matrix`_ */
    `char`_ variableNameB[] = "B";
    SciErr sciErr;
    
    /* Write it into Scilab's memory */
    sciErr = createNamedComplexMatrixOfDouble(pvApiCtx,variableNameB,rowB,colB, B, B_img);
    if(sciErr.iErr)
    {
        printError(&sciErr, 0);
    }
    
    /*
     * Prior to Scilab 5.2:
     * 2F(cwritecmat)(variableNameB, &rowB, &colB, B, strlen(variableNameB));
     */
    printf("\n");
    printf("Display from Scilab of B:\n");
    SendScilabJob("disp(B);"); /* Display B */



::

    `int`_ rowB_ = 0, colB_ = 0, lp_ = 0;
    `int`_ i = 0,j = 0;
    
    `double`_ *matrixOfComplexB = NULL;
    `double`_ *matrixOfComplexB_img = NULL;
    `char`_ variableToBeRetrievedB[] = "B";
    SciErr sciErr;
    
    /* First, retrieve the `size`_ of the matrix */
    readNamedComplexMatrixOfDouble(pvApiCtx, variableToBeRetrievedB, &rowB_, &colB_, NULL, NULL);
    if(sciErr.iErr)
    {
        printError(&sciErr, 0);
    }
    
    /*
     * Prior to Scilab 5.2:
     * C2F(cmatcptr)(variableToBeRetrievedB, &rowB_, &colB_, &lp_, strlen(variableToBeRetrievedB));
     */
    
    /* Alloc the memory */
    matrixOfComplexB = (`double`_*)malloc((rowB_*colB_)*sizeof(`double`_));
    matrixOfComplexB_img = (`double`_*)malloc((rowB_*colB_)*sizeof(`double`_));
    
    /* Load the `matrix`_ */
    sciErr = readNamedComplexMatrixOfDouble(pvApiCtx, variableToBeRetrievedB, &rowB_, &colB_, matrixOfComplexB, matrixOfComplexB_img);
    if(sciErr.iErr)
    {
        printError(&sciErr, 0);
    }
    
    /*
     * Prior to Scilab 5.2:
     * C2F(creadcmat)(variableToBeRetrievedB,&rowB_,&colB_,matrixOfComplexB,strlen(variableToBeRetrievedB) );
     */
    
    printf("\n");
    printf("Display from B formated (size: %d, %d):\n",rowB_, colB_);
    for(j = 0 ; j < rowB_ ; j++)
     {
      for(i = 0 ; i < colB_ ; i++)
       {
        /* Display the formated `matrix`_ ... the way the user
         * expect */
        printf("%5.2f + %5.2f.i  ",matrixOfComplexB[i * rowB_ + j],matrixOfComplexB_img[i * rowB_ + j]);
    
       }
      printf("\n"); /* New row of the `matrix`_ */
     }




See Also
~~~~~~~~


+ `Call_Scilab`_ call_scilab is an interface which provides the
  ability to call Scilab engine from C/C++ code
+ `api Scilab`_ api_scilab is the Scilab interface to read/write data
  from/to Scilab memory
+ `SendScilabJob`_ Send a Scilab task from a C/C++ code (call_scilab)
+ `StartScilab`_ Initializes and starts Scilab engine in Call Scilab
+ `Call_Scilab: Complex Management`_ How to manage Scilab's complex
  variable read and write process using call_scilab
+ `Call_Scilab: Boolean Management`_ How to manage Scilab's boolean
  read and write process using call_scilab and api_scilab
+ `Call_Scilab: String Management`_ How to manage Scilab's String read
  and write process using call_scilab and api_scilab
+ `API_Scilab: Boolean Reading`_ How to read matrix of boolean.
+ `API_Scilab: Boolean Writing`_ How to write matrices of boolean.
+ `API_Scilab: String Reading`_ How to read matrices of strings in a
  gateway.
+ `API_Scilab: String Writing`_ How to write matrices of string in a
  gateway.


.. _StartScilab: StartScilab.html
.. _Call_Scilab: call_scilab.html
.. _API_Scilab: String Reading: String_management_reading_API.html
.. _api Scilab: api_scilab.html
.. _Call_Scilab: Complex Management: ComplexManagement_callscilab.html
.. _API_Scilab: String Writing: String_management_writing_API.html
.. _Call_Scilab: String Management: StringManagement_callscilab.html
.. _API_Scilab: Boolean Writing: boolean_writing_API.html
.. _Call_Scilab: Boolean Management: BooleanManagement_callscilab.html
.. _SendScilabJob: SendScilabJob.html
.. _API_Scilab: Boolean Reading: boolean_reading_API.html