Skip to main content

VsaConfigSchema

Struct VsaConfigSchema 

Source
pub struct VsaConfigSchema {
    pub dimension: usize,
    pub density: f64,
    pub scaling: Option<SparsityScaling>,
    pub auto_thin: Option<usize>,
    pub min_nnz: Option<usize>,
    pub max_nnz: Option<usize>,
    pub target_accuracy: Option<f64>,
}
Expand description

User-provided schema for custom VSA configuration

This allows users to specify their own parameters for specialized use cases without needing to understand the internal scaling formulas.

§Example

use embeddenator_vsa::{VsaConfig, VsaConfigSchema, SparsityScaling};

// Custom schema for a specific application
let schema = VsaConfigSchema {
    dimension: 8192,
    density: 0.015,
    scaling: Some(SparsityScaling::SquareRoot),
    auto_thin: Some(1000),
    min_nnz: Some(16),
    max_nnz: Some(512),
    target_accuracy: Some(0.97),
};

let config = VsaConfig::from_schema(schema);
assert_eq!(config.dimension, 8192);

Fields§

§dimension: usize

Required: Number of dimensions

§density: f64

Required: Target density (0.0-1.0)

§scaling: Option<SparsityScaling>

Optional: Sparsity scaling mode

§auto_thin: Option<usize>

Optional: Auto-thinning threshold (0 to disable)

§min_nnz: Option<usize>

Optional: Minimum non-zero elements

§max_nnz: Option<usize>

Optional: Maximum non-zero elements

§target_accuracy: Option<f64>

Optional: Target reconstruction accuracy

Implementations§

Source§

impl VsaConfigSchema

Source

pub fn new(dimension: usize, density: f64) -> Self

Create a minimal schema with just dimension and density

Source

pub fn with_scaling(self, mode: SparsityScaling) -> Self

Set scaling mode

Source

pub fn with_auto_thin(self, threshold: usize) -> Self

Set auto-thin threshold

Source

pub fn from_json(json: &str) -> Result<Self, Error>

Parse from JSON string

Source

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

Serialize to JSON string

Trait Implementations§

Source§

impl Clone for VsaConfigSchema

Source§

fn clone(&self) -> VsaConfigSchema

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 VsaConfigSchema

Source§

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

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

impl<'de> Deserialize<'de> for VsaConfigSchema

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for VsaConfigSchema

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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, 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> 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> Same for T

Source§

type Output = T

Should always be Self
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

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,