| | | 1 | | namespace MoreStructures.BurrowsWheelerTransform.Matching; |
| | | 2 | | |
| | | 3 | | /// <summary> |
| | | 4 | | /// The result of a pattern matching done by a <see cref="IMatcher.Match(IEnumerable{char})"/>. |
| | | 5 | | /// </summary> |
| | | 6 | | /// <param name="Success">Whether the pattern matching was successful or not.</param> |
| | | 7 | | /// <param name="MatchedChars"> |
| | | 8 | | /// The number of chars matched from the pattern. If <see cref="Success"/> is <see langword="false"/>, the value will |
| | | 9 | | /// be strictly smaller than the length of the pattern. Otherwise, it will be equal to the length of the pattern. |
| | | 10 | | /// </param> |
| | | 11 | | /// <param name="StartIndex"> |
| | | 12 | | /// The 0-based index, in the Sorted Burrows-Wheeler Transform, of the first char matching. |
| | | 13 | | /// Negative if no matching has happened. |
| | | 14 | | /// </param> |
| | | 15 | | /// <param name="EndIndex"> |
| | | 16 | | /// The 0-based index, in the Sorted Burrows-Wheeler Transform, of the last char matching. |
| | | 17 | | /// Negative if no matching has happened. |
| | | 18 | | /// </param> |
| | 607 | 19 | | public record Match(bool Success, int MatchedChars, int StartIndex, int EndIndex); |