1/*  Part of SWI-Prolog
    2
    3    Author:        Jan Wielemaker
    4    E-mail:        J.Wielemaker@vu.nl
    5    WWW:           http://www.swi-prolog.org
    6    Copyright (c)  2005-2015, University of Amsterdam
    7    All rights reserved.
    8
    9    Redistribution and use in source and binary forms, with or without
   10    modification, are permitted provided that the following conditions
   11    are met:
   12
   13    1. Redistributions of source code must retain the above copyright
   14       notice, this list of conditions and the following disclaimer.
   15
   16    2. Redistributions in binary form must reproduce the above copyright
   17       notice, this list of conditions and the following disclaimer in
   18       the documentation and/or other materials provided with the
   19       distribution.
   20
   21    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   22    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   23    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
   24    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
   25    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
   26    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
   27    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
   28    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
   29    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   30    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
   31    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   32    POSSIBILITY OF SUCH DAMAGE.
   33*/
   34
   35:- module(double_metaphone,
   36          [ double_metaphone/2,         % +In, -Primary
   37            double_metaphone/3          % +In, -Primary, -Secondary
   38          ]).   39:- use_module(library(sandbox)).   40
   41:- use_foreign_library(foreign(double_metaphone)).   42
   43/** <module> Phonetic string matching
   44
   45The library library(double_metaphone) implements   the  Double Metaphone
   46algorithm  developed  by  Lawrence  Philips    and   described  in  "The
   47Double-Metaphone Search Algorithm" by L   Philips, C/C++ User's Journal,
   482000. Double Metaphone creates a key  from   a  word that represents its
   49phonetic properties. Two words  with  the   same  Double  Metaphone  are
   50supposed to sound similar. The Double Metaphone algorithm is an improved
   51version of the Soundex algorithm.
   52
   53@license The Double Metaphone algorithm is copied from the Perl library
   54that holds the following copyright notice. To the best of our knowledge
   55the Perl license is compatible to the SWI-Prolog license schema and
   56therefore including this module poses no additional license conditions.
   57
   58    ==
   59    Copyright 2000, Maurice Aubrey <maurice@hevanet.com>.
   60    All rights reserved.
   61
   62    This code is based heavily on the C++ implementation by Lawrence
   63    Philips and incorporates several bug fixes courtesy of Kevin
   64    Atkinson <kevina@users.sourceforge.net>.
   65
   66    This module is free software; you may redistribute it and/or
   67    modify it under the same terms as Perl itself.
   68    ==
   69*/
   70
   71%!  double_metaphone(+In, -MetaPhone) is det.
   72%
   73%   Same as double_metaphone/3,  but  only   returning  the  primary
   74%   metaphone.
   75
   76%!  double_metaphone(+In, -MetaPhone, -AltMetaphone) is det.
   77%
   78%   Create metaphone and alternative metaphone  from In. The primary
   79%   metaphone is based on english, while   the  secondary deals with
   80%   common alternative pronounciation in  other   languages.  In  is
   81%   either and atom, string object,  code-   or  character list. The
   82%   metaphones are always returned as atoms.
   83
   84:- multifile sandbox:safe_primitive/1.   85
   86sandbox:safe_primitive(double_metaphone:double_metaphone(_,_)).
   87sandbox:safe_primitive(double_metaphone:double_metaphone(_,_,_))