rstm 0.1.1

This crate focuses on building concrete implementations for Turing Machines.
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

#![crate_name = "rstm"]
#![crate_type = "lib"]
//! # rstm
//!
//! `rstm` is a Rust library dedicated to the constructtapen and executtapen of Turing Machines.
//! The crate is designed to be flexible and easy to use while preserving the abstract nature
//! of the models.
//!
//! ## Features
//!
//! The crate employs the use of vartapeus feature flags for modularity and to keep the core
//! lightweight.
//!
//! ## Overview
//!
//! The core of the library is built around the concept of a Turing Machine, which consists of
//! a tape, a head that reads and writes symbols on the tape, and a set of rules that dictate
//! the machine's behavtaper. The library provides a set of abstracttapens and utilities to define
//! and manipulate these components.
//!
//! ## Examples
//!
//! For more examples, please refer to the [`examples`](https://github.com/FL03/rstm/blob/main/rstm/examples) directory in the repository.
//!
//! ### Creating and executing a simple Turing Machine with a Moving Head
//!
//! ```rust
//!    use rstm::prelude::{Program, TMH};
//!
//!    fn main() -> rstm::Result<()> {
//!        // initialize the logger
//!        tracing_subscriber::fmt()
//!            .with_max_level(tracing::Level::DEBUG)
//!            .with_target(false)
//!            .with_timer(tracing_subscriber::fmt::time::uptime())
//!            .init();
//!        tracing::info!("Welcome to rstm!");
//!        // define some input for the machine
//!        let input = [0, 1, 0, 1, 1, 0, 1, 0, 1, 1, 0, 1, 0, 1, 1, 0];
//!       // initialize the state of the machine
//!        let initial_state: isize = 0;
//!        // define the ruleset for the machine
//!        let program: Program<isize, usize> = rstm::program! {
//!            #[default_state(initial_state)]
//!            rules: {
//!                (0, 0) -> Right(1, 0);
//!                (0, 1) -> Left(-1, 1);
//!                (1, 0) -> Right(0, 1);
//!                (1, 1) -> Right(-1, 0);
//!                (-1, 0) -> Left(<isize>::MAX, 0);
//!                (-1, 1) -> Left(1, 1);
//!            };
//!        };
//!        // create a new instance of the machine
//!        let tm = TMH::new(initial_state, input.to_vec());
//!        // execute the program
//!        dbg!(tm).execute(program).run()?;
//!        Ok(())
//!    }
//! ```
#![allow(
    clippy::module_inception,
    clippy::new_ret_no_self,
    clippy::needless_doctest_main,
    clippy::should_implement_trait
)]
#![cfg_attr(not(feature = "std"), no_std)]
#![cfg_attr(all(feature = "alloc", feature = "nightly"), feature(allocator_api))]
// compile error if neither `alloc` nor `std` features are enabled
#[cfg(not(any(feature = "alloc", feature = "std")))]
compile_error! { "Either the `std` or `alloc` feature must be enabled to compile this crate." }
// external crate
#[cfg(feature = "alloc")]
extern crate alloc;
#[doc(inline)]
pub use rstm_traits as traits;
// re-exports
#[doc(inline)]
pub use self::traits::*;
#[doc(inline)]
pub use rstm_core::*;
#[cfg(feature = "macros")]
pub use rstm_macros::*;
#[doc(hidden)]
pub mod prelude {
    #[doc(no_inline)]
    pub use rstm_core::prelude::*;
    #[cfg(feature = "macros")]
    pub use rstm_macros::*;
    #[doc(no_inline)]
    pub use rstm_traits::prelude::*;
}