Skip to content

Commit 052b8e5

Browse files
committed
Improve doc
1 parent 3f71356 commit 052b8e5

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/src/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,11 +125,13 @@ The current TCI2 implementation provides the combination of the 2-site algorithm
125125
This functionality is activated by default.
126126
In the function [`crossinterpolate2`](@ref), we alternate between a 2-site-update sweep and a global pivot insertion.
127127
After a 2-site-update sweep, we search for index sets with high interpolation errors (> the given tolerance multiplied by the parameter `tolmarginglobalsearch`) and add them to the TCI2 object, and then we continue with a 2-site-update sweep.
128+
128129
The number of initial points used in one global search is controlled by the parameter `nsearchglobalpivot`.
129130
You may consider increasing this number if the global search is not effective (check the number of pivots found and timings of the global search by setting `verbosity` to a higher value!).
130131
The maximum number of global pivots inserted at once is controlled by the parameter `maxnglobalpivot`.
131132

132-
133+
A rare failure case is that the global search find the index sets with high interpolation errors, but the 2-site algorithm fails to add these pivots into the TCI2 object.
134+
This will end up adding the same index sets in the next global search, leading to an endless loop.
133135

134136
## Estiamte true interpolation error by random global search
135137
Since most of the TCI update algorithms are local, the true interpolation error is not known. However, the error can be estimated by global searches. This is implemented in the function [`estimatetrueerror`](@ref):

0 commit comments

Comments
 (0)