internalNode.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 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-2025                            *
 *       - 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_MULTI_DIM_FUNCTION_GRAPH_INTERNAL_NODE_H
#define GUM_MULTI_DIM_FUNCTION_GRAPH_INTERNAL_NODE_H
 
#include <agrum/agrum.h>
 
#include <agrum/base/graphs/graphElements.h>
#include <agrum/base/multidim/utils/FunctionGraphUtilities/link.h>
#include <agrum/base/variables/discreteVariable.h>
 
namespace gum {
 
  // clang-format off
  // clang-format on
 
  struct Parent {
    NodeId parentId;
    Idx    modality;

    Parent(NodeId pi, Idx m);

    Parent(const Parent& src);
 
    // ============================================================================
    // ============================================================================

    void* operator new(size_t s);

    void operator delete(void* p);

    // ============================================================================
    // ============================================================================
 
    bool operator==(const Parent& comp) const;
 
    bool operator!=(const Parent& comp) const;
 
    Parent& operator=(const Parent& src);
  };
 
  // clang-format off
  // clang-format on
 
  class InternalNode {
    private:
    const DiscreteVariable* _nodeVar_;

    NodeId* _nodeSons_;

    LinkedList< Parent > _nodeParents_;

    void _setNodeVar_(const DiscreteVariable* v);
 
    public:
    // ============================================================================
    // ============================================================================

    InternalNode();

    explicit InternalNode(const DiscreteVariable* v);

    InternalNode(const DiscreteVariable* v, NodeId* sons);

    ~InternalNode();
    // ============================================================================
    // ============================================================================

    void* operator new(size_t s);

    void operator delete(void* p);

    // ============================================================================
    // ============================================================================

    void setNode(const DiscreteVariable* v, NodeId* sons);

    // ============================================================================
    // ============================================================================

    void setNodeVar(const DiscreteVariable* v);

    const DiscreteVariable* nodeVar() const;

    // ============================================================================
    // ============================================================================

    void setSon(Idx modality, NodeId son);

    NodeId son(Idx modality) const;

    Idx nbSons() const;

    // ============================================================================
    // ============================================================================

    void addParent(NodeId parent, Idx modality);

    void removeParent(NodeId parent, Idx modality);

    Link< Parent >* parents();

    const Link< Parent >* parents() const;

    // ============================================================================
    // ============================================================================

    static NodeId* allocateNodeSons(const DiscreteVariable* v);

    static void deallocateNodeSons(const DiscreteVariable* v, NodeId* s);

  };
 
}   // End of namespace gum
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/multidim/utils/FunctionGraphUtilities/internalNode_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_MULTI_DIM_FUNCTION_GRAPH_INTERNAL_NODE_H */