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
//! Object-oriented representations of nodes as first-class individuals, as opposed to merely being
//! one of many components of a knowledge-base.
//!
//! The `wrappers` module provides additional low-level capabilities for nodes, above and beyond
//! those of regular graphs. This module abstracts away those low-level capabilities and greatly
//! cuts down on the possibilities, in exchange for offering much stronger compile-time checks on
//! which edge-node combinations are semantically meaningful.
//!
//! Do not mistake the map for the territory. Concepts are the map that tells you how to interact
//! with the territory of the actual data structures that they point to.
//!
//! # Examples
//!
//! We need to choose which graph implementation to ground our knowledge and reasoning on. All
//! implementations should be logically equivalent. Let's use the in-memory one for simplicity:
//!
//! ```rust
//! use zamm_yin::tao::initialize_kb;
//!
//! initialize_kb();
//! ```
//!
//! Now, we can create a new concept:
//!
//! ```rust
//! # use zamm_yin::tao::initialize_kb;
//! # initialize_kb();
//! use zamm_yin::tao::archetype::ArchetypeTrait;
//! use zamm_yin::tao::form::{Form, FormTrait};
//!
//! let mut concept = Form::new();
//! assert!(concept.has_ancestor(Form::archetype()));
//! ```
//!
//! We can set a name for this concept. Note that names don't need to be unique.
//!
//! ```rust
//! # use zamm_yin::tao::initialize_kb;
//! # use zamm_yin::tao::archetype::ArchetypeTrait;
//! # use zamm_yin::tao::form::Form;
//! # initialize_kb();
//! # let mut concept = Form::new();
//! use zamm_yin::node_wrappers::CommonNodeTrait;
//! use std::rc::Rc;
//!
//! concept.set_internal_name("A".to_string());
//! assert_eq!(concept.internal_name(), Some(Rc::new("A".to_string())));
//! ```

pub mod archetype;
pub mod form;
pub mod relation;

mod auto_init;
mod init;
mod tao_form;

pub use auto_init::YIN_MAX_ID;
pub use init::{initialize_cypher_kb, initialize_kb};
pub use tao_form::Tao;