Skip to main content

AllowedSet

Enum AllowedSet 

Source
pub enum AllowedSet {
    Only(BTreeSet<u32>),
    Mask(Vec<bool>),
}
Expand description

Which next-token ids a constraint permits at the current step.

Two shapes, because two very different constraints want very different storage:

  • AllowedSet::Only — a sparse set: “only these handful of ids, mask everything else”. Right for a fixed tool-name enum over a 150k vocab, where listing the allowed ids is far cheaper than a 150k-entry bool vector.
  • AllowedSet::Mask — a dense allow-mask, one bool per vocab id. Right for a structural constraint that has to test every candidate token anyway (see JsonStructure::allowed), so the per-id answer is already computed.

Variants§

§

Only(BTreeSet<u32>)

Only these ids are allowed; every other id is masked.

§

Mask(Vec<bool>)

One bool per vocab id: mask[id] allowed iff true. An id past the end of the vector is treated as not allowed.

Implementations§

Source§

impl AllowedSet

Source

pub fn contains(&self, id: u32) -> bool

Is token id allowed by this set?

For AllowedSet::Mask, an id at or past the mask length is not allowed — a mask sized to a smaller vocab than the logits row can never accidentally green-light a token it never considered.

Trait Implementations§

Source§

impl Clone for AllowedSet

Source§

fn clone(&self) -> AllowedSet

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 AllowedSet

Source§

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

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

impl Eq for AllowedSet

Source§

impl PartialEq for AllowedSet

Source§

fn eq(&self, other: &AllowedSet) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for AllowedSet

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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.