C++ Math Library Reference

gmres

Generalized Minimum Residual method (with restarts)

C++ Prototype

mwArray gmres(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 mwArray &in8=mwArray::DIN, 
              const mwVarargin &in9=mwVarargin::DIN, 
              const mwArray &in10=mwArray::DIN, 
              .
              .
              .
              const mwArray &in40=mwArray::DIN);

mwArray gmres(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 mwArray &in8=mwArray::DIN,
              const mwVarargin &in9=mwVarargin::DIN,
              const mwArray &in10=mwArray::DIN,
              .
              .
              .
              const mwArray &in40=mwArray::DIN);

C++ Syntax

#include "matlab.hpp"

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

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

MATLAB Syntax

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

See Also

MATLAB gmres     Calling Conventions

getfield

gradient