uor-foundation 0.3.0

UOR Foundation — typed Rust traits for the complete ontology. Import and implement.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

// @generated by uor-crate from uor-ontology — do not edit manually

//! `linear/` namespace — Linear discipline on site consumption. Formalizes that each site in a complete resolution path is targeted by exactly one effect..
//!
//! Space: Kernel

use crate::HostTypes;

/// A site index annotated with a linearity constraint: must be pinned exactly once in any complete resolution path.
pub trait LinearSite<H: HostTypes>: crate::bridge::partition::SiteIndex<H> {}

/// A PinningEffect that consumes its target LinearSite. After application, the site is no longer available for pinning by any subsequent effect.
pub trait LinearEffect<H: HostTypes>: crate::kernel::effect::PinningEffect<H> {
    /// Associated type for `LinearSite`.
    type LinearSite: LinearSite<H>;
    /// The single site consumed by this effect.
    fn linear_target(&self) -> &Self::LinearSite;
}

/// A computation trace where every site in the budget is targeted by exactly one LinearEffect.
pub trait LinearTrace<H: HostTypes>: crate::bridge::trace::ComputationTrace<H> {}

/// The multiset of LinearSites available at a given point in resolution. Starts as the full site budget; each LinearEffect removes exactly one element.
pub trait LinearBudget<H: HostTypes> {
    /// Associated type for `LinearSite`.
    type LinearSite: LinearSite<H>;
    /// The sites remaining in the budget.
    fn budget_sites(&self) -> &[Self::LinearSite];
    /// Associated type for `Context`.
    type Context: crate::user::state::Context<H>;
    /// The context associated with this budget state.
    fn budget_context(&self) -> &Self::Context;
    /// Number of unconsumed sites. Equals freeRank on the associated context.
    fn remaining_count(&self) -> u64;
    /// The stack budget available at the call site in bytes. On embedded targets this is compile-time-known; on std targets it is computed from the thread-local stack frame. Consumed by the MultiplicationResolver to bound the admissible Toom-Cook splitting factor R: deeper recursion requires more stack, so R is capped where stack would overflow.
    fn stack_budget_bytes(&self) -> u64;
}

/// A binding between a state:ContextLease and a subset of LinearSites. Formalizes what resources a lease claims.
pub trait LeaseAllocation<H: HostTypes> {
    /// Associated type for `LinearSite`.
    type LinearSite: LinearSite<H>;
    /// The sites claimed by this lease.
    fn lease_target(&self) -> &[Self::LinearSite];
    /// Associated type for `ContextLease`.
    type ContextLease: crate::user::state::ContextLease<H>;
    /// The ContextLease individual that owns this allocation.
    fn lease_source(&self) -> &Self::ContextLease;
    /// Number of sites claimed by this lease.
    fn lease_cardinality(&self) -> u64;
}

/// A site that may be pinned at most once (but need not be pinned). Relaxation of LinearSite for incomplete resolution paths.
pub trait AffineSite<H: HostTypes>: crate::bridge::partition::SiteIndex<H> {}