Skip to main content

BoxEmbedding

Struct BoxEmbedding 

Source
pub struct BoxEmbedding {
    pub min: Vec<f32>,
    pub max: Vec<f32>,
}
Expand description

A box embedding representing an entity in d-dimensional space.

Boxes are axis-aligned hyperrectangles defined by min/max bounds in each dimension. Coreference is modeled as high mutual conditional probability (overlap).

Fields§

§min: Vec<f32>

Lower bound in each dimension (d-dimensional vector).

§max: Vec<f32>

Upper bound in each dimension (d-dimensional vector).

Implementations§

Source§

impl BoxEmbedding

Source

pub fn new(min: Vec<f32>, max: Vec<f32>) -> Self

Create a new box embedding.

§Panics

Panics if min.len() != max.len() or if any min[i] > max[i].

Source

pub fn dim(&self) -> usize

Get the dimension of the box.

Source

pub fn volume(&self) -> f32

Compute the volume of the box.

Volume = product of (max - min) for each dimension.

Source

pub fn intersection_volume(&self, other: &Self) -> f32

Compute the intersection volume with another box.

Returns 0.0 if boxes are disjoint.

Source

pub fn conditional_probability(&self, other: &Self) -> f32

Compute conditional probability P(self | other).

This is the BERE model’s coreference metric: P(A|B) = Vol(A ∩ B) / Vol(B)

Returns a value in [0.0, 1.0] where:

  • 1.0 = self is completely contained in other
  • 0.0 = boxes are disjoint
Source

pub fn coreference_score(&self, other: &Self) -> f32

Compute mutual coreference score.

Coreference requires high mutual conditional probability: score = (P(A|B) + P(B|A)) / 2

This ensures both boxes largely contain each other (high overlap).

Source

pub fn is_contained_in(&self, other: &Self) -> bool

Check if this box is contained in another box.

Returns true if self ⊆ other (all dimensions).

Source

pub fn is_disjoint(&self, other: &Self) -> bool

Check if boxes are disjoint (no overlap).

Source

pub fn from_vector(vector: &[f32], radius: f32) -> Self

Create a box embedding from a vector embedding.

Converts a point embedding to a box by creating a small hypercube around the point. The box size is controlled by radius.

§Arguments
  • vector - Vector embedding (point in space)
  • radius - Half-width of the box in each dimension
§Example
let vector = vec![0.5, 0.5, 0.5];
let box_embedding = BoxEmbedding::from_vector(&vector, 0.1);
// Creates box: min=[0.4, 0.4, 0.4], max=[0.6, 0.6, 0.6]
Source

pub fn from_vector_adaptive(vector: &[f32], radius_factor: f32) -> Self

Create a box embedding from a vector with adaptive radius.

Uses a radius proportional to the vector’s magnitude, creating larger boxes for vectors further from the origin.

§Arguments
  • vector - Vector embedding
  • radius_factor - Multiplier for adaptive radius (default: 0.1)
Source

pub fn center(&self) -> Vec<f32>

Get the center point of the box.

Returns the midpoint in each dimension.

Source

pub fn size(&self) -> Vec<f32>

Get the size (width) in each dimension.

Source

pub fn intersection(&self, other: &Self) -> Self

Compute the intersection box with another box.

Returns a new box representing the overlapping region. If boxes are disjoint, returns a zero-volume box.

Source

pub fn union(&self, other: &Self) -> Self

Compute the union box (bounding box containing both).

Source

pub fn overlap_prob(&self, other: &Self) -> f32

Compute overlap probability (Jaccard-style).

P(overlap) = Vol(intersection) / Vol(union)

Source

pub fn distance(&self, other: &Self) -> f32

Compute minimum Euclidean distance between two boxes.

Returns 0.0 if boxes overlap.

Trait Implementations§

Source§

impl Clone for BoxEmbedding

Source§

fn clone(&self) -> BoxEmbedding

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 BoxEmbedding

Source§

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

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

impl<'de> Deserialize<'de> for BoxEmbedding

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 PartialEq for BoxEmbedding

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for BoxEmbedding

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

impl StructuralPartialEq for BoxEmbedding

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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> 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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,