Struct Alphabet

pub struct Alphabet { /* private fields */ }

Implementations

impl Alphabet

pub fn cased(alphabet: &str) -> Result<Self>

pub fn caseless(alphabet: &str) -> Result<Self>

pub fn of_cased(text: &str) -> Self

Generates an alphabet from a string of text. The created alphabet represents the unique characters of the given text in the order they appear.

This is equivalent to calling text.alphabet() from the Analyze trait.

Parameters

• text - The text to get the alphabet of.

Returns

The generated alphabet

Performance

This is O(n) for a given text of length n.

pub fn from_ascii_range<R: RangeBounds<u8> + IntoIterator<Item = u8>>( range: R, ) -> Result<Self>

pub fn random_index_of_coincidence(&self) -> f64

Returns the expected index of coincidence for a truly random string of characters of this alphabet with infinite length.

Returns

The index of coincidence

pub fn characters(&self) -> &[char]

pub fn index_of(&self, character: char) -> Option<AlphabetIndex>

pub fn letter_at(&self, index: AlphabetIndex) -> &char

pub fn union(&self, other: &Self) -> Self

pub fn shift(&self, shift: u8) -> Self

Trait Implementations

impl Clone for Alphabet

fn clone(&self) -> Alphabet

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Alphabet

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Alphabet

fn default() -> Self

Returns the “default value” for a type.

impl Hash for Alphabet

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Alphabet

fn eq(&self, other: &Alphabet) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Alphabet

impl StructuralPartialEq for Alphabet