TSubstringSearch< TChar, TSensitivity > Class Template Reference

Description:

template<typename TChar, lang::Case TSensitivity = lang::Case::Sensitive>
class alib::strings::util::TSubstringSearch< TChar, TSensitivity >

Implements "Knuth-Morris-Pratt" algorithm for searching a substring within a string.

While the well known "Boyer-Moore-Algorithm" is even faster in the average case, for uni-code characters its implementation would be efficient only with very long haystack strings.

For convenience, the following alias type names are available:

• alib::SubstringSearch,
• alib::NSubstringSearch and
• alib::WSubstringSearch.

Template Parameters

TChar	The character type of the haystack and needle strings.
TSensitivity	The letter case sensitivity of the search..

Definition at line 30 of file subsearch.hpp.

#include <subsearch.hpp>

Collaboration diagram for TSubstringSearch< TChar, TSensitivity >:

Public Method Index:
	TSubstringSearch (const TString< TChar > &pNeedle=nullptr)
ALIB_API	~TSubstringSearch ()
	Destructor.
ALIB_API void	Compile (const TString< TChar > &needle)
ALIB_API integer	Search (const TString< TChar > &haystack, integer startIdx=0)

Protected Field Index:
integer *	kmpTable = nullptr
	The Knuth-Morris-Pratt prefix length table.
integer	kmpTableLength = 0
	Length of kmpTable.
TAString< TChar, lang::HeapAllocator >	needle
	The needle set Knuth-Morris-Pratt prefix length table.

Field Details:

kmpTable

template<typename TChar , lang::Case TSensitivity = lang::Case::Sensitive>

integer* kmpTable = nullptr

protected

The Knuth-Morris-Pratt prefix length table.

Definition at line 37 of file subsearch.hpp.

kmpTableLength

template<typename TChar , lang::Case TSensitivity = lang::Case::Sensitive>

integer kmpTableLength = 0

protected

Length of kmpTable.

Definition at line 40 of file subsearch.hpp.

needle

template<typename TChar , lang::Case TSensitivity = lang::Case::Sensitive>

TAString<TChar, lang::HeapAllocator> needle

protected

The needle set Knuth-Morris-Pratt prefix length table.

Definition at line 34 of file subsearch.hpp.

Constructor(s) / Destructor Details:

TSubstringSearch()

template<typename TChar , lang::Case TSensitivity = lang::Case::Sensitive>

template ALIB_API TSubstringSearch ( const TString< TChar > & pNeedle = nullptr )

inline

Constructor. Passes the optional parameters to method Compile.

Parameters

pNeedle

The string to search. Defaults to NULL_STRING to allow parameterless construction with later invocation of Compile.

Definition at line 50 of file subsearch.hpp.

Here is the call graph for this function:

~TSubstringSearch()

template<typename TChar , lang::Case TSensitivity>

template ALIB_API ~TSubstringSearch

(

)

Destructor.

Definition at line 19 of file subsearch.cpp.

Method Details:

Compile()

template<typename TChar , lang::Case TSensitivity>

template ALIB_API void Compile

(

const TString< TChar > &

needle

)

Resets this object to use the given string as the needle to search.

Parameters

needle

The needle to search.

Definition at line 26 of file subsearch.cpp.

Here is the call graph for this function:

Search()

template<typename TChar , lang::Case TSensitivity>

template ALIB_API integer Search	(	const TString< TChar > &	haystack,
		integer	startIdx = 0 )

Searches for the needle in haystack starting at startIdx.

Parameters

haystack	The string to search in.
startIdx	The start of the search. Defaults to 0.

Returns

The index of the next occurrence of the needle in given haystack. -1 if not found.

Definition at line 64 of file subsearch.cpp.

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• subsearch.hpp
• subsearch.cpp