Skip to main content

TextEncoder

Struct TextEncoder 

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

Deterministic text-to-hypervector encoder using HDC principles.

Produces consistent HVec10240 vectors from text input without external dependencies. The encoding is:

  • Deterministic: Same input always produces same output
  • Similarity-preserving: Similar texts produce similar vectors
  • WASM-compatible: No external dependencies

Implementations§

Source§

impl TextEncoder

Source

pub fn new() -> Self

Create a new encoder with default configuration.

Source

pub const fn with_config(config: TextEncoderConfig) -> Self

Create an encoder with custom configuration.

Source

pub fn new_code_aware() -> Self

Create a code-aware encoder with character trigram overlay. This is the recommended configuration for CLI memory-context integration.

Source

pub const fn config(&self) -> &TextEncoderConfig

Get the encoder configuration.

Source

pub fn encode(&self, text: &str) -> HVec10240

Encode text into a hypervector.

The encoding process:

  1. Tokenize (whitespace split, optional lowercase, optional code-aware)
  2. Generate deterministic base vector for each token
  3. Apply position encoding via permutation
  4. Bundle all position-encoded vectors
  5. Optionally add n-gram overlay
Source

pub fn encode_with_ngrams(&self, text: &str, n: usize) -> HVec10240

Encode text with character n-grams for typo robustness.

This is equivalent to setting ngram_size in the config.

Source

pub fn tokenize(text: &str, code_aware: bool, lowercase: bool) -> Vec<String>

Tokenize text into a vector of tokens.

This is a convenience function for reuse by other modules that need tokenization consistent with the encoder’s logic.

§Arguments
  • text - Input text to tokenize
  • code_aware - Enable code-aware splitting (on _, -, ., /, ::)
  • lowercase - Convert tokens to lowercase

Trait Implementations§

Source§

impl Clone for TextEncoder

Source§

fn clone(&self) -> TextEncoder

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

impl Debug for TextEncoder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TextEncoder

Source§

fn default() -> TextEncoder

Returns the “default value” for a type. 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> 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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more