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

Change language to:
Français - 日本語 - Português - Русский

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

Scilab Help >> API Scilab > legacy > Boolean Sparse > boolean sparse example

boolean sparse example

Boolean sparse use case.

Description

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

Gateway Source

#include "api_scilab.h"

int booleanSparseExample(char *fname,void* pvApiCtx)
{
	SciErr sciErr;
	int* piAddr		= NULL;
	int iType		= 0;
	int iRet		= 0;

    CheckInputArgument(pvApiCtx, 1, 1);
    CheckOutputArgument(pvApiCtx, 0, 1);

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

	if(isBooleanSparseType(pvApiCtx, piAddr))
	{
		int iRows			= 0;
		int iCols			= 0;
		int iNbItem			= 0;
		int* piNbItemRow	= NULL;
		int* piColPos		= NULL;

		iRet = getAllocatedBooleanSparseMatrix(pvApiCtx, piAddr, &iRows, &iCols, &iNbItem, &piNbItemRow, &piColPos);
		if(iRet)
		{
			freeAllocatedBooleanSparse(piNbItemRow, piColPos);
			return iRet;
		}

		sciErr = createBooleanSparseMatrix(pvApiCtx, nbInputArgument(pvApiCtx) + 1, iRows, iCols, iNbItem, piNbItemRow, piColPos);
		if(sciErr.iErr)
		{
			freeAllocatedBooleanSparse(piNbItemRow, piColPos);
			printError(&sciErr, 0);
			return sciErr.iErr;
		}

		freeAllocatedBooleanSparse(piNbItemRow, piColPos);
		AssignOutputVariable(pvApiCtx, 1) = nbInputArgument(pvApiCtx) + 1;
	}
	return 0;
}

Scilab test script

bsp = sparse([1,1;2,2;3,3],[%t,%t,%t]);
or(booleanSparseExample(bsp) == bsp)
Report an issue
<< freeAllocatedBooleanSparse Boolean Sparse Scilab Gateway API >>

Copyright (c) 2022-2024 (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:
Thu Feb 14 14:57:46 CET 2019