core/source/main/scala/com/rockymadden/stringmetric/similarity/OverlapMetric.scala


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

package com.rockymadden.stringmetric.similarity

import com.rockymadden.stringmetric.Metric.StringMetric

final case class OverlapMetric(n: Int) extends StringMetric[Double] {
	import com.rockymadden.stringmetric.MatchTuple
	import com.rockymadden.stringmetric.Tokenize.NGramTokenizer
	import scala.math

	override def compare(a: Array[Char], b: Array[Char]): Option[Double] =
		if (n <= 0 || a.length < n || b.length < n) None // Because length is less than n, it is not possible to compare.
		else if (a.sameElements(b)) Some(1d)
		else NGramTokenizer(n).tokenize(a).flatMap { ca1bg =>
			NGramTokenizer(n).tokenize(b).map { ca2bg =>
				val ms = scoreMatches(ca1bg.map(_.mkString), ca2bg.map(_.mkString))

				ms.toDouble / math.min(ca1bg.length, ca2bg.length)
			}
		}

	override def compare(a: String, b: String): Option[Double] = compare(a.toCharArray, b.toCharArray)

	private val scoreMatches: (MatchTuple[String] => Int) = (mt) => mt._1.intersect(mt._2).length
}