Skip to main content

Text

Struct Text 

Source
pub struct Text { /* private fields */ }
Expand description

A Markov chain text model for generating random sentences

Implementations§

Source§

impl Text

Source

pub fn new( input_text: &str, state_size: usize, retain_original: bool, well_formed: bool, reject_reg: Option<&str>, ) -> Result<Self>

Create a new Text model from input text

§Arguments
  • input_text - The source text to build the model from
  • state_size - Number of words in the model’s state (default: 2)
  • retain_original - Whether to keep the original corpus for overlap checking
  • well_formed - Whether to reject sentences with unmatched quotes/parenthesis
  • reject_reg - Optional custom regex pattern for rejecting sentences
Source

pub fn from_chain( chain: Chain, parsed_sentences: Option<Vec<Vec<String>>>, retain_original: bool, ) -> Self

Create a Text model from an existing chain

Source

pub fn sentence_split(&self, text: &str) -> Vec<String>

Split text into sentences

Source

pub fn sentence_join(&self, sentences: &[String]) -> String

Join sentences into text

Source

pub fn word_split(&self, sentence: &str) -> Vec<String>

Split a sentence into words

Source

pub fn word_join(&self, words: &[String]) -> String

Join words into a sentence

Source

pub fn test_sentence_input(&self, sentence: &str) -> bool

Test if a sentence input is valid

Source

pub fn make_sentence( &self, init_state: Option<&[String]>, tries: Option<usize>, max_overlap_ratio: Option<f64>, max_overlap_total: Option<usize>, test_output: Option<bool>, max_words: Option<usize>, min_words: Option<usize>, ) -> Option<String>

Generate a random sentence

§Arguments
  • init_state - Optional starting state (tuple of words)
  • tries - Maximum number of attempts (default: 10)
  • max_overlap_ratio - Maximum overlap ratio with original text (default: 0.7)
  • max_overlap_total - Maximum overlap total with original text (default: 15)
  • test_output - Whether to test output for overlap (default: true)
  • max_words - Maximum number of words in the sentence
  • min_words - Minimum number of words in the sentence
Source

pub fn make_short_sentence( &self, max_chars: usize, min_chars: Option<usize>, init_state: Option<&[String]>, tries: Option<usize>, max_overlap_ratio: Option<f64>, max_overlap_total: Option<usize>, test_output: Option<bool>, max_words: Option<usize>, min_words: Option<usize>, ) -> Option<String>

Generate a short sentence with a maximum character count

Source

pub fn make_sentence_with_start( &self, beginning: &str, strict: bool, tries: Option<usize>, max_overlap_ratio: Option<f64>, max_overlap_total: Option<usize>, test_output: Option<bool>, max_words: Option<usize>, min_words: Option<usize>, ) -> Result<String>

Generate a sentence that starts with a specific string

Source

pub fn compile(&self) -> Self

Compile the model for faster generation

Source

pub fn compile_inplace(&mut self)

Compile the model in place (returns self)

Source

pub fn state_size(&self) -> usize

Get the state size

Source

pub fn chain(&self) -> &Chain

Get the chain

Source

pub fn to_json(&self) -> Result<String>

Serialize to JSON

Source

pub fn from_json(json_str: &str) -> Result<Self>

Deserialize from JSON

Source

pub fn retain_original(&self) -> bool

Check if the model retains original sentences

Source

pub fn parsed_sentences(&self) -> Option<&Vec<Vec<String>>>

Get the parsed sentences if available

Trait Implementations§

Source§

impl Clone for Text

Source§

fn clone(&self) -> Text

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Text

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Text

§

impl RefUnwindSafe for Text

§

impl Send for Text

§

impl Sync for Text

§

impl Unpin for Text

§

impl UnsafeUnpin for Text

§

impl UnwindSafe for Text

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> 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> 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V