Struct SequenceConstraint 

pub struct SequenceConstraint { /* private fields */ }

A constraint that forces the generated output to reproduce a specific, pre-determined token sequence.

While position < target.len(), only target[position] is allowed. Once the target has been fully reproduced (position >= target.len()) the constraint is satisfied and all tokens become allowed again (returns None).

Example

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

let mut c = SequenceConstraint::new(vec![5, 6, 7]);
let mask = c.allowed_tokens(&[], 10).unwrap();
assert!(mask[5]);
assert!(!mask[6]);
assert_eq!(c.advance(5), true);

Implementations

impl SequenceConstraint

pub fn new(target: Vec<u32>) -> Self

Create a new SequenceConstraint for the given target sequence.

pub fn is_failed(&self) -> bool

Whether the constraint has been violated (a wrong token was committed).

Trait Implementations

impl TokenConstraint for SequenceConstraint

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

Returns a bitmask allowing only the next expected token, or None once the full sequence has been reproduced.

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

Commits token. Returns false (and sets the failed flag) if token does not match the expected token at the current position.

fn is_complete(&self) -> bool

Returns true once all tokens in the target sequence have been consumed.

fn reset(&mut self)

Reset to initial state.

fn name(&self) -> &str

Human-readable name for debugging and logging.