Struct WordId

pub struct WordId { /* private fields */ }

Dictionary word ID

Encode dictionary ID and word internal ID as 4 bits and 28 bits respectively DicId 0 - system dictionary DicId 15 - OOV and other special nodes

Implementations

impl WordId

pub const INVALID: WordId = _

pub const BOS: WordId = _

pub const EOS: WordId = _

pub const MAX_WORD: u32 = 268_435_455u32

pub const fn from_raw(raw: u32) -> WordId

Create WordId from the compressed representation

pub fn new(dic: u8, word: u32) -> WordId

Create WordId from parts

pub fn checked(dic: u8, word: u32) -> SudachiResult<WordId>

Creates the WordId with correctness checking

pub fn oov(pos_id: u32) -> WordId

Creates an OOV node for pos_id

pub fn dic(&self) -> u8

Extract Dictionary ID

pub fn word(&self) -> u32

Extract Word ID

pub fn is_system(&self) -> bool

Check if the word comes from the system dictionary

pub fn is_user(&self) -> bool

Check if the word comes from the user dictionary

pub fn as_raw(&self) -> u32

pub fn is_oov(&self) -> bool

Check if the word is OOV An OOV node can come of OOV handlers or be a special system node like BOS or EOS

pub fn is_special(&self) -> bool

Checks if the WordId corresponds to a special node

Trait Implementations

impl Clone for WordId

fn clone(&self) -> WordId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WordId

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

Formats the value using the given formatter.

impl Display for WordId

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

Formats the value using the given formatter.

impl Hash for WordId

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 Ord for WordId

fn cmp(&self, other: &WordId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for WordId

fn eq(&self, other: &WordId) -> 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 PartialOrd for WordId

fn partial_cmp(&self, other: &WordId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for WordId

impl Eq for WordId

impl StructuralPartialEq for WordId