lijia-rmmseg-cpp

rmmseg-cpp by pluskid http://rmmseg-cpp.rubyforge.org

== DESCRIPTION:

rmmseg-cpp is a high performance Chinese word segmentation utility for Ruby. It features full "Ferret":http://ferret.davebalmain.com/ integration as well as support for normal Ruby program usage.

rmmseg-cpp is a re-written of the original RMMSeg(http://rmmseg.rubyforge.org/) gem in C++. RMMSeg is written in pure Ruby. Though I tried hard to tweak RMMSeg, it just consumes lots of memory and the segmenting process is rather slow.

The interface is almost identical to RMMSeg but the performance is much better. This gem is always preferable in production use. However, if you want to understand how the MMSEG segmenting algorithm works, the source code of RMMSeg is a better choice than this.

== FEATURES/PROBLEMS:

• Runs fast and the memory consumption is small.
• Support user customized dictionaries.
• Easy Ferret integration.

== SYNOPSIS:

=== A simple script

rmmseg-cpp provides a simple script, which can read the text from standard input and print the segmented result to standard output. Try rmmseg -h for help on the options.

=== In a normal Ruby program

To use rmmseg-cpp in normal Ruby program, first load the package and init by loading the dictionaries:

require 'rubygems' require 'rmmseg'

RMMSeg::Dictionary.load_dictionaries

If you want to add customized dictionaries, append them to +RMMSeg::Dictionary.dictionaries+ before calling +load_dictionaries+. The formats of chars.dic and words.dic are NOT the same:

• For chars.dic, each line contains freq, a space, and then the character
• For words.dic, each line contains length, a space, and then the word.

Note length mean the length of the word, i.e. the number of characters of the word, not number of bytes. WARNING: there should be a newline at the end of every dictionary file.

Then create a +Algorithm+ object and call +next_token+ until got a +nil+:

algor = RMMSeg::Algorithm.new(text) loop do tok = algor.next_token break if tok.nil? puts "#{tok.text} [#{tok.start}..#{tok.end}]" end

=== With Ferret

To use rmmseg-cpp with Ferret, just use the analyzer provided:

analyzer = RMMSeg::Ferret::Analyzer.new { |tokenizer| Ferret::Analysis::LowerCaseFilter.new(tokenizer) }

index = Ferret::Index::Index.new(:analyzer => analyzer)

See misc/ferret_example.rb for a complete example.

== REQUIREMENTS:

• ruby 1.8.x
• g++

== INSTALL:

• sudo gem install rmmseg-cpp

== LICENSE:

(The MIT License)

Copyright (c) 2008 FIXME (different license?)

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 'AS IS', 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.