damerau_levenshtein.hh

Go to the documentation of this file.
00001 /* vim: set sw=4 sts=4 et foldmethod=syntax : */
00002 
00003 /*
00004  * Copyright (c) 2007 Fernando J. Pereda
00005  *
00006  * This file is part of the Paludis package manager. Paludis is free software;
00007  * you can redistribute it and/or modify it under the terms of the GNU General
00008  * Public License version 2, as published by the Free Software Foundation.
00009  *
00010  * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
00011  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00012  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
00013  * details.
00014  *
00015  * You should have received a copy of the GNU General Public License along with
00016  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
00017  * Place, Suite 330, Boston, MA  02111-1307  USA
00018  */
00019 
00020 #ifndef PALUDIS_GUARD_PALUDIS_DAMERAU_LEVENSHTEIN_HH
00021 #define PALUDIS_GUARD_PALUDIS_DAMERAU_LEVENSHTEIN_HH 1
00022 
00023 #include <paludis/util/private_implementation_pattern.hh>
00024 #include <string>
00025 
00026 /** \file
00027  * Declarations for paludis::DamerauLevenshtein
00028  *
00029  * \ingroup g_utils
00030  */
00031 
00032 namespace paludis
00033 {
00034     /**
00035      * Object to calculate Damerau-Levenshtein distances between two strings.
00036      *
00037      * \ingroup g_utils
00038      */
00039     class PALUDIS_VISIBLE DamerauLevenshtein :
00040         private PrivateImplementationPattern<DamerauLevenshtein>
00041     {
00042         public:
00043             ///\name Basic Operations
00044             ///\{
00045 
00046             DamerauLevenshtein(const std::string & name);
00047             ~DamerauLevenshtein();
00048 
00049             /**
00050              * Compute the Damerau-Levenshtein to this candidate.
00051              */
00052             unsigned distance_with(const std::string & candidate) const;
00053 
00054             ///\}
00055     };
00056 
00057 #ifdef PALUDIS_HAVE_EXTERN_TEMPLATE
00058     extern template class PrivateImplementationPattern<DamerauLevenshtein>;
00059 #endif
00060 }
00061 
00062 #endif

Generated on Mon Sep 21 10:36:08 2009 for paludis by  doxygen 1.5.4