CosineSimilarity (Grails 3.2.8)
Date: 2017-03-23

Package: grails.util

## [Groovy] Class CosineSimilarity

- grails.util.CosineSimilarity

- Uses cosine similarity to find matches from a candidate set for a specified input. Based on code from http://www.nearinfinity.com/blogs/seth_schroeder/groovy_cosine_similarity_in_grails.html

  Authors:
    Burt Beckwith

- - ### Methods Summary

    Methods
    Type Params | Return Type | Name and description
    --- | --- | ---
    `` | `static java.util.List<java.lang.String>` | `mostSimilar(java.lang.String pattern, java.lang.Object candidates, double threshold = 0)` Sort the candidates by their similarity to the specified input.

  - ### Inherited Methods Summary

    Inherited Methods
    Methods inherited from class | Name
    --- | ---
    `class java.lang.Object` | `java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- - ### Method Detail

    - #### static java.util.List<java.lang.String> mostSimilar(java.lang.String pattern, java.lang.Object candidates, double threshold = 0)

      Sort the candidates by their similarity to the specified input.

      Parameters:
        `pattern` - the input string
        `candidates` - the possible matches
      Returns:
        the ordered candidates