uor-foundation 0.3.4

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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
// @generated by uor-crate from uor-ontology — do not edit manually

//! `monoidal/` namespace — Sequential composition of computations via monoidal product A ⊗ B..
//!
//! Space: Kernel

use crate::HostTypes;

/// A ⊗ B: the sequential composition of two computations. Output of A feeds input of B.
pub trait MonoidalProduct<H: HostTypes> {
    /// Associated type for `ComputationDatum`.
    type ComputationDatum: crate::user::morphism::ComputationDatum<H>;
    /// The left operand in the monoidal product A ⊗ B.
    fn left_operand(&self) -> &Self::ComputationDatum;
    /// The right operand in the monoidal product A ⊗ B.
    fn right_operand(&self) -> &Self::ComputationDatum;
    /// Associated type for `Datum`.
    type Datum: crate::kernel::schema::Datum<H>;
    /// The result datum of the composed computation A ⊗ B.
    fn composed_result(&self) -> &Self::Datum;
    /// σ(A⊗B) relationship: saturation of the sequential composition.
    fn saturation_value(&self) -> H::Decimal;
}

/// The identity computation I: passes input through unchanged. I ⊗ A ≅ A ≅ A ⊗ I.
pub trait MonoidalUnit<H: HostTypes> {
    /// Associated type for `Certificate`.
    type Certificate: crate::bridge::cert::Certificate<H>;
    /// Certificate witnessing I ⊗ A ≅ A ≅ A ⊗ I.
    fn unit_witness_ref(&self) -> &Self::Certificate;
}

/// The witness that (A⊗B)⊗C ≅ A⊗(B⊗C). The associativity isomorphism.
pub trait MonoidalAssociator<H: HostTypes> {
    /// Associated type for `MonoidalProduct`.
    type MonoidalProduct: MonoidalProduct<H>;
    /// The left-grouped product (A⊗B)⊗C.
    fn associator_left(&self) -> &Self::MonoidalProduct;
    /// The right-grouped product A⊗(B⊗C).
    fn associator_right(&self) -> &Self::MonoidalProduct;
    /// Associated type for `Certificate`.
    type Certificate: crate::bridge::cert::Certificate<H>;
    /// Certificate witnessing the associativity isomorphism (A⊗B)⊗C ≅ A⊗(B⊗C).
    fn associator_witness_ref(&self) -> &Self::Certificate;
}

#[doc(hidden)]
#[doc = "THEORY-DEFERRED \u{2014} not a valid implementation; see [docs/theory_deferred.md]. Exists only to satisfy downstream trait-bound references."]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct NullMonoidalProduct<H: HostTypes> {
    _phantom: core::marker::PhantomData<H>,
}
impl<H: HostTypes> Default for NullMonoidalProduct<H> {
    fn default() -> Self {
        Self {
            _phantom: core::marker::PhantomData,
        }
    }
}
impl<H: HostTypes> NullMonoidalProduct<H> {
    /// Absent-value sentinel. `&Self::ABSENT` gives every trait-typed accessor a `'static`-lifetime reference target.
    pub const ABSENT: NullMonoidalProduct<H> = NullMonoidalProduct {
        _phantom: core::marker::PhantomData,
    };
}
impl<H: HostTypes> MonoidalProduct<H> for NullMonoidalProduct<H> {
    type ComputationDatum = crate::user::morphism::NullComputationDatum<H>;
    fn left_operand(&self) -> &Self::ComputationDatum {
        &<crate::user::morphism::NullComputationDatum<H>>::ABSENT
    }
    fn right_operand(&self) -> &Self::ComputationDatum {
        &<crate::user::morphism::NullComputationDatum<H>>::ABSENT
    }
    type Datum = crate::kernel::schema::NullDatum<H>;
    fn composed_result(&self) -> &Self::Datum {
        &<crate::kernel::schema::NullDatum<H>>::ABSENT
    }
    fn saturation_value(&self) -> H::Decimal {
        H::EMPTY_DECIMAL
    }
}

/// Phase 2 (orphan-closure) — resolver-absent default impl of `MonoidalUnit<H>`.
/// Every accessor returns `H::EMPTY_*` sentinels (for scalar / host-typed
/// returns) or a `'static`-lifetime reference to a sibling `Null*`'s `ABSENT`
/// const (for trait-typed returns).  Downstream provides concrete impls;
/// this stub closes the ontology-derived trait orphan.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct NullMonoidalUnit<H: HostTypes> {
    _phantom: core::marker::PhantomData<H>,
}
impl<H: HostTypes> Default for NullMonoidalUnit<H> {
    fn default() -> Self {
        Self {
            _phantom: core::marker::PhantomData,
        }
    }
}
impl<H: HostTypes> NullMonoidalUnit<H> {
    /// Absent-value sentinel. `&Self::ABSENT` gives every trait-typed accessor a `'static`-lifetime reference target.
    pub const ABSENT: NullMonoidalUnit<H> = NullMonoidalUnit {
        _phantom: core::marker::PhantomData,
    };
}
impl<H: HostTypes> MonoidalUnit<H> for NullMonoidalUnit<H> {
    type Certificate = crate::bridge::cert::NullCertificate<H>;
    fn unit_witness_ref(&self) -> &Self::Certificate {
        &<crate::bridge::cert::NullCertificate<H>>::ABSENT
    }
}

/// Phase 2 (orphan-closure) — resolver-absent default impl of `MonoidalAssociator<H>`.
/// Every accessor returns `H::EMPTY_*` sentinels (for scalar / host-typed
/// returns) or a `'static`-lifetime reference to a sibling `Null*`'s `ABSENT`
/// const (for trait-typed returns).  Downstream provides concrete impls;
/// this stub closes the ontology-derived trait orphan.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct NullMonoidalAssociator<H: HostTypes> {
    _phantom: core::marker::PhantomData<H>,
}
impl<H: HostTypes> Default for NullMonoidalAssociator<H> {
    fn default() -> Self {
        Self {
            _phantom: core::marker::PhantomData,
        }
    }
}
impl<H: HostTypes> NullMonoidalAssociator<H> {
    /// Absent-value sentinel. `&Self::ABSENT` gives every trait-typed accessor a `'static`-lifetime reference target.
    pub const ABSENT: NullMonoidalAssociator<H> = NullMonoidalAssociator {
        _phantom: core::marker::PhantomData,
    };
}
impl<H: HostTypes> MonoidalAssociator<H> for NullMonoidalAssociator<H> {
    type MonoidalProduct = NullMonoidalProduct<H>;
    fn associator_left(&self) -> &Self::MonoidalProduct {
        &<NullMonoidalProduct<H>>::ABSENT
    }
    fn associator_right(&self) -> &Self::MonoidalProduct {
        &<NullMonoidalProduct<H>>::ABSENT
    }
    type Certificate = crate::bridge::cert::NullCertificate<H>;
    fn associator_witness_ref(&self) -> &Self::Certificate {
        &<crate::bridge::cert::NullCertificate<H>>::ABSENT
    }
}

/// Phase 8 (orphan-closure) — content-addressed handle for `MonoidalUnit<H>`.
///
/// Pairs a [`crate::enforcement::ContentFingerprint`] with a phantom
/// `H` so type-state checks can't mix handles across `HostTypes` impls.
#[derive(Debug)]
pub struct MonoidalUnitHandle<H: HostTypes> {
    /// Content fingerprint identifying the resolved record.
    pub fingerprint: crate::enforcement::ContentFingerprint,
    _phantom: core::marker::PhantomData<H>,
}
impl<H: HostTypes> Copy for MonoidalUnitHandle<H> {}
impl<H: HostTypes> Clone for MonoidalUnitHandle<H> {
    #[inline]
    fn clone(&self) -> Self {
        *self
    }
}
impl<H: HostTypes> PartialEq for MonoidalUnitHandle<H> {
    #[inline]
    fn eq(&self, other: &Self) -> bool {
        self.fingerprint == other.fingerprint
    }
}
impl<H: HostTypes> Eq for MonoidalUnitHandle<H> {}
impl<H: HostTypes> core::hash::Hash for MonoidalUnitHandle<H> {
    #[inline]
    fn hash<S: core::hash::Hasher>(&self, state: &mut S) {
        self.fingerprint.hash(state);
    }
}
impl<H: HostTypes> MonoidalUnitHandle<H> {
    /// Construct a handle from its content fingerprint.
    #[inline]
    #[must_use]
    pub const fn new(fingerprint: crate::enforcement::ContentFingerprint) -> Self {
        Self {
            fingerprint,
            _phantom: core::marker::PhantomData,
        }
    }
}

/// Phase 8 (orphan-closure) — resolver trait for `MonoidalUnit<H>`.
///
/// Hosts implement this trait to map a handle into a typed record.
/// The default Null stub does not implement this trait — it carries
/// no record. Resolution is the responsibility of the host pipeline.
pub trait MonoidalUnitResolver<H: HostTypes> {
    /// Resolve a handle into its record. Returns `None` when the
    /// handle does not correspond to known content.
    fn resolve(&self, handle: MonoidalUnitHandle<H>) -> Option<MonoidalUnitRecord<H>>;
}

/// Phase 8 (orphan-closure) — typed record for `MonoidalUnit<H>`.
///
/// Carries a field per functional accessor of the trait. Object
/// fields hold `{Range}Handle<H>`; iterate via the Resolved wrapper
/// chain-resolver methods.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct MonoidalUnitRecord<H: HostTypes> {
    pub unit_witness_ref_handle: crate::bridge::cert::CertificateHandle<H>,
    #[doc(hidden)]
    pub _phantom: core::marker::PhantomData<H>,
}

/// Phase 8 (orphan-closure) — content-addressed wrapper for `MonoidalUnit<H>`.
///
/// Caches the resolver's lookup at construction. Accessors return
/// the cached record's fields when present, falling back to the
/// `Null{Class}<H>` absent sentinels when the resolver returned
/// `None`. Object accessors always return absent sentinels — use
/// the `resolve_{m}` chain methods to descend into sub-records.
pub struct ResolvedMonoidalUnit<'r, R: MonoidalUnitResolver<H>, H: HostTypes> {
    handle: MonoidalUnitHandle<H>,
    resolver: &'r R,
    record: Option<MonoidalUnitRecord<H>>,
}
impl<'r, R: MonoidalUnitResolver<H>, H: HostTypes> ResolvedMonoidalUnit<'r, R, H> {
    /// Construct the wrapper, eagerly resolving the handle.
    #[inline]
    pub fn new(handle: MonoidalUnitHandle<H>, resolver: &'r R) -> Self {
        let record = resolver.resolve(handle);
        Self {
            handle,
            resolver,
            record,
        }
    }
    /// The handle this wrapper resolves.
    #[inline]
    #[must_use]
    pub const fn handle(&self) -> MonoidalUnitHandle<H> {
        self.handle
    }
    /// The resolver supplied at construction.
    #[inline]
    #[must_use]
    pub const fn resolver(&self) -> &'r R {
        self.resolver
    }
    /// The cached record, or `None` when the resolver returned `None`.
    #[inline]
    #[must_use]
    pub const fn record(&self) -> Option<&MonoidalUnitRecord<H>> {
        self.record.as_ref()
    }
}
impl<'r, R: MonoidalUnitResolver<H>, H: HostTypes> MonoidalUnit<H>
    for ResolvedMonoidalUnit<'r, R, H>
{
    type Certificate = crate::bridge::cert::NullCertificate<H>;
    fn unit_witness_ref(&self) -> &Self::Certificate {
        &<crate::bridge::cert::NullCertificate<H>>::ABSENT
    }
}
impl<'r, R: MonoidalUnitResolver<H>, H: HostTypes> ResolvedMonoidalUnit<'r, R, H> {
    /// Promote the `unit_witness_ref` handle on the cached record into a
    /// resolved wrapper, given a resolver for the range class.
    /// Returns `None` if no record was resolved at construction.
    #[inline]
    pub fn resolve_unit_witness_ref<'r2, R2: crate::bridge::cert::CertificateResolver<H>>(
        &self,
        r: &'r2 R2,
    ) -> Option<crate::bridge::cert::ResolvedCertificate<'r2, R2, H>> {
        let record = self.record.as_ref()?;
        Some(crate::bridge::cert::ResolvedCertificate::new(
            record.unit_witness_ref_handle,
            r,
        ))
    }
}

/// Phase 8 (orphan-closure) — content-addressed handle for `MonoidalAssociator<H>`.
///
/// Pairs a [`crate::enforcement::ContentFingerprint`] with a phantom
/// `H` so type-state checks can't mix handles across `HostTypes` impls.
#[derive(Debug)]
pub struct MonoidalAssociatorHandle<H: HostTypes> {
    /// Content fingerprint identifying the resolved record.
    pub fingerprint: crate::enforcement::ContentFingerprint,
    _phantom: core::marker::PhantomData<H>,
}
impl<H: HostTypes> Copy for MonoidalAssociatorHandle<H> {}
impl<H: HostTypes> Clone for MonoidalAssociatorHandle<H> {
    #[inline]
    fn clone(&self) -> Self {
        *self
    }
}
impl<H: HostTypes> PartialEq for MonoidalAssociatorHandle<H> {
    #[inline]
    fn eq(&self, other: &Self) -> bool {
        self.fingerprint == other.fingerprint
    }
}
impl<H: HostTypes> Eq for MonoidalAssociatorHandle<H> {}
impl<H: HostTypes> core::hash::Hash for MonoidalAssociatorHandle<H> {
    #[inline]
    fn hash<S: core::hash::Hasher>(&self, state: &mut S) {
        self.fingerprint.hash(state);
    }
}
impl<H: HostTypes> MonoidalAssociatorHandle<H> {
    /// Construct a handle from its content fingerprint.
    #[inline]
    #[must_use]
    pub const fn new(fingerprint: crate::enforcement::ContentFingerprint) -> Self {
        Self {
            fingerprint,
            _phantom: core::marker::PhantomData,
        }
    }
}

/// Phase 8 (orphan-closure) — resolver trait for `MonoidalAssociator<H>`.
///
/// Hosts implement this trait to map a handle into a typed record.
/// The default Null stub does not implement this trait — it carries
/// no record. Resolution is the responsibility of the host pipeline.
pub trait MonoidalAssociatorResolver<H: HostTypes> {
    /// Resolve a handle into its record. Returns `None` when the
    /// handle does not correspond to known content.
    fn resolve(&self, handle: MonoidalAssociatorHandle<H>) -> Option<MonoidalAssociatorRecord<H>>;
}

/// Phase 8 (orphan-closure) — typed record for `MonoidalAssociator<H>`.
///
/// Carries a field per functional accessor of the trait. Object
/// fields hold `{Range}Handle<H>`; iterate via the Resolved wrapper
/// chain-resolver methods.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct MonoidalAssociatorRecord<H: HostTypes> {
    pub associator_witness_ref_handle: crate::bridge::cert::CertificateHandle<H>,
    #[doc(hidden)]
    pub _phantom: core::marker::PhantomData<H>,
}

/// Phase 8 (orphan-closure) — content-addressed wrapper for `MonoidalAssociator<H>`.
///
/// Caches the resolver's lookup at construction. Accessors return
/// the cached record's fields when present, falling back to the
/// `Null{Class}<H>` absent sentinels when the resolver returned
/// `None`. Object accessors always return absent sentinels — use
/// the `resolve_{m}` chain methods to descend into sub-records.
pub struct ResolvedMonoidalAssociator<'r, R: MonoidalAssociatorResolver<H>, H: HostTypes> {
    handle: MonoidalAssociatorHandle<H>,
    resolver: &'r R,
    record: Option<MonoidalAssociatorRecord<H>>,
}
impl<'r, R: MonoidalAssociatorResolver<H>, H: HostTypes> ResolvedMonoidalAssociator<'r, R, H> {
    /// Construct the wrapper, eagerly resolving the handle.
    #[inline]
    pub fn new(handle: MonoidalAssociatorHandle<H>, resolver: &'r R) -> Self {
        let record = resolver.resolve(handle);
        Self {
            handle,
            resolver,
            record,
        }
    }
    /// The handle this wrapper resolves.
    #[inline]
    #[must_use]
    pub const fn handle(&self) -> MonoidalAssociatorHandle<H> {
        self.handle
    }
    /// The resolver supplied at construction.
    #[inline]
    #[must_use]
    pub const fn resolver(&self) -> &'r R {
        self.resolver
    }
    /// The cached record, or `None` when the resolver returned `None`.
    #[inline]
    #[must_use]
    pub const fn record(&self) -> Option<&MonoidalAssociatorRecord<H>> {
        self.record.as_ref()
    }
}
impl<'r, R: MonoidalAssociatorResolver<H>, H: HostTypes> MonoidalAssociator<H>
    for ResolvedMonoidalAssociator<'r, R, H>
{
    type MonoidalProduct = NullMonoidalProduct<H>;
    fn associator_left(&self) -> &Self::MonoidalProduct {
        &<NullMonoidalProduct<H>>::ABSENT
    }
    fn associator_right(&self) -> &Self::MonoidalProduct {
        &<NullMonoidalProduct<H>>::ABSENT
    }
    type Certificate = crate::bridge::cert::NullCertificate<H>;
    fn associator_witness_ref(&self) -> &Self::Certificate {
        &<crate::bridge::cert::NullCertificate<H>>::ABSENT
    }
}
impl<'r, R: MonoidalAssociatorResolver<H>, H: HostTypes> ResolvedMonoidalAssociator<'r, R, H> {
    /// Promote the `associator_witness_ref` handle on the cached record into a
    /// resolved wrapper, given a resolver for the range class.
    /// Returns `None` if no record was resolved at construction.
    #[inline]
    pub fn resolve_associator_witness_ref<'r2, R2: crate::bridge::cert::CertificateResolver<H>>(
        &self,
        r: &'r2 R2,
    ) -> Option<crate::bridge::cert::ResolvedCertificate<'r2, R2, H>> {
        let record = self.record.as_ref()?;
        Some(crate::bridge::cert::ResolvedCertificate::new(
            record.associator_witness_ref_handle,
            r,
        ))
    }
}