problemreductions/models/misc/

conjunctive_boolean_query.rs

//! Conjunctive Boolean Query problem implementation.
//!
//! Given a finite domain `D = {0, ..., domain_size-1}`, a collection of
//! relations `R`, and a conjunctive Boolean query
//! `Q = (exists y_1, ..., y_l)(A_1 /\ ... /\ A_r)`, determine whether `Q` is
//! true over `R` and `D`.
//!
//! Each conjunct `A_i` applies a relation to a tuple of arguments, where each
//! argument is either an existentially quantified variable or a constant from
//! the domain. The query is satisfiable iff there exists an assignment to the
//! variables such that every conjunct's resolved tuple belongs to its relation.

use crate::registry::{CreateSpec, ProblemSchemaEntry};
use crate::traits::Problem;
use serde::{Deserialize, Serialize};

inventory::submit! {
    ProblemSchemaEntry {
        name: "ConjunctiveBooleanQuery",
        display_name: "Conjunctive Boolean Query",
        aliases: &["CBQ"],
        dimensions: &[],
        category: crate::registry::ProblemCategory::Misc,
        module_path: module_path!(),
        description: "Evaluate a conjunctive Boolean query over a relational database",
        fields: ConjunctiveBooleanQueryCreateSpec::FIELDS,
    }
}

/// A relation with fixed arity and a set of tuples over a finite domain.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Relation {
    /// The arity (number of columns) of this relation.
    pub arity: usize,
    /// The set of tuples; each tuple has length == arity, entries in `0..domain_size`.
    pub tuples: Vec<Vec<usize>>,
}

/// An argument in a conjunctive query atom.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum QueryArg {
    /// A reference to existential variable `y_i` (0-indexed).
    Variable(usize),
    /// A constant value from the domain `D`.
    Constant(usize),
}

/// The Conjunctive Boolean Query problem.
///
/// Given a finite domain `D = {0, ..., domain_size-1}`, a collection of
/// relations `R`, and a conjunctive Boolean query
/// `Q = (exists y_1, ..., y_l)(A_1 /\ ... /\ A_r)`, determine whether `Q` is
/// true over `R` and `D`.
///
/// # Representation
///
/// The configuration is a vector of length `num_variables`, where each entry is
/// a value in `{0, ..., domain_size-1}` representing an assignment to the
/// existentially quantified variables.
///
/// # Example
///
/// ```
/// use problemreductions::models::misc::{ConjunctiveBooleanQuery, CbqRelation, QueryArg};
/// use problemreductions::{Problem, BruteForce};
///
/// let relations = vec![
///     CbqRelation { arity: 2, tuples: vec![vec![0, 3], vec![1, 3]] },
/// ];
/// let conjuncts = vec![
///     (0, vec![QueryArg::Variable(0), QueryArg::Constant(3)]),
/// ];
/// let problem = ConjunctiveBooleanQuery::new(6, relations, 1, conjuncts);
/// let solver = BruteForce::new();
/// let solution = solver.solve(&problem).unwrap();
/// assert!(solution.is_some());
/// ```
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(try_from = "ConjunctiveBooleanQueryData")]
pub struct ConjunctiveBooleanQuery {
    domain_size: usize,
    relations: Vec<Relation>,
    num_variables: usize,
    conjuncts: Vec<(usize, Vec<QueryArg>)>,
}

#[derive(Deserialize)]
struct ConjunctiveBooleanQueryData {
    domain_size: usize,
    relations: Vec<Relation>,
    num_variables: usize,
    conjuncts: Vec<(usize, Vec<QueryArg>)>,
}

impl TryFrom<ConjunctiveBooleanQueryData> for ConjunctiveBooleanQuery {
    type Error = crate::registry::ConstructionError;
    fn try_from(data: ConjunctiveBooleanQueryData) -> Result<Self, Self::Error> {
        Self::try_new(
            data.domain_size,
            data.relations,
            data.num_variables,
            data.conjuncts,
        )
    }
}

#[derive(Debug, Deserialize, crate::CreateSpec)]
struct ConjunctiveBooleanQueryCreateSpec {
    /// Size of the finite domain.
    domain_size: usize,
    /// Relations evaluated by the query.
    #[create(codec = "json")]
    relations: Vec<Relation>,
    /// Query atoms; the number of variables is inferred from their arguments.
    #[create(codec = "json")]
    conjuncts: Vec<(usize, Vec<QueryArg>)>,
}

impl TryFrom<ConjunctiveBooleanQueryCreateSpec> for ConjunctiveBooleanQuery {
    type Error = crate::registry::ConstructionError;

    fn try_from(spec: ConjunctiveBooleanQueryCreateSpec) -> Result<Self, Self::Error> {
        let mut num_variables = 0_usize;
        for (_, args) in &spec.conjuncts {
            for arg in args {
                if let QueryArg::Variable(variable) = arg {
                    let count = variable
                        .checked_add(1)
                        .ok_or_else(|| "number of query variables overflows usize".to_string())?;
                    num_variables = num_variables.max(count);
                }
            }
        }

        Self::try_new(
            spec.domain_size,
            spec.relations,
            num_variables,
            spec.conjuncts,
        )
    }
}

impl ConjunctiveBooleanQuery {
    /// Create a new ConjunctiveBooleanQuery instance.
    ///
    /// # Panics
    ///
    /// Panics if:
    /// - Any relation's tuples have incorrect arity
    /// - Any tuple entry is >= domain_size
    /// - Any conjunct references a non-existent relation
    /// - Any `Variable(i)` has `i >= num_variables`
    /// - Any `Constant(c)` has `c >= domain_size`
    /// - Any conjunct's argument count does not match the referenced relation's arity
    pub fn new(
        domain_size: usize,
        relations: Vec<Relation>,
        num_variables: usize,
        conjuncts: Vec<(usize, Vec<QueryArg>)>,
    ) -> Self {
        Self::try_new(domain_size, relations, num_variables, conjuncts)
            .unwrap_or_else(|error| panic!("{error}"))
    }

    fn try_new(
        domain_size: usize,
        relations: Vec<Relation>,
        num_variables: usize,
        conjuncts: Vec<(usize, Vec<QueryArg>)>,
    ) -> Result<Self, crate::registry::ConstructionError> {
        for (i, rel) in relations.iter().enumerate() {
            for (j, tuple) in rel.tuples.iter().enumerate() {
                if tuple.len() != rel.arity {
                    return Err(format!(
                        "Relation {i}: tuple {j} has length {}, expected arity {}",
                        tuple.len(),
                        rel.arity
                    )
                    .into());
                }
                for (k, &val) in tuple.iter().enumerate() {
                    if val >= domain_size {
                        return Err(format!(
                            "Relation {i}: tuple {j}, entry {k} is {val}, must be < {domain_size}"
                        )
                        .into());
                    }
                }
            }
        }
        for (i, (rel_idx, args)) in conjuncts.iter().enumerate() {
            if *rel_idx >= relations.len() {
                return Err(format!(
                    "Conjunct {i}: relation index {rel_idx} out of range (have {} relations)",
                    relations.len()
                )
                .into());
            }
            if args.len() != relations[*rel_idx].arity {
                return Err(format!(
                    "Conjunct {i}: has {} args, expected arity {}",
                    args.len(),
                    relations[*rel_idx].arity
                )
                .into());
            }
            for (k, arg) in args.iter().enumerate() {
                match arg {
                    QueryArg::Variable(v) => {
                        if *v >= num_variables {
                            return Err(format!("Conjunct {i}, arg {k}: Variable({v}) >= num_variables ({num_variables})").into());
                        }
                    }
                    QueryArg::Constant(c) => {
                        if *c >= domain_size {
                            return Err(format!("Conjunct {i}, arg {k}: Constant({c}) >= domain_size ({domain_size})").into());
                        }
                    }
                }
            }
        }
        Ok(Self {
            domain_size,
            relations,
            num_variables,
            conjuncts,
        })
    }

    /// Returns the size of the finite domain.
    pub fn domain_size(&self) -> usize {
        self.domain_size
    }

    /// Returns the number of relations.
    pub fn num_relations(&self) -> usize {
        self.relations.len()
    }

    /// Returns the number of existentially quantified variables.
    pub fn num_variables(&self) -> usize {
        self.num_variables
    }

    /// Returns the number of conjuncts in the query.
    pub fn num_conjuncts(&self) -> usize {
        self.conjuncts.len()
    }

    /// Returns the relations.
    pub fn relations(&self) -> &[Relation] {
        &self.relations
    }

    /// Returns the conjuncts.
    pub fn conjuncts(&self) -> &[(usize, Vec<QueryArg>)] {
        &self.conjuncts
    }
}

impl Problem for ConjunctiveBooleanQuery {
    const NAME: &'static str = "ConjunctiveBooleanQuery";
    type Solution = Vec<usize>;
    type Value = crate::types::Or;

    crate::problem_parameters![
        ("domain_size", domain_size),
        ("num_conjuncts", num_conjuncts),
        ("num_relations", num_relations),
        ("num_variables", num_variables),
    ];

    fn variant() -> Vec<(&'static str, &'static str)> {
        crate::variant_params![]
    }

    fn evaluate(
        &self,
        config: &Self::Solution,
    ) -> Result<crate::types::Or, crate::traits::EvaluationError> {
        Ok({
            crate::types::Or({
                if config.len() != self.num_variables {
                    return Err(crate::traits::EvaluationError::InvalidConfiguration(
                        "variable assignment length does not match the query".into(),
                    ));
                }
                if config.iter().any(|&v| v >= self.domain_size) {
                    return Err(crate::traits::EvaluationError::InvalidConfiguration(
                        "variable assignment contains an out-of-range domain value".into(),
                    ));
                }
                self.conjuncts.iter().all(|(rel_idx, args)| {
                    let tuple: Vec<usize> = args
                        .iter()
                        .map(|arg| match arg {
                            QueryArg::Variable(i) => config[*i],
                            QueryArg::Constant(c) => *c,
                        })
                        .collect();
                    self.relations[*rel_idx].tuples.contains(&tuple)
                })
            })
        })
    }
}

impl crate::solvers::BruteForceProblem for ConjunctiveBooleanQuery {
    fn dimensions(&self) -> Vec<usize> {
        vec![self.domain_size; self.num_variables]
    }
}

crate::declare_variants! {
    default ConjunctiveBooleanQuery => "domain_size ^ num_variables" create ConjunctiveBooleanQueryCreateSpec,
}

crate::register_brute_force! {
    ConjunctiveBooleanQuery,
}

#[cfg(feature = "example-db")]
pub(crate) fn canonical_model_example_specs() -> Vec<crate::example_db::specs::ModelExampleSpec> {
    vec![crate::example_db::specs::ModelExampleSpec {
        id: "conjunctive_boolean_query",
        // D={0..5}, 2 relations (binary R0, ternary R1), 3 atoms, 2 variables.
        // Satisfying assignment: y0=0, y1=1.
        instance: Box::new(ConjunctiveBooleanQuery::new(
            6,
            vec![
                Relation {
                    arity: 2,
                    tuples: vec![vec![0, 3], vec![1, 3], vec![2, 4], vec![3, 4], vec![4, 5]],
                },
                Relation {
                    arity: 3,
                    tuples: vec![vec![0, 1, 5], vec![1, 2, 5], vec![2, 3, 4], vec![0, 4, 3]],
                },
            ],
            2,
            vec![
                (0, vec![QueryArg::Variable(0), QueryArg::Constant(3)]),
                (0, vec![QueryArg::Variable(1), QueryArg::Constant(3)]),
                (
                    1,
                    vec![
                        QueryArg::Variable(0),
                        QueryArg::Variable(1),
                        QueryArg::Constant(5),
                    ],
                ),
            ],
        )),
        optimal_config: serde_json::json!(vec![0, 1]),
        optimal_value: serde_json::json!(true),
    }]
}

#[cfg(test)]
#[path = "../../unit_tests/models/misc/conjunctive_boolean_query.rs"]
mod tests;