README.md in string_metric-0.1.0 vs README.md in string_metric-0.1.1
- old
+ new
@@ -1,16 +1,18 @@
# StringMetric
[](https://travis-ci.org/skroutz/string_metric)
[](https://codeclimate.com/github/skroutz/string_metric)
[](https://coveralls.io/r/skroutz/string_metric?branch=master)
+[](http://badge.fury.io/rb/string_metric)
+[](https://gemnasium.com/skroutz/string_metric)
A simple library with String Metric algorithms. If you want to read more about
String Metric algorithms please read [here](https://en.wikipedia.org/wiki/String_metric).
This library wants to support __MRI__ (1.9.3, 2.0.0, 2.1.0), __JRuby__ and
-__Rubinious__.
+__Rubinius__.
## Installation
Add this line to your application's Gemfile:
@@ -40,17 +42,18 @@
Can be `Fixnum` or `Float`.
* `:deletion_cost`: It overrides the default (equals to 1) deletion penanty.
Can be `Fixnum` or `Float`.
-* `:subsctitution_cost`: It overrides the default (equals to 1) substitution
+* `:substitution_cost`: It overrides the default (equals to 1) substitution
penalty. Can be `Fixum` or `Float`.
* `:strategy`: The desired strategy for Levenshtein distance. Supported
- strategies are `:recursive`, `:two_matrix_rows`, `:full_matrix` and
- `:experiment`. The default strategy is `:two_matrix_rows`. One should not
- depend on `:experiment` strategy.
+ strategies are `:recursive`, `:two_matrix_rows`, `:two_matrix_rows_v2`,
+ `:full_matrix` and `:experiment`. The default strategy is
+ `:two_matrix_rows_v2` for MRI and `:two_matrix_rows` for other platforms
+ One should not depend on `:experiment` strategy.
__Examples__
```ruby
@@ -94,20 +97,20 @@
## Current Benchmarks status
__Levenshtein__
+Implementation | User | Real
+-------------------------------------------------|-----------|-----------
+Levenshtein::IterativeWithFullMatrix | 2.260000 | 2.265873
+Levenshtein::IterativeWithTwoMatrixRows | 1.970000 | 1.971205
+Levenshtein::Experiment | 1.680000 | 1.684419
+Levenshtein::IterativeWithTwoMatrixRowsOptimized | 1.270000 | 1.269643
+Text::Levenshtein (from gem text) | 2.180000 | 2.186258
-Implementation | User | Real
---------------------------------------------|-----------|-----------
-Levenshtein::IterativeWithFullMatrix | 0.480000 | 0.475662
-Levenshtein::IterativeWithTwoMatrixRows | 0.350000 | 0.352388
-Levenshtein::Experiment | 0.420000 | 0.420000
-Text::Levenshtein (from gem text) | 0.400000 | 0.400346
+_Currently the set of fixtures is very small - ruby 2.1.0 is used_
-_Currently the set of fixtures is very small_
-
## Other implementations
__Levenshtein__
* this beautiful gem, [text](https://github.com/threedaymonk/text)
@@ -129,6 +132,6 @@
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## Licence
-string_metric is licensed under MIT. See [License](LICENSE.txt)
\ No newline at end of file
+string_metric is licensed under MIT. See [License](LICENSE.txt)