C++ Math Library Reference

pcg

Preconditioned Conjugate Gradients method

C++ Prototype

mwArray pcg(const mwArray &in1,
            const mwArray &in2=mwArray::DIN,
            const mwArray &in3=mwArray::DIN,
            const mwArray &in4=mwArray::DIN,
            const mwArray &in5=mwArray::DIN,
            const mwArray &in6=mwArray::DIN,
            const mwArray &in7=mwArray::DIN,
            const mwVarargin &in8=mwVarargin::DIN,
            const mwArray &in9=mwArray::DIN,
            .
            .
            .
            const mwArray &in39=mwArray::DIN);

mwArray pcg(mwArray *out1, mwArray *out2,
            mwArray *out3, mwArray *out4,
            const mwArray &in1,
            const mwArray &in2=mwArray::DIN,
            const mwArray &in3=mwArray::DIN,
            const mwArray &in4=mwArray::DIN,
            const mwArray &in5=mwArray::DIN,
            const mwArray &in6=mwArray::DIN,
            const mwArray &in7=mwArray::DIN,
            const mwVarargin &in8=mwVarargin::DIN,
            const mwArray &in9=mwArray::DIN,
            .
            .
            .
            const mwArray &in39=mwArray::DIN);

C++ Syntax

#include "matlab.hpp"

mwArray A, b, tol, maxit, M, M1, M2, x0;// Input argument(s)
mwArray flag, relres, iter, resvec;     // Output argument(s) 
mwArray x;                              // Return value

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

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)

See Also

MATLAB pcg     Calling Conventions

pascal

pchip