﻿  ***************************************************************************
  * All the software  contained in this library  is protected by copyright. *
  * Permission  to use, copy, modify, and  distribute this software for any *
  * purpose without fee is hereby granted, provided that this entire notice *
  * is included  in all copies  of any software which is or includes a copy *
  * or modification  of this software  and in all copies  of the supporting *
  * documentation for such software.                                        *
  ***************************************************************************
  * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED *
  * WARRANTY. IN NO EVENT, NEITHER  THE AUTHORS, NOR THE PUBLISHER, NOR ANY *
  * MEMBER  OF THE EDITORIAL BOARD OF  THE JOURNAL  "NUMERICAL ALGORITHMS", *
  * NOR ITS EDITOR-IN-CHIEF, BE  LIABLE FOR ANY ERROR  IN THE SOFTWARE, ANY *
  * MISUSE  OF IT  OR ANY DAMAGE ARISING OUT OF ITS USE. THE ENTIRE RISK OF *
  * USING THE SOFTWARE LIES WITH THE PARTY DOING SO.                        *
  ***************************************************************************
  * ANY USE  OF THE SOFTWARE  CONSTITUTES  ACCEPTANCE  OF THE TERMS  OF THE *
  * ABOVE STATEMENT.                                                        *
  ***************************************************************************

   AUTHORS:

       Arthur Neuman, Lothar Reichel
       Kent State University, Kent OH, USA
       Email: aneuman@kent.edu, reichel@mcs.kent.edu

       Hassane Sadok
       Université du Littoral, Calais, France
       Email: sadok@lmpa.univ-littoral.fr

   REFERENCE:

       Algorithms for range restricted iterative methods for linear
       discrete ill-posed problems
       NUMERICAL ALGORITHMS, 59 (2012), pp. 325-331
       DOI: 10.1007/s11075-011-9491-4.

   SOFTWARE REVISION:

       Ver 1.0  MAY 2011

   SOFTWARE LANGUAGE:

       MATLAB 7.11

======================================================================
SOFTWARE
======================================================================

The Range Restricted GMRES Toolbox contains software for the iterative
solution of large linear discrete ill-posed problems by the Range
Restricted GMRES methods. Software for problems with a nonsymmetric
matrix and for problems with a symmetric matrix is provided. The
toolbox also contains auxiliary test problems.

======================================================================
PACKAGE
======================================================================

The main directory contains the following files

readme.txt          : This file
Contents.m          : Contents file
primer.pdf          : A description of the files in this directory
rrgmres_demo.fig    : A file with the user interface of the demo for rrgmres
rrgmres_demo.m      : A demo for executing and illustrating the performance of
                    : rrgmes
rrgmres_dp.m        : Code for rrgmres with the number of iterations determined
                    : by the discrepancy principle
rrgmres_iter.m      : Code for rrgmres with the number of iterations specified
                    : by the user
sym_rrgmres_demo.fig: A file with the user interface of the demo for sym_rrgmres
sym_rrgmres_demo.m  : A demo for executing and illustrating the performance of
                    : sym_rrgmes
sym_rrgmres_dp.m    : Code for sym_rrgmres with the number of iterations
                    : determined by the discrepancy principle
sym_rrgmres_iter.m  : Code for sym_rrgmres with the number of iterations
                    : specified by the user
baart_alt.m         : an auxiliary test problem
deriv2_alt.m        : an auxiliary test problem
phillips_alt.m      : an auxiliary test problem
shaw_alt.m          : an auxiliary test problem


======================================================================
HOW TO INSTALL
======================================================================

The Range Restricted GMRES Toolbox benefits from having the package
Regularization Tools by P.C. Hansen available. The latter package can be
downloaded from http://www2.imm.dtu.dk/~pch/Regutools/

The installation of the Range Restricted GMRES Toolbox is very simple:

Step 1. Download the na33 package from Netlib (filename rrgmrestbx.zip)

Step 2. Unzip the file rrgmrestbx.zip; when you do so the "rrgmrestbx"
        directory will be created.

Step 3. Start MATLAB

Step 4. Add the directory "rrgmrestbx", as well as the directory which
        contains the Regularization Tools, to the Matlab path.

Step 5. Remove the compressed package file
