fuzzy-string-match 技术文档

1. 安装指南

安装步骤

1. 确保你的系统已经安装了 Ruby 2.0.0 或更高版本。

2. 使用以下命令安装 fuzzy-string-match gem：

   gem install fuzzy-string-match
   

依赖项

• CRuby：

  • RubyInline
  • Ruby 2.0.0 或更高版本

• JRuby：

  • JRuby 1.6.6 或更高版本

2. 项目的使用说明

概述

fuzzy-string-match 是一个用于 Ruby 的模糊字符串匹配库，支持 Jaro-Winkler 距离算法。它提供了两种实现方式：

1. Native 版本：使用 C 语言编写，速度快，但仅支持 ASCII 字符串。
2. Pure Ruby 版本：纯 Ruby 实现，支持 ASCII 和 UTF-8 字符串，但速度较慢。

示例代码

Native 版本

require 'fuzzystringmatch'
jarow = FuzzyStringMatch::JaroWinkler.create( :native )
p jarow.getDistance( "jones", "johnson" )

Pure Ruby 版本

require 'fuzzystringmatch'
jarow = FuzzyStringMatch::JaroWinkler.create( :pure )
p jarow.getDistance( "jones", "johnson" )
p jarow.getDistance( "ああ", "あい" )

在 IRB 中使用

irb(main):001:0> require 'fuzzystringmatch'
=> true
irb(main):002:0> jarow = FuzzyStringMatch::JaroWinkler.create( :native )
=> #<FuzzyStringMatch::JaroWinklerNative:0x000001011b0010>
irb(main):003:0> jarow.getDistance( "al", "al" )
=> 1.0
irb(main):004:0> jarow.getDistance( "dixon", "dicksonx" )
=> 0.8133333333333332

3. 项目 API 使用文档

FuzzyStringMatch::JaroWinkler.create(mode)

• 参数:
  • mode: 可以是 :native 或 :pure，分别表示使用 Native 版本或 Pure Ruby 版本。
• 返回值:
  • 返回一个 FuzzyStringMatch::JaroWinkler 实例。

getDistance(string1, string2)

• 参数:
  • string1: 第一个字符串。
  • string2: 第二个字符串。
• 返回值:
  • 返回两个字符串之间的 Jaro-Winkler 距离，值在 0 到 1 之间，1 表示完全匹配。

4. 项目安装方式

通过 RubyGems 安装

gem install fuzzy-string-match

从源码安装

1. 克隆项目仓库：

   git clone https://github.com/kiyoka/fuzzy-string-match.git
   

2. 进入项目目录：

   cd fuzzy-string-match
   

3. 安装依赖并构建：

   gem build fuzzy-string-match.gemspec
   gem install ./fuzzy-string-match-*.gem
   

通过以上步骤，你可以成功安装并使用 fuzzy-string-match 库。