Skip to main content

LengthConstraint

Struct LengthConstraint 

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

A constraint that enforces hard minimum and maximum token-count limits.

  • While count < min_len: if a stop_token is configured it is excluded from the mask (cannot stop early).
  • While count >= max_len: if a stop_token is configured only that token is allowed; otherwise an all-false mask is returned, signalling the caller to halt generation externally.
  • Between min_len and max_len: all tokens are allowed (None).

Completion is defined as either reaching max_len OR generating min_len or more tokens followed by the stop_token.

§Example

use oxibonsai_runtime::constrained_decoding::{LengthConstraint, TokenConstraint};

// Must generate at least 2 tokens, stop token is 1 (EOS), max 10.
let mut c = LengthConstraint::new(2, 10, Some(1));
// Before min_len: stop_token excluded
let mask = c.allowed_tokens(&[], 4).unwrap();
assert!(!mask[1]);  // stop token blocked
assert!(mask[0]);   // other tokens allowed

Implementations§

Source§

impl LengthConstraint

Source

pub fn new(min_len: usize, max_len: usize, stop_token: Option<u32>) -> Self

Create a new LengthConstraint.

min_len must be <= max_len.

Source

pub fn count(&self) -> usize

Current token count.

Trait Implementations§

Source§

impl TokenConstraint for LengthConstraint

Source§

fn advance(&mut self, token: u32) -> bool

Commits token, updating count and stop_seen. Always returns true.

Source§

fn is_complete(&self) -> bool

Returns true when at least min_len tokens have been generated AND either the stop_token was seen or max_len has been reached.

Source§

fn reset(&mut self)

Reset to initial state.

Source§

fn allowed_tokens( &self, _generated: &[u32], vocab_size: usize, ) -> Option<Vec<bool>>

Given the tokens generated so far, return a bitmask of allowed next tokens. Read more
Source§

fn name(&self) -> &str

Human-readable name for debugging and logging.

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

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,