-
Notifications
You must be signed in to change notification settings - Fork 4
/
README.txt
111 lines (83 loc) · 4.57 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
***************************************************************************
* 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:
Dario A. Bini
University of Pisa, Italy
E-mail: [email protected]
Stefano Massei
EPFL, Switzerland
E-mail: [email protected]
Leonardo Robol
ISTI-CNR, Italy
E-mail: [email protected]
REFERENCE:
- Quasi-Toeplitz matrix arithmetic: a MATLAB toolbox
NUMERICAL ALGORITHMS, NN (2018), pp. XXX-XXX
SOFTWARE REVISION DATE:
V1.0, June 2018
SOFTWARE LANGUAGE:
MATLAB R2011b and later
================================================================================
SOFTWARE
================================================================================
This software provides a MATLAB toolbox that implements the arithmetic of
semi-infinite Toeplitz matrices with a low-rank correction. The toolbox
provides operator overloading for the standard matrix operations, such as
addition, multiplication, inversion, matrix powers, as well as a selection
of other useful matrix functions, such as the matrix square root and
expoenntial. An implementatio of cyclic reduction to solve certain quadratic
matrix equations is included.
================================================================================
PACKAGE
================================================================================
The package contains the following folders:
@cqt - Implementation of the CQT class.
docs - Documentation and guide.
private - A few internal implementations.
tests - Unit tests.
On the top-level, the following files are available:
cqtgallery.m - Generates a few example matrices.
cqtguide.m - Compiles and open the guide.
cqtoption.m - Set/Get various options for the toolbox.
cr.m - Simple implementation of cyclic reduction.
================================================================================
HOW TO INSTALL
================================================================================
To install cqt-toolbox, it is sufficient to add it to your MATLAB path
by running addpath /path/to/cqt-toolbox
================================================================================
TEST
================================================================================
To run the unit tests, move the the tests folder and call the script
RunAllTests.m
================================================================================
GUIDE
================================================================================
The command cqtguide compiles the documentation of the toolbox, and opens it in
the browser of MATLAB. It provides a few examples on how to use the toolbox to
define and operate on QT-matrices, and to solve matrix equations and compute
matrix functions.
The first time that cqtguide is executed it runs all the code in the examples,
so allow some time for it complete. Subsequent calls will open the guide
directly.
================================================================================
BUG FIXES / UPDATES
================================================================================
The most recent version of this package can be found on Github, at the
address https://github.com/numpi/cqt-toolbox.