Ixian SDK
Public Member Functions | Static Public Member Functions | Properties | List of all members
IXICore.Utils.Wordlist Class Reference

Public Member Functions

 Wordlist (String[] words, char space, string name)
 Constructor used by inheritence only More...
 
bool WordExists (string word, out int index)
 Method to determine if word exists in word list, great for auto language detection More...
 
string GetWordAtIndex (int index)
 Returns a string containing the word at the specified index of the wordlist More...
 
string [] Split (string mnemonic)
 
override string ToString ()
 
string [] GetWords (int[] indices)
 
string GetSentence (int[] indices)
 
int [] ToIndices (string[] words)
 
int [] ToIndices (string sentence)
 
BitArray ToBits (string sentence)
 
string [] GetWords (string sentence)
 

Static Public Member Functions

static Task< Wordlist > LoadWordList (Language language)
 
static async Task< Wordlist > LoadWordList (string name)
 
static Task< Wordlist > AutoDetectAsync (string sentence)
 
static Wordlist AutoDetect (string sentence)
 
static Language AutoDetectLanguage (string[] words)
 
static Language AutoDetectLanguage (string sentence)
 
static BitArray ToBits (int[] values)
 
static int [] ToIntegers (BitArray bits)
 

Properties

static Wordlist Japanese [get]
 
static Wordlist ChineseSimplified [get]
 
static Wordlist ChineseTraditional [get]
 
static Wordlist Spanish [get]
 
static Wordlist English [get]
 
static Wordlist French [get]
 
static IWordlistSource WordlistSource [get, set]
 
string Name [get]
 
char Space [get]
 
int WordCount [get]
 The number of all the words in the wordlist More...
 

Detailed Description

Definition at line 22 of file Wordlist.cs.

Constructor & Destructor Documentation

◆ Wordlist()

IXICore.Utils.Wordlist.Wordlist ( String []  words,
char  space,
string  name 
)

Constructor used by inheritence only

Parameters
wordsThe words to be used in the wordlist
spaceThe desired whitespace character (word separator).
nameCurrently unused.

Definition at line 169 of file Wordlist.cs.

Member Function Documentation

◆ AutoDetect()

static Wordlist IXICore.Utils.Wordlist.AutoDetect ( string  sentence)
static

Definition at line 240 of file Wordlist.cs.

◆ AutoDetectAsync()

static Task<Wordlist> IXICore.Utils.Wordlist.AutoDetectAsync ( string  sentence)
static

Definition at line 236 of file Wordlist.cs.

◆ AutoDetectLanguage() [1/2]

static Language IXICore.Utils.Wordlist.AutoDetectLanguage ( string []  words)
static

Definition at line 244 of file Wordlist.cs.

◆ AutoDetectLanguage() [2/2]

static Language IXICore.Utils.Wordlist.AutoDetectLanguage ( string  sentence)
static

Definition at line 324 of file Wordlist.cs.

◆ GetSentence()

string IXICore.Utils.Wordlist.GetSentence ( int []  indices)

Definition at line 349 of file Wordlist.cs.

◆ GetWordAtIndex()

string IXICore.Utils.Wordlist.GetWordAtIndex ( int  index)

Returns a string containing the word at the specified index of the wordlist

Parameters
indexIndex of word to return
Returns
Word

Definition at line 219 of file Wordlist.cs.

◆ GetWords() [1/2]

string [] IXICore.Utils.Wordlist.GetWords ( int []  indices)

Definition at line 341 of file Wordlist.cs.

◆ GetWords() [2/2]

string [] IXICore.Utils.Wordlist.GetWords ( string  sentence)

Definition at line 413 of file Wordlist.cs.

◆ LoadWordList() [1/2]

static Task<Wordlist> IXICore.Utils.Wordlist.LoadWordList ( Language  language)
static

Definition at line 95 of file Wordlist.cs.

◆ LoadWordList() [2/2]

static async Task<Wordlist> IXICore.Utils.Wordlist.LoadWordList ( string  name)
static

Definition at line 131 of file Wordlist.cs.

◆ Split()

string [] IXICore.Utils.Wordlist.Split ( string  mnemonic)

Definition at line 331 of file Wordlist.cs.

◆ ToBits() [1/2]

static BitArray IXICore.Utils.Wordlist.ToBits ( int []  values)
static

Definition at line 376 of file Wordlist.cs.

◆ ToBits() [2/2]

BitArray IXICore.Utils.Wordlist.ToBits ( string  sentence)

Definition at line 408 of file Wordlist.cs.

◆ ToIndices() [1/2]

int [] IXICore.Utils.Wordlist.ToIndices ( string []  words)

Definition at line 355 of file Wordlist.cs.

◆ ToIndices() [2/2]

int [] IXICore.Utils.Wordlist.ToIndices ( string  sentence)

Definition at line 371 of file Wordlist.cs.

◆ ToIntegers()

static int [] IXICore.Utils.Wordlist.ToIntegers ( BitArray  bits)
static

Definition at line 393 of file Wordlist.cs.

◆ ToString()

override string IXICore.Utils.Wordlist.ToString ( )

Definition at line 336 of file Wordlist.cs.

◆ WordExists()

bool IXICore.Utils.Wordlist.WordExists ( string  word,
out int  index 
)

Method to determine if word exists in word list, great for auto language detection

Parameters
wordThe word to check for existence
Returns
Exists (true/false)

Definition at line 200 of file Wordlist.cs.

Property Documentation

◆ ChineseSimplified

Wordlist IXICore.Utils.Wordlist.ChineseSimplified
staticget

Definition at line 42 of file Wordlist.cs.

◆ ChineseTraditional

Wordlist IXICore.Utils.Wordlist.ChineseTraditional
staticget

Definition at line 53 of file Wordlist.cs.

◆ English

Wordlist IXICore.Utils.Wordlist.English
staticget

Definition at line 75 of file Wordlist.cs.

◆ French

Wordlist IXICore.Utils.Wordlist.French
staticget

Definition at line 86 of file Wordlist.cs.

◆ Japanese

Wordlist IXICore.Utils.Wordlist.Japanese
staticget

Definition at line 31 of file Wordlist.cs.

◆ Name

string IXICore.Utils.Wordlist.Name
get

Definition at line 180 of file Wordlist.cs.

◆ Space

char IXICore.Utils.Wordlist.Space
get

Definition at line 188 of file Wordlist.cs.

◆ Spanish

Wordlist IXICore.Utils.Wordlist.Spanish
staticget

Definition at line 64 of file Wordlist.cs.

◆ WordCount

int IXICore.Utils.Wordlist.WordCount
get

The number of all the words in the wordlist

Definition at line 228 of file Wordlist.cs.

◆ WordlistSource

IWordlistSource IXICore.Utils.Wordlist.WordlistSource
staticgetset

Definition at line 156 of file Wordlist.cs.

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