mlfPcg (MATLAB C Math Library)

Preconditioned Conjugate Gradients method

Minimum number of arguments: eleven; minimum number: user-defined. Terminate the argument list with a NULL.

C Prototype

mxArray *mlfPcg(mxArray **flag,
                mxArray **relres,
                mxArray **iter,
                mxArray **resvec,
                mxArray *A,
                mxArray *b,
                mxArray *tol,
                mxArray *maxit,
                mxArray *M1,
                mxArray *M2,
                mxArray *x0,
                ...);

C Syntax

#include "matlab.h"

mxArray *A, *b;                 /* Required input argument(s) */
mxArray *tol, *maxit;           /* Optional input argument(s) */
mxArray *M, *M1, *M2, *x0;      /* Optional input argument(s) */
mxArray *flag=NULL,*relres=NULL;/* Optional output argument(s) */
mxArray *iter=NULL,*resvec=NULL;/* Optional output argument(s) */
mxArray *x = NULL;              /* Return value */

mlfAssign(&x, mlfPcg(NULL,NULL,NULL,NULL,
                     A,b,NULL,NULL,NULL,NULL,NULL,NULL));
mlfAssign(&x, mlfPcg(NULL,NULL,NULL,NULL,
                     A,b,tol,NULL,NULL,NULL,NULL,NULL));
mlfAssign(&x, mlfPcg(NULL,NULL,NULL,NULL,
                     A,b,tol,maxit,NULL,NULL,NULL,NULL));
mlfAssign(&x, mlfPcg(NULL,NULL,NULL,NULL,
                     A,b,tol,maxit,M,NULL,NULL,NULL));
mlfAssign(&x, mlfPcg(NULL,NULL,NULL,NULL,
                     A,b,tol,maxit,M1,M2,NULL,NULL));
mlfAssign(&x, mlfPcg(NULL,NULL,NULL,NULL,
                     A,b,tol,maxit,M1,M2,x0,NULL);
mlfAssign(&x, mlfPcg(NULL,NULL,NULL,NULL,
                     A,b,tol,maxit,M1,M2,x0,NULL));
mlfAssign(&x, mlfPcg(&flag,NULL,NULL,NULL,
                     A,b,tol,maxit,M1,M2,x0,NULL));
mlfAssign(&x, mlfPcg(&flag,&relres,NULL,NULL,
                     A,b,tol,maxit,M1,M2,x0,NULL));
mlfAssign(&x, mlfPcg(&flag,&relres,&iter,NULL,
                     A,b,tol,maxit,M1,M2,x0,NULL));
mlfAssign(&x, mlfPcg(&flag,&relres,&iter,&resvec,
                     A,b,tol,maxit,M1,M2,x0,NULL));

MATLAB Syntax

x = pcg(A,b)
pcg(A,b,tol)
pcg(A,b,tol,maxit)
pcg(A,b,tol,maxit,M)
pcg(A,b,tol,maxit,M1,M2)
pcg(A,b,tol,maxit,M1,M2,x0)
x = pcg(A,b,tol,maxit,M1,M2,x0)
[x,flag] = pcg(A,b,tol,maxit,M1,M2,x0) 
[x,flag,relres] = pcg(A,b,tol,maxit,M1,M2,x0)
[x,flag,relres,iter] = pcg(A,b,tol,maxit,M1,M2,x0)
[x,flag,relres,iter,resvec] = pcg(A,b,tol,maxit,M1,M2,x0)