Nuspell
spellchecker
Public Member Functions | Static Public Member Functions | List of all members
nuspell::v5::Dictionary Class Reference

The only important public class. More...

#include <dictionary.hxx>

Inheritance diagram for nuspell::v5::Dictionary:
[legend]
Collaboration diagram for nuspell::v5::Dictionary:
[legend]

Public Member Functions

auto spell (std::string_view word) const -> bool
 Checks if a given word is correct. More...
 
auto suggest (std::string_view word, std::vector< std::string > &out) const -> void
 Suggests correct words for a given incorrect word. More...
 

Static Public Member Functions

static auto load_from_aff_dic (std::istream &aff, std::istream &dic) -> Dictionary
 Create a dictionary from opened files as iostreams. More...
 
static auto load_from_path (const std::string &file_path_without_extension) -> Dictionary
 Create a dictionary from files. More...
 

Detailed Description

The only important public class.

Member Function Documentation

◆ load_from_aff_dic()

auto nuspell::v5::Dictionary::load_from_aff_dic ( std::istream &  aff,
std::istream &  dic 
) -> Dictionary
static

Create a dictionary from opened files as iostreams.

Prefer using load_from_path(). Use this if you have a specific use case, like when .aff and .dic are in-memory buffers istringstream.

Parameters
affThe iostream of the .aff file
dicThe iostream of the .dic file
Returns
Dictionary object
Exceptions
Dictionary_Loading_Erroron error

◆ load_from_path()

auto nuspell::v5::Dictionary::load_from_path ( const std::string &  file_path_without_extension) -> Dictionary
static

Create a dictionary from files.

Parameters
file_path_without_extensionpath without extensions (without .dic or .aff)
Returns
Dictionary object
Exceptions
Dictionary_Loading_Erroron error

◆ spell()

auto nuspell::v5::Dictionary::spell ( std::string_view  word) const -> bool

Checks if a given word is correct.

Parameters
wordany word
Returns
true if correct, false otherwise

◆ suggest()

auto nuspell::v5::Dictionary::suggest ( std::string_view  word,
std::vector< std::string > &  out 
) const -> void

Suggests correct words for a given incorrect word.

Parameters
[in]wordincorrect word
[out]outthis object will be populated with the suggestions

The documentation for this class was generated from the following files: