This is metaphone.egg.info, produced by makeinfo version 4.7 from
eggdoc-output.texi.

INFO-DIR-SECTION The Algorithmic Language Scheme
START-INFO-DIR-ENTRY
* metaphone.egg: (metaphone.egg).		Metaphone 'sounds like' algorithm
END-INFO-DIR-ENTRY


File: metaphone.egg.info,  Node: Top,  Next: About this egg,  Up: (dir)

metaphone egg
*************

Metaphone 'sounds like' algorithm

Written by Kon Lovett (mailto:klovett@pacbell.net)

   This manual corresponds to version 0.1 of the metaphone extension
library for Chicken Scheme.

* Menu:

* About this egg::
* Documentation::
* License::
* Index::


File: metaphone.egg.info,  Node: About this egg,  Next: Documentation,  Prev: Top,  Up: Top

1 About this egg
****************

* Menu:

* Version history::
* Requirements::
* Usage::


File: metaphone.egg.info,  Node: Version history,  Next: Requirements,  Up: About this egg

1.1 Version history
===================

`0.1'
     Initial release


File: metaphone.egg.info,  Node: Requirements,  Next: Usage,  Prev: Version history,  Up: About this egg

1.2 Requirements
================

This egg requires the following extensions:

   `miscmacros', `misc-extn'


File: metaphone.egg.info,  Node: Usage,  Prev: Requirements,  Up: About this egg

1.3 Usage
=========

Load this egg like so:

   * (require-extension srfi-13 metaphone)

   * or

   * (require-extension utf8 utf8-srfi-13 metaphone)

   * (import utf8)

   * (import utf8-srfi-13)



File: metaphone.egg.info,  Node: Documentation,  Next: License,  Prev: About this egg,  Up: Top

2 Documentation
***************

Supplies an implementation of Lawrence Philips' Double 			Metaphone
algorithm. A 'sounds like' string -> search key utility,
similar to Soundex but with better match and worse computational
performance. Strings must conform to English spelling yet are not
limited to English words.

 -- procedure: make-metaphone-key
          (make-metaphone-key TARGET [#:keylen 4] [#:binary? #t])

     Returns an object comprising the Double Metaphone 				interpretation
     of the `TARGET' string.

    `keylen:'
          A fixnum. The length of the result key.

    `binary?:'
          A boolean. When the key length is 4 an optimization is
          possible, resulting in a fixnum key representation and
          corresponding comparision and space savings.

     Binary keys can only compared with other binary keys. Do
     not use the binary key option unless the programmer is
     prepared to ensure this situation.

 -- procedure: metaphone-key=?
          (metaphone-key=? KEY1 KEY2)

     Are the keys equivalent on the primary or alternate.

 -- procedure: metaphone-key<>?
          (metaphone-key<>? KEY1 KEY2)

     Guess.

 -- procedure: metaphone-key-binary?
          (metaphone-key-binary? KEY)

     Was binary encoding used to construct this metaphone 				key?

 -- procedure: metaphone-key?
          (metaphone-key? OBJECT)

     Guess?

 -- procedure: metaphone-key-binary?
          (metaphone-key-binary? METAPHONE-KEY)

     Is the key binary encoded? Only possible when key length is 4.

 -- procedure: metaphone-key-source
          (metaphone-key-source METAPHONE-KEY)

     Original string.

 -- procedure: metaphone-key-length
          (metaphone-key-length METAPHONE-KEY)

     Key length. When not binary the length of string key(s).

 -- procedure: metaphone-key-primary
          (metaphone-key-primary METAPHONE-KEY)

     The primary key, a string.

     Note that when binary keys the result is a fixnum, not a
     string.

 -- procedure: metaphone-key-alternate
          (metaphone-key-alternate METAPHONE-KEY)

     The alternate key, a string.

     Note that when binary keys the result is a fixnum, not a
     string.

 -- procedure: metaphone-key-with-alternate?
          (metaphone-key-with-alternate? METAPHONE-KEY)

     Is there an alternate key?


File: metaphone.egg.info,  Node: License,  Next: Index,  Prev: Documentation,  Up: Top

3 License
*********


Copyright (c) 2006, Kon Lovett.  All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the Software),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ASIS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.


File: metaphone.egg.info,  Node: Index,  Prev: License,  Up: Top

Index
*****

 [index ]
* Menu:

* make-metaphone-key:                    Documentation.        (line 13)
* metaphone-key-alternate:               Documentation.        (line 74)
* metaphone-key-binary?:                 Documentation.        (line 41)
* metaphone-key-length:                  Documentation.        (line 61)
* metaphone-key-primary:                 Documentation.        (line 66)
* metaphone-key-source:                  Documentation.        (line 56)
* metaphone-key-with-alternate?:         Documentation.        (line 82)
* metaphone-key<>?:                      Documentation.        (line 36)
* metaphone-key=?:                       Documentation.        (line 31)
* metaphone-key?:                        Documentation.        (line 46)



Tag Table:
Node: Top246
Node: About this egg604
Node: Version history791
Node: Requirements954
Node: Usage1172
Node: Documentation1457
Node: License3882
Node: Index5068

End Tag Table