golearn/metrics/pairwise/cosine.go

package pairwise

import (
	"math"

	"gonum.org/v1/gonum/mat"
)

type Cosine struct{}

func NewCosine() *Cosine {
	return &Cosine{}
}

// Dot computes dot value of vectorX and vectorY.
func (c *Cosine) Dot(vectorX *mat.Dense, vectorY *mat.Dense) float64 {
	subVector := new(mat.Dense)
	subVector.MulElem(vectorX, vectorY)
	result := mat.Sum(subVector)

	return result
}

// Distance computes Cosine distance.
// It will return distance which represented as 1-cos() (ranged from 0 to 2).
func (c *Cosine) Distance(vectorX *mat.Dense, vectorY *mat.Dense) float64 {
	dotXY := c.Dot(vectorX, vectorY)
	lengthX := math.Sqrt(c.Dot(vectorX, vectorX))
	lengthY := math.Sqrt(c.Dot(vectorY, vectorY))

	cos := dotXY / (lengthX * lengthY)

	return 1 - cos
}