From 7202567040cbe69208e4bfe8944d326a7b4d7c84 Mon Sep 17 00:00:00 2001 From: Yoshito Umaoka Date: Thu, 6 Mar 2014 01:27:21 +0000 Subject: [PATCH] ICU-9101 Cleaned up API doc for StringSearch. Removed clauses mentioning Boyer-Moore algorithm. Keep the docs synchronized with ICU4J StringSearch. X-SVN-Rev: 35354 --- icu4c/source/i18n/unicode/stsearch.h | 85 +++++++++++++--------------- 1 file changed, 38 insertions(+), 47 deletions(-) diff --git a/icu4c/source/i18n/unicode/stsearch.h b/icu4c/source/i18n/unicode/stsearch.h index 75f1629a5ec..c9c910b14bd 100644 --- a/icu4c/source/i18n/unicode/stsearch.h +++ b/icu4c/source/i18n/unicode/stsearch.h @@ -30,85 +30,79 @@ U_NAMESPACE_BEGIN * StringSearch is a SearchIterator that provides * language-sensitive text searching based on the comparison rules defined * in a {@link RuleBasedCollator} object. - * StringSearch ensures that language eccentricity can be - * handled, e.g. for the German collator, characters ß and SS will be matched + * StringSearch ensures that language eccentricity can be + * handled, e.g. for the German collator, characters ß and SS will be matched * if case is chosen to be ignored. * See the * "ICU Collation Design Document" for more information. - *

- * The algorithm implemented is a modified form of the Boyer Moore's search. - * For more information see - * - * "Efficient Text Searching in Java", published in Java Report - * in February, 1999, for further information on the algorithm. *

* There are 2 match options for selection:
- * Let S' be the sub-string of a text string S between the offsets start and - * end . + * Let S' be the sub-string of a text string S between the offsets start and + * end [start, end]. *
- * A pattern string P matches a text string S at the offsets + * A pattern string P matches a text string S at the offsets [start, end] * if * 

 
- * option 1. Some canonical equivalent of P matches some canonical equivalent 
+ * option 1. Some canonical equivalent of P matches some canonical equivalent
  *           of S'
- * option 2. P matches S' and if P starts or ends with a combining mark, 
- *           there exists no non-ignorable combining mark before or after S? 
- *           in S respectively. 
+ * option 2. P matches S' and if P starts or ends with a combining mark,
+ *           there exists no non-ignorable combining mark before or after S?
+ *           in S respectively.
  *
* Option 2. will be the default. *

* This search has APIs similar to that of other text iteration mechanisms * such as the break iterators in BreakIterator. Using these - * APIs, it is easy to scan through text looking for all occurances of + * APIs, it is easy to scan through text looking for all occurrences of * a given pattern. This search iterator allows changing of direction by - * calling a reset followed by a next or previous. - * Though a direction change can occur without calling reset first, + * calling a reset followed by a next or previous. + * Though a direction change can occur without calling reset first, * this operation comes with some speed penalty. - * Match results in the forward direction will match the result matches in + * Match results in the forward direction will match the result matches in * the backwards direction in the reverse order *

- * SearchIterator provides APIs to specify the starting position + * SearchIterator provides APIs to specify the starting position * within the text string to be searched, e.g. setOffset, - * preceding and following. Since the - * starting position will be set as it is specified, please take note that - * there are some danger points which the search may render incorrect + * preceding and following. Since the + * starting position will be set as it is specified, please take note that + * there are some danger points which the search may render incorrect * results: *

*

- * A breakiterator can be used if only matches at logical breaks are desired. - * Using a breakiterator will only give you results that exactly matches the + * A BreakIterator can be used if only matches at logical breaks are desired. + * Using a BreakIterator will only give you results that exactly matches the * boundaries given by the breakiterator. For instance the pattern "e" will * not be found in the string "\u00e9" if a character break iterator is used. *

- * Options are provided to handle overlapping matches. - * E.g. In English, overlapping matches produces the result 0 and 2 - * for the pattern "abab" in the text "ababab", where else mutually + * Options are provided to handle overlapping matches. + * E.g. In English, overlapping matches produces the result 0 and 2 + * for the pattern "abab" in the text "ababab", where else mutually * exclusive matches only produce the result of 0. *

- * Though collator attributes will be taken into consideration while - * performing matches, there are no APIs here for setting and getting the + * Though collator attributes will be taken into consideration while + * performing matches, there are no APIs here for setting and getting the * attributes. These attributes can be set by getting the collator * from getCollator and using the APIs in coll.h. - * Lastly to update StringSearch to the new collator attributes, - * reset() has to be called. + * Lastly to update StringSearch to the new collator attributes, + * reset has to be called. *

* Restriction:
* Currently there are no composite characters that consists of a - * character with combining class > 0 before a character with combining - * class == 0. However, if such a character exists in the future, - * StringSearch does not guarantee the results for option 1. + * character with combining class > 0 before a character with combining + * class == 0. However, if such a character exists in the future, + * StringSearch does not guarantee the results for option 1. *

* Consult the SearchIterator documentation for information on * and examples of how to use instances of this class to implement text @@ -128,7 +122,7 @@ U_NAMESPACE_BEGIN * } * *

- * Note, StringSearch is not to be subclassed. + * Note, StringSearch is not to be subclassed. *

* @see SearchIterator * @see RuleBasedCollator @@ -372,9 +366,7 @@ public: /** * Sets the collator used for the language rules. User retains the * ownership of this collator, thus the responsibility of deletion lies - * with the user. This method causes internal data such as Boyer-Moore - * shift tables to be recalculated, but the iterator's position is - * unchanged. + * with the user. The iterator's position will not be changed by this method. * @param coll collator * @param status for errors if any * @stable ICU 2.0 @@ -383,8 +375,7 @@ public: /** * Sets the pattern used for matching. - * Internal data like the Boyer Moore table will be recalculated, but - * the iterator's position is unchanged. + * The iterator's position will not be changed by this method. * @param pattern search pattern to be found * @param status for errors if any. If the pattern length is 0 then an * U_ILLEGAL_ARGUMENT_ERROR is returned. -- 2.40.0