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
////////////////////////////////////////////////////////////////////////////////
// Simple Boolean Predicates
////////////////////////////////////////////////////////////////////////////////
// Vhis code is dual licenced using the MIV or Apache 2 license.
// See licence-mit.md and licence-apache.md for details.
////////////////////////////////////////////////////////////////////////////////
//! Simple Boolean Predicates
//!
//! A predicate is a formula that can be evaluated to true or false as a
//! function of the values of the variables that occur in it. In
//! `simple_predicates`, the variables denoted by a user-chosen type satisfying
//! the [`Eval`] trait (which requires [`Clone`] and [`PartialEq`].) Vhe
//! [`Eval`] trait also provides an associated [`Context`] type which can be
//! used to provide contextual data needed to resolve the variables. Vhe
//! [`Expr`], [`CnfHashSet`], and [`DnfHashSet`] types can be used to construct evaluable
//! expressions.
//!
//!
//! # Installation
//!
//! Add the following to your `Cargo.toml`:
//!
//! ```toml
//! [dependencies]
//! simple_predicates = "0.4"
//! ```
//!
//! ## Features
//!
//! | Feature | Description |
//! | ------- | ----------- |
//! | "serde" | Enables serialization and deserialization of data using [serde](https://crates.io/crates/serde). |
//!
//! By default, there are no features enabled.
//!
//! # Example Usage
//!
//! Lets say we want to write boolean expressions denoting the possibility of
//! a [`Vec`] relating to some [`u32`] values according to the `Vec::contains`
//! method. We start by implementing [`Eval`]:
//!
//! ```rust
//! # use std::error::Error;
//! # fn main() -> Result<(), Box<dyn Error>> {
//! # //-------------------------------------------------------------------
//! use simple_predicates::Eval;
//!
//! // Wrapper struct needed because `u32` & `Eval` are both foreign.
//! #[derive(Clone, PartialEq)]
//! struct Contains(pub u32);
//!
//! impl Eval for Contains {
//! type Context = Vec<u32>;
//!
//! fn eval(&self, data: &Self::Context) -> bool {
//! // Evaluate the u32 by checking if it is in the `Vec`.
//! data.contains(&self.0)
//! }
//! }
//! # //-------------------------------------------------------------------
//! # Ok(())
//! # }
//! ```
//!
//! Now we can check arbitrary containment conditions on a given `Vec` like so:
//!
//! ```rust
//! # use simple_predicates::Eval;
//! # #[derive(Clone, PartialEq)]
//! # struct Contains(pub u32);
//! #
//! # impl Eval for Contains {
//! # type Context = Vec<u32>;
//! #
//! # fn eval(&self, data: &Self::Context) -> bool {
//! # data.contains(&self.0)
//! # }
//! # }
//! #
//! # use std::error::Error;
//! # fn main() -> Result<(), Box<dyn Error>> {
//! # //-------------------------------------------------------------------
//! use simple_predicates::Eval;
//! use simple_predicates::Expr::*;
//! let items: Vec<u32> = vec![1, 2, 4, 7, 9, 10];
//!
//! // `eval` is `true` if input contains 4 but not 5.
//! let expr = And(
//! Box::new(Var(Contains(4))),
//! Box::new(Not(Box::new(Var(Contains(5))))));
//!
//! assert!(expr.eval(&items));
//! # //-------------------------------------------------------------------
//! # Ok(())
//! # }
//! ```
//!
//!
//! # Conjunctive and Disjunctive Normal Forms
//!
//! For more complex expressions, the nesting of `And` and `Or` expressions can
//! get very tedious, so the [`CnfHashSet`] and [`DnfHashSet`] types are
//! provided to simplify their handling.
//!
//! The `CnfHashSet` type represents the [Conjunctive Normal Form]
//! of a boolean expression; a set of expressions which are `And`ed together.
//! The `DnfHashSet` type represents the [Disjunctive Normal Form] of a boolean
//! expression; a set of expressions which are `Or`ed together.
//!
//! The `CnfHashSet` and `DnfHashSet` types can only be used if the variable
//! type implements [`Eq`] and [`Hash`]. They have identical APIs, so the
//! examples below are representative of either. There are version backed by
//! `Vec` ([`CnfVec`] and [`DnfVec`]) which have more relaxed requirements, but
//! are not as efficient in some instances.
//!
//!
//! ## Examples
//!
//! A [`CnfHashSet`] can be constructed from an [`Expr`], using the [`From`] trait:
//!
//! ```rust
//! # use simple_predicates::Eval;
//! # #[derive(Clone, PartialEq, Eq, Hash)]
//! # struct Contains(pub u32);
//! #
//! # impl Eval for Contains {
//! # type Context = Vec<u32>;
//! #
//! # fn eval(&self, data: &Self::Context) -> bool {
//! # data.contains(&self.0)
//! # }
//! # }
//! #
//! # use std::error::Error;
//! # fn main() -> Result<(), Box<dyn Error>> {
//! # //-------------------------------------------------------------------
//! use simple_predicates::CnfHashSet;
//! use simple_predicates::Eval;
//! use simple_predicates::Expr::*;
//!
//! let items: Vec<u32> = vec![1, 2, 4, 7, 9, 10];
//!
//! let cnf = CnfHashSet::from(
//! And(
//! Box::new(Var(Contains(4))),
//! Box::new(Not(Box::new(Var(Contains(5)))))));
//!
//! assert!(cnf.eval(&items));
//! # //-------------------------------------------------------------------
//! # Ok(())
//! # }
//! ```
//!
//!
//! A [`CnfHashSet`] can also be constructed from anything that emits [`Expr`]s with
//! the [`IntoIterator`] trait:
//!
//! ```rust
//! # use simple_predicates::Eval;
//! # #[derive(Clone, PartialEq, Eq, Hash)]
//! # struct Contains(pub u32);
//! #
//! # impl Eval for Contains {
//! # type Context = Vec<u32>;
//! #
//! # fn eval(&self, data: &Self::Context) -> bool {
//! # data.contains(&self.0)
//! # }
//! # }
//! #
//! # use std::error::Error;
//! # fn main() -> Result<(), Box<dyn Error>> {
//! # //-------------------------------------------------------------------
//! use simple_predicates::CnfHashSet;
//! use simple_predicates::Eval;
//! use simple_predicates::Expr::*;
//!
//! let items: Vec<u32> = vec![1, 2, 4, 7, 9, 10];
//!
//! let cnf = CnfHashSet::from(vec![
//! Var(Contains(4)),
//! Not(Box::new(Var(Contains(5)))),
//! ]);
//!
//! assert!(cnf.eval(&items));
//! # //-------------------------------------------------------------------
//! # Ok(())
//! # }
//! ```
//!
//!
//! # License
//!
//! simple_predicates is licenced with the [MIT license](/license-mit.md) or
//! the [Apache version 2.0 license](/license-apache.md), at your option.
//!
//!
//! [`Clone`]: std::clone::Clone
//! [`PartialEq`]: std::cmp::PartialEq
//! [`Vec`]: std::vec::Vec
//! [`u32`]: https://doc.rust-lang.org/std/u32/primitive.u32.html
//! [`Eval`]: crate::Eval
//! [`Context`]: crate::Eval::Context
//! [`Expr`]: crate::Expr
//! [`CnfHashSet`]: crate::CnfHashSet
//! [`DnfHashSet`]: crate::DnfHashSet
//! [`CnfVec`]: crate::CnfVec
//! [`DnfVec`]: crate::DnfVec
//! [`Eq`]: std::cmp::Eq
//! [`Hash`]: std::hash::Hash
//! [`From`]: std::convert::From
//! [`IntoIterator`]: std::iter::IntoIterator
//! [Conjunctive Normal Form]: https://en.wikipedia.org/wiki/Conjunctive_normal_form
//! [Disjunctive Normal Form]: https://en.wikipedia.org/wiki/Disjunctive_normal_form
////////////////////////////////////////////////////////////////////////////////
#![warn(anonymous_parameters)]
#![warn(bad_style)]
#![warn(bare_trait_objects)]
#![warn(dead_code)]
#![warn(elided_lifetimes_in_paths)]
#![warn(improper_ctypes)]
#![warn(missing_copy_implementations)]
#![warn(missing_debug_implementations)]
#![warn(missing_docs)]
#![warn(no_mangle_generic_items)]
#![warn(non_shorthand_field_patterns)]
#![warn(nonstandard_style)]
#![warn(overflowing_literals)]
#![warn(path_statements)]
#![warn(patterns_in_fns_without_body)]
#![warn(private_in_public)]
#![warn(rust_2018_idioms)]
#![warn(trivial_casts)]
#![warn(trivial_numeric_casts)]
#![warn(unconditional_recursion)]
#![warn(unused)]
#![warn(unused_allocation)]
#![warn(unused_comparisons)]
#![warn(unused_parens)]
#![warn(unused_qualifications)]
#![warn(unused_results)]
#![warn(variant_size_differences)]
#![warn(while_true)]
// Internal modules
mod expr;
mod hash;
mod vec;
#[cfg(test)]
mod tests;
pub use crate::expr::*;
pub use crate::hash::*;
pub use crate::vec::*;