  ***************************************************************************
  * 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:

       Claude BREZINSKI
       University of Lille, France
       E-mail: claude.brezinski@univ-lille1.fr

       Michela REDIVO-ZAGLIA
       University of Padova, Italy
       E-mail: michela.redivozaglia@unipd.it

   REFERENCE:

    -  The simplified topological epsilon-algorithms: software and
       applications
       NUMERICAL ALGORITHMS, 74 (2017), pp. 1237-1260
       DOI: 10.1007/s11075-016-0238-0

   SOFTWARE REVISION DATE:

       V1.0, December 2016

   SOFTWARE LANGUAGE:

       MATLAB 2010b and 2016a

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

The package EPSfun is a Matlab toolbox which implements the simplified
topological epsilon-algorithms and allows to use it for accelerating
the convergence of sequences of elements (vectors, matrices or
tensors) of a vector space.
The functions implementing other similar algorithms are also provided.
In particular, it contains the two original topological epsilon
algorithms and Wynn's vector epsilon algorithm for possible
comparisons.
Several demo replicating the examples inserted in the paper are
provided, together with templates for helping the user to apply the
algorithms to his own particular problems.


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

The main directory contains the following files

README.txt     :  This file
Contents.m     :  Contents file
userguide.pdf  :  A detailed guide to the package.
STEAfun/       :  Directory containing the eight functions STEAnv
                  (n=1:2,v=1:4) and SEAW, needed for implementing the
                  simplified topological epsilon-algorithms.
TEAEfun/       :  Directory containing the functions for implementing
		  the original topological epsilon-algorithms TEA1 and
		  TEA2, and Wynn's vector epsilon-algorithm VEAW.
templates/     :  Directory containing some examples of simple scripts
                  for implementing the AM (Acceleration Method) and RM
		  (Restarted Method). We also inserted here the
		  example described in the Section 4.4 of the paper.
demo/          :  Directory containing scripts able to replicate all
		  the examples of Section 5 of the paper and for
		  testing other algorithms.

======================================================================
HOW TO INSTALL AND RUN THE NUMERICAL TESTS
======================================================================

When the archive file containing the package is uncompressed, it
creates a directory named EPSfun. Inside, there is the directory
STEAfun, the only one that must be added to the Matlab search path
(either by the "addpath" command, or using the menus available in the
graphical user interface) for running the demo, the template, or the
user scripts that use the simplified topological epsilon-algorithms.
If the user also wants to use the original topological
epsilon-algorithms TEA1 and TEA2 or the vector epsilon-algorithm VEAW,
the directory TEAEfun must also be added to the path.

To test the functions, the user must change the current directory to
EPSfun/demo or EPSfun/templates. In the first case it is sufficient to
execute the script AMdemo (for the Acceleration Method) or RMdemo (for
the Restarted Method) and choose the example to run.
In the second case, for both AM and RM, two different methods for
solving the example of Section 4.4 of the paper are proposed.

For more details see the userguide.pdf file.
