KmlScadssFactorize

To perform numerical factorization on a matrix, you need to call KmlScadssAnalyze for analysis first.

Interface Definition

C interface:

int KmlScadssFactorize(KmlScadssSolver *solver, KmlScasolverMatrix *matrix, const KmlDssFactorizeOption *basicOptions, const KmlScadssFactorizeOption *scaOptions);

Parameters

Parameter	Type	Description	Input/Output
solver	KmlScadssSolver *	Solver handle created by KmlScadssInit.	Input
matrix	KmlSolverMatrix *	Matrix handle, which is created by KmlSolverMatrixCreate and cannot be a null pointer.	Input
basicOptions	KmlDssFactorizeOption *	Basic configuration options in the factorization phase, which cannot be a null pointer. For details, see Table 1.	Input
scaOptions	KmlScadssFactorizeOption *	Distributed configuration options in the factorization phase. For details, see Table 1. (No configuration items are available currently.)	Input

**Table 1** KmlScadssFactorizeOption structure
Field	Type	Description
fieldMask	uint64_t	Mask that determines to which fields the configuration is applied. A non-zero bit indicates that the value specified by the corresponding field is used, and a zero bit indicates that the default value is used. Currently, no mask bit can be configured.

Return Value

Return Value	Type	Description
KMLSS_NO_ERROR	int	Normal execution.
KMLSS_INTERNAL_ERROR	int	Internal error.
KMLSS_NULL_ARGUMENT	int	A null argument exists in {solver, matrix, basicOptions, scaOptions}.

Dependencies

#include "kml_scadss.h"

Parent topic: Solver Functions