doorCriteria.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2026                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

#ifndef GUM_DOOR_CRITERIA_H
#define GUM_DOOR_CRITERIA_H
 
#include <optional>
#include <vector>
 
#include <agrum/base/graphs/DAG.h>
 
namespace gum {

  class DoorCriteria {
    public:
    using NodeSetVec = std::vector< NodeSet >;
 
    /* ------------------------- Backdoor --------------------------- */

    static bool satisfiesBackdoorCriterion(const DAG& dag, NodeId X, NodeId Y, const NodeSet& Z);

    static NodeSetVec enumerateBackdoorSets(const DAG&     dag,
                                            NodeId         X,
                                            NodeId         Y,
                                            const NodeSet& excluded_nodes  = NodeSet(),
                                            std::size_t    max_cardinality = 0,
                                            bool           only_minimal    = true,
                                            bool           stopAtFirst     = false);

    static NodeSetVec enumerateBackdoorSets(const DAG& dag, NodeId X, NodeId Y, bool stopAtFirst);

    static std::optional< NodeSet > firstBackdoor(const DAG&     dag,
                                                  NodeId         X,
                                                  NodeId         Y,
                                                  const NodeSet& excluded_nodes  = NodeSet(),
                                                  std::size_t    max_cardinality = 0,
                                                  bool           only_minimal    = true);
 
    /* ------------------------- Frontdoor -------------------------- */

    static bool satisfiesFrontdoorCriterion(const DAG& dag, NodeId X, NodeId Y, const NodeSet& Z);

    static NodeSetVec enumerateFrontdoorSets(const DAG&     dag,
                                             NodeId         X,
                                             NodeId         Y,
                                             const NodeSet& excluded_nodes  = NodeSet(),
                                             std::size_t    max_cardinality = 0,
                                             bool           only_minimal    = true,
                                             bool           stopAtFirst     = false);

    static NodeSetVec enumerateFrontdoorSets(const DAG& dag, NodeId X, NodeId Y, bool stopAtFirst);

    static std::optional< NodeSet > firstFrontdoor(const DAG&     dag,
                                                   NodeId         X,
                                                   NodeId         Y,
                                                   const NodeSet& excluded_nodes  = NodeSet(),
                                                   std::size_t    max_cardinality = 0,
                                                   bool           only_minimal    = true);
 
    /* -------------------------- Utilities ------------------------- */

    static bool existsUnblockedDirectedPath(const DAG& dag, NodeId X, NodeId Y, const NodeSet& Z);

    static std::optional< NodeSet > nodesOnDirectedPaths(const DAG& dag, NodeId X, NodeId Y);

    static NodeSet backdoorReach(const DAG& dag, NodeId X);

    static bool hasBackdoorPath(const DAG& dag, NodeId X, NodeId Y, const NodeSet& Z);
 
    private:
    static bool _isMinimalBackdoorAdjustment(const DAG& dag, NodeId X, NodeId Y, const NodeSet& Z);

    static bool _isMinimalFrontdoorAdjustment(const DAG& dag, NodeId X, NodeId Y, const NodeSet& Z);
 
    static bool _existsUnblockedDirectedPath_(const DAG&     dag,
                                              NodeId         X,
                                              NodeId         Y,
                                              const NodeSet& Z,
                                              NodeSet&       visited);
  };
 
}   // namespace gum
 
#ifndef GUM_NO_INLINE
#  include <agrum/CM/doorCriteria_inl.h>
#endif   // GUM_NO_INLINE
 
#endif   // GUM_DOOR_CRITERIA_H