Skip to main content

deep_causality_context/
lib.rs

1/*
2 * SPDX-License-Identifier: MIT
3 * Copyright (c) 2023 - 2026. The DeepCausality Authors and Contributors. All Rights Reserved.
4 */
5
6//! The context layer of DeepCausality.
7//!
8//! A causal model reasons about something, and that something is the context: an explicit, typed
9//! environment that a causaloid or a causal-monad chain reads while it runs. This crate owns that
10//! environment — the [`Context`] hypergraph, the [`Contextoid`] nodes it holds, the node types for
11//! data, space, time, spacetime and symbols, and the traits that describe them.
12//!
13//! Context is a separate crate so that it is an opt-in dependency. Reasoning without context is the
14//! default case and costs nothing; a model that needs context declares this crate and imports from
15//! it, which keeps a dependency search honest about where context is used.
16//!
17//! Because this crate sits beside `deep_causality` rather than above it, a consumer of the causal
18//! monad can carry a typed context without depending on the causaloid stack:
19//!
20//! ```
21//! use deep_causality_context::BaseContext;
22//! use deep_causality_core::{PropagatingEffect, PropagatingProcess};
23//!
24//! let ctx = BaseContext::with_capacity(1, "demo", 10);
25//! let process: PropagatingProcess<f64, (), BaseContext> =
26//!     PropagatingProcess::with_state(PropagatingEffect::pure(1.0), (), Some(ctx));
27//! ```
28//!
29//! See <https://docs.deepcausality.com/> for the documentation.
30
31#![cfg_attr(not(feature = "std"), no_std)]
32
33extern crate alloc;
34
35mod alias;
36mod errors;
37mod extensions;
38mod traits;
39mod types;
40mod utils;
41pub mod utils_test;
42
43//
44// Aliases
45//
46pub use crate::alias::*;
47//
48// Error types
49//
50pub use crate::errors::*;
51//
52// Traits
53//
54// Adjustable Traits
55pub use crate::traits::adjustable::{Adjustable, UncertainAdjustable};
56// Contextuable Traits
57pub use crate::traits::contextuable::Contextuable;
58pub use crate::traits::contextuable::coordinate::Coordinate;
59pub use crate::traits::contextuable::datable::Datable;
60pub use crate::traits::contextuable::datable_uncertain::UncertainDatable;
61pub use crate::traits::contextuable::distance::Distance;
62pub use crate::traits::contextuable::metric_signature::MetricSignature;
63pub use crate::traits::contextuable::metric_tensor::MetricTensor4D;
64pub use crate::traits::contextuable::space_temporal::SpaceTemporal;
65pub use crate::traits::contextuable::space_temporal::SpaceTemporalInterval;
66pub use crate::traits::contextuable::spatial::Spatial;
67pub use crate::traits::contextuable::temporal::Temporal;
68// Contextuable Graph Traits
69pub use crate::traits::contextuable_graph::ContextuableGraph;
70pub use crate::traits::contextuable_graph::ExtendableContextuableGraph;
71// Indexable Traits
72pub use crate::traits::indexable::data_index_current::CurrentDataIndex;
73pub use crate::traits::indexable::data_index_previous::PreviousDataIndex;
74pub use crate::traits::indexable::data_indexable::DataIndexable;
75pub use crate::traits::indexable::time_index_current::CurrentTimeIndex;
76pub use crate::traits::indexable::time_index_previous::PreviousTimeIndex;
77pub use crate::traits::indexable::time_indexable::TimeIndexable;
78// Storable trait
79pub use crate::traits::storable::Storable;
80// Scalar traits
81pub use crate::traits::scalar::scalar_projector::ScalarProjector;
82pub use crate::traits::scalar::scalar_value::ScalarValue;
83//
84// Types
85//
86// Default context node types.
87pub use crate::types::context_node_types::data::Data;
88pub use crate::types::context_node_types::data_uncertain::uncertain_bool_data::UncertainBoolData;
89pub use crate::types::context_node_types::data_uncertain::uncertain_data::UncertainData;
90pub use crate::types::context_node_types::no_space_time::NoSpaceTime;
91pub use crate::types::context_node_types::root::Root;
92// Space context node types.
93pub use crate::types::context_node_types::space::ecef_space::EcefSpace;
94pub use crate::types::context_node_types::space::euclidean_space::EuclideanSpace;
95pub use crate::types::context_node_types::space::geo_space::GeoSpace;
96pub use crate::types::context_node_types::space::ned_space::NedSpace;
97pub use crate::types::context_node_types::space::space_kind::SpaceKind;
98// Space time context node types.
99pub use crate::types::context_node_types::space_time::euclidean_spacetime::EuclideanSpacetime;
100pub use crate::types::context_node_types::space_time::lorentzian_spacetime::LorentzianSpacetime;
101pub use crate::types::context_node_types::space_time::space_time_kind::SpaceTimeKind;
102pub use crate::types::context_node_types::space_time::tangent_spacetime::TangentSpacetime;
103// Symbolic spacetime context node types.
104pub use crate::types::context_node_types::symbol_spacetime::causal_set_spacetime::CausalSetSpacetime;
105pub use crate::types::context_node_types::symbol_spacetime::conformal_spacetime::ConformalSpacetime;
106// Time context node types.
107pub use crate::types::context_node_types::time::discrete_time::DiscreteTime;
108pub use crate::types::context_node_types::time::entropic_time::EntropicTime;
109pub use crate::types::context_node_types::time::euclidean_time::EuclideanTime;
110pub use crate::types::context_node_types::time::lorentzian_time::LorentzianTime;
111pub use crate::types::context_node_types::time::symbolic_time::{SymbolicTime, SymbolicTimeUnit};
112pub use crate::types::context_node_types::time::time_kind::TimeKind;
113// Context types
114pub use crate::types::context_types::context_graph;
115pub use crate::types::context_types::context_graph::Context;
116pub use crate::types::context_types::context_store::ContextStore;
117pub use crate::types::context_types::contextoid::contextoid_type::*;
118pub use crate::types::context_types::contextoid::*;
119// Vocabulary declared in the persistence contract crate. The node types return these from
120// `datum()`, `time_scale()` and every edge accessor, so a consumer can name them without a second
121// dependency.
122pub use deep_causality_context_store::{RelationKind, SubstrateRef, TimeScale, VerticalDatum};
123
124// Re-exported so an implementor of a context trait does not need a second import for the identity
125// trait every context node carries.
126pub use deep_causality_core::Identifiable;