Skip to main content

Dictionary

Struct Dictionary 

Source
pub struct Dictionary {
    pub prefix_dictionary: Arc<PrefixDictionary>,
    pub connection_cost_matrix: Arc<ConnectionCostMatrix>,
    pub character_definition: Arc<CharacterDefinition>,
    pub unknown_dictionary: Arc<UnknownDictionary>,
    pub metadata: Arc<Metadata>,
}
Expand description

prefix_dictionary and connection_cost_matrix are Arc-wrapped so that Dictionary::clone() is O(1) regardless of load method (embedded, mmap, or plain filesystem read) – these two components dominate a dictionary’s memory footprint (tens to hundreds of MB), and nothing in this codebase mutates them after construction.

Fields§

§prefix_dictionary: Arc<PrefixDictionary>§connection_cost_matrix: Arc<ConnectionCostMatrix>§character_definition: Arc<CharacterDefinition>§unknown_dictionary: Arc<UnknownDictionary>§metadata: Arc<Metadata>

Implementations§

Source§

impl Dictionary

Source

pub fn unknown_word_details(&self, word_id: usize) -> Vec<&str>

Retrieve the detail fields (POS, etc.) for an unknown word entry.

Source

pub fn word_details(&self, word_id: usize) -> Vec<&str>

Source

pub fn load_from_path(dict_path: &Path) -> LinderaResult<Self>

Load dictionary from a directory containing dictionary files.

When the mmap feature is compiled in, the connection-cost matrix and word list are routed through memory-mapped reads by default (#879); use Dictionary::load_from_path_with_options with use_mmap = false to force eager reads.

Source

pub fn load_from_path_with_options( dict_path: &Path, use_mmap: bool, ) -> LinderaResult<Self>

Load dictionary from a directory with options

use_mmap (when the mmap feature is enabled) routes connection_cost_matrix and prefix_dictionary through memory-mapped reads instead of plain file reads. This does not make either component lazily memory-resident at runtime: ConnectionCostMatrix always eagerly decodes into an owned Vec<i16>, and PrefixDictionary’s double-array trie (da) is always eagerly deserialized into owned daachorse structures (only PrefixDictionary’s vals_data/words_idx_data/words_data remain genuinely mmap-backed and are read lazily at lookup time). metadata and character_definition and unknown_dictionary are always plain-read regardless of this flag. In short, use_mmap only avoids the initial file-read syscall/allocation for the two components it covers — it does not provide OS-level lazy paging for tokenization. Separately, Dictionary::clone() is O(1) regardless of use_mmap, since prefix_dictionary/connection_cost_matrix are Arc-wrapped.

Source

pub fn save_to_path(&self, dict_path: &Path) -> LinderaResult<()>

Save dictionary to a directory

Trait Implementations§

Source§

impl Clone for Dictionary

Source§

fn clone(&self) -> Dictionary

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.