function [x, flag, relres, iter, resvec, resveccg] = symmlq(varargin)
%SYMMLQ   Symmetric LQ Method for codistributed array.
%   X = SYMMLQ(A,B)
%   X = SYMMLQ(A,B)
%   X = SYMMLQ(A,B,TOL)
%   X = SYMMLQ(A,B,TOL,MAXIT)
%   X = SYMMLQ(A,B,TOL,MAXIT,M)
%   X = SYMMLQ(A,B,TOL,MAXIT,M1,M2)
%   X = SYMMLQ(A,B,TOL,MAXIT,M1,M2,X0)
%   [X,FLAG] = SYMMLQ(A,B,...)
%   [X,FLAG,RELRES] = SYMMLQ(A,B,...)
%   [X,FLAG,RELRES,ITER] = SYMMLQ(A,B,...)
%   [X,FLAG,RELRES,ITER,RESVEC] = SYMMLQ(A,B,...)
%      
%   Note that B must be a non-sparse column vector.
%   
%   Limitations:
%   If M1 is a function it is applied independently to each row.
%   
%   Example:
%   Using SYMMLQ to solve a large system of codistributed array data:
%   spmd
%       n = 100; 
%       dOnes = codistributed.ones(n, 1); 
%       dA = spdiags([-2*dOnes 4*dOnes -2*dOnes], -1:1, n, n);
%       db = full(sum(A, 2)); 
%       tol = 1e-10; 
%       maxit = 50;
%       dM = spdiags(4*dOnes, 0, n, n); 
%       
%       dX = SYMMLQ(dA, db, tol, maxit, dM);
%   end
%   
%   See also SYMMLQ, CODISTRIBUTED, ONES, SPDIAGS, SUM.


%   Copyright 1984-2020 The MathWorks, Inc.

% Ensure that only the data inputs (args 1,2,5,6,7) are distributed
isData = [1 1 0 0 1 1 1];
varargin = distributedutil.CodistParser.prepareSolverInputs(varargin, isData);

% Check for an acceptable number of input arguments
if nargin < 2
    error(message('MATLAB:symmlq:NotEnoughInputs'));
end
[A, b, tol, maxit, M1, M2, x0] = iterCheckArgs(varargin{:});

% Check for all zero right hand side vector => all zero solution
isBzero = (nnz(b) == 0);           % is rhs vector, b, all zeros
if (isBzero)                       % if rhs vector is all zeros
    x = b;                         % then  solution is all zeros
    flag = 0;                      % a valid solution has been obtained
    relres = 0;                    % the relative residual is actually 0/0
    iter = 0;                      % no iterations need be performed
    resvec = 0;                    % resvec(1) = norm(b-A*x) = norm(0)
    resveccg = 0;                  % resveccg(1) = norm(b-A*xcg) = norm(0)
    if (nargout < 2)
        parallel.internal.flowthrough.itermsg('symmlq', tol, maxit, 0, flag, iter, NaN);
    end
    return
end

[localA, b, M1, M2, x0] = iterSetupArgs(A, b, M1, M2, x0);
workCodistrB = getCodistributor(b);

[localX, flag, relres, iter, resvec, resveccg] = hSymmlqImpl(workCodistrB, localA, b, tol, maxit, M1, M2, x0);

% Only display a message if the output flag is not used
if nargout < 2
    parallel.internal.flowthrough.itermsg('symmlq', tol, maxit, length(resvec), flag, iter, relres);
end

% Construct distributed result
x = codistributed.pDoBuildFromLocalPart(localX, workCodistrB);
end