commonMain.com.darkrockstudios.symspellkt.common.Verbosity.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of SymSpellKt-jvm Show documentation

A Kotlin Multiplatform implementation of the SymSpell Spell Checking algorithm.

The newest version!

package com.darkrockstudios.symspellkt.common

/**
 * Controls the closeness/quantity of returned spelling suggestion
 */
enum class Verbosity {
	/**
	 * Top suggestion with the highest term frequency of the suggestions of smallest edit distance
	 * found.
	 */
	Top,

	/**
	 * All suggestions of smallest edit distance found, suggestions ordered by term frequency.
	 */
	Closest,

	/**
	 * All suggestions within maxEditDistance, suggestions ordered by edit distance,
	 * then by term frequency (slower, no early termination).
	 */
	All
}