Scilab Website | Contribute with GitLab | Mailing list archives | ATOMS toolboxes
Scilab Online Help
5.3.0 - English

Change language to:
Français - 日本語 - Português

Please note that the recommended version of Scilab is 2024.0.0. This page might be outdated.
However, this page did not exist in the previous stable version.

Scilab manual >> API Scilab > sparse > sparse example

sparse example

Sparse use case.

Description

This example shows how to get a sparse variable and return it to Scilab.

Gateway Source

int sparseExample(char *fname,unsigned long fname_len)
{
    SciErr sciErr;
    int* piAddr = NULL;
    int iType   = 0;
    int iRet    = 0;

    CheckRhs(1,1);
    CheckLhs(0,1);

    sciErr = getVarAddressFromPosition(pvApiCtx, 1, &piAddr);
    if(sciErr.iErr)
    {
        printError(&sciErr, 0);
        return 0;
    }

    if(isSparseType(pvApiCtx, piAddr))
    {
        int iRows           = 0;
        int iCols           = 0;
        int iNbItem         = 0;
        int* piNbItemRow    = NULL;
        int* piColPos       = NULL;
        double* pdblReal    = NULL;
        double* pdblImg        = NULL;

        if(isVarComplex(pvApiCtx, piAddr))
        {
            iRet = getAllocatedComplexSparseMatrix(pvApiCtx, piAddr, &iRows, &iCols, &iNbItem, &piNbItemRow, &piColPos, &pdblReal, &pdblImg);
            if(iRet)
            {
                freeAllocatedComplexSparseMatrix(piNbItemRow, piColPos, pdblReal, pdblImg);
                return iRet;
            }

            sciErr = createComplexSparseMatrix(pvApiCtx, Rhs + 1, iRows, iCols, iNbItem, piNbItemRow, piColPos, pdblReal, pdblImg);
            if(sciErr.iErr)
            {
                freeAllocatedComplexSparseMatrix(piNbItemRow, piColPos, pdblReal, pdblImg);
                printError(&sciErr, 0);
                return sciErr.iErr;
            }
            freeAllocatedComplexSparseMatrix(piNbItemRow, piColPos, pdblReal, pdblImg);
        }
        else
        {
            iRet = getAllocatedSparseMatrix(pvApiCtx, piAddr, &iRows, &iCols, &iNbItem, &piNbItemRow, &piColPos, &pdblReal);
            if(iRet)
            {
                freeAllocatedSparseMatrix(piNbItemRow, piColPos, pdblReal);
                return iRet;
            }

            sciErr = createSparseMatrix(pvApiCtx, Rhs + 1, iRows, iCols, iNbItem, piNbItemRow, piColPos, pdblReal);
            if(sciErr.iErr)
            {
                freeAllocatedSparseMatrix(piNbItemRow, piColPos, pdblReal);
                printError(&sciErr, 0);
                return sciErr.iErr;
            }
            freeAllocatedSparseMatrix(piNbItemRow, piColPos, pdblReal);
        }
        LhsVar(1) = Rhs + 1;
    }
    else
    {
        LhsVar(1) = 0;
    }
    return 0;
}

Scilab test script

a = sparse([1,1;2,2;3,3], [1, 2, 3]);
b = sparse([1,1;2,2;3,3], [1 + 2 * %i, 3 , -4 * %i]);
if sparseExample(a) <> a then pause;end
if sparseExample(b) <> b then pause;end
<< freeAllocatedComplexSparseMatrix sparse string >>

Copyright (c) 2022-2023 (Dassault Systèmes)
Copyright (c) 2017-2022 (ESI Group)
Copyright (c) 2011-2017 (Scilab Enterprises)
Copyright (c) 1989-2012 (INRIA)
Copyright (c) 1989-2007 (ENPC)
with contributors
Last updated:
Wed Jan 26 16:23:48 CET 2011