QGIS API Documentation  2.14.0-Essen
Static Public Member Functions | List of all members
QgsStringUtils Class Reference

Utility functions for working with strings. More...

#include <qgsstringutils.h>

Static Public Member Functions

static int hammingDistance (const QString &string1, const QString &string2, bool caseSensitive=false)
 Returns the Hamming distance between two strings. More...
 
static int levenshteinDistance (const QString &string1, const QString &string2, bool caseSensitive=false)
 Returns the Levenshtein edit distance between two strings. More...
 
static QString longestCommonSubstring (const QString &string1, const QString &string2, bool caseSensitive=false)
 Returns the longest common substring between two strings. More...
 
static QString soundex (const QString &string)
 Returns the Soundex representation of a string. More...
 

Detailed Description

Utility functions for working with strings.

Note
Added in version 2.11

Definition at line 27 of file qgsstringutils.h.

Member Function Documentation

int QgsStringUtils::hammingDistance ( const QString string1,
const QString string2,
bool  caseSensitive = false 
)
static

Returns the Hamming distance between two strings.

This equates to the number of characters at corresponding positions within the input strings where the characters are different. The input strings must be the same length.

Parameters
string1first string
string2second string
caseSensitiveset to true for case sensitive comparison
Returns
Hamming distance between strings, or -1 if strings are different lengths.

Definition at line 164 of file qgsstringutils.cpp.

int QgsStringUtils::levenshteinDistance ( const QString string1,
const QString string2,
bool  caseSensitive = false 
)
static

Returns the Levenshtein edit distance between two strings.

This equates to the minimum number of character edits (insertions, deletions or substitutions) required to change one string to another.

Parameters
string1first string
string2second string
caseSensitiveset to true for case sensitive comparison
Returns
edit distance. Lower distances indicate more similar strings.

Definition at line 19 of file qgsstringutils.cpp.

QString QgsStringUtils::longestCommonSubstring ( const QString string1,
const QString string2,
bool  caseSensitive = false 
)
static

Returns the longest common substring between two strings.

This substring is the longest string that is a substring of the two input strings. Eg, the longest common substring of "ABABC" and "BABCA" is "ABC".

Parameters
string1first string
string2second string
caseSensitiveset to true for case sensitive comparison
Returns
longest common substring

Definition at line 101 of file qgsstringutils.cpp.

QString QgsStringUtils::soundex ( const QString string)
static

Returns the Soundex representation of a string.

Soundex is a phonetic matching algorithm, so strings with similar sounds should be represented by the same Soundex code.

Parameters
stringinput string
Returns
4 letter Soundex code

Definition at line 203 of file qgsstringutils.cpp.


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