internalNode.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

#ifndef GUM_MULTI_DIM_FUNCTION_GRAPH_INTERNAL_NODE_H
#define GUM_MULTI_DIM_FUNCTION_GRAPH_INTERNAL_NODE_H

#include <agrum/agrum.h>
#include <agrum/core/smallobjectallocator/smallObjectAllocator.h>
#include <agrum/graphs/graphElements.h>
#include <agrum/multidim/utils/FunctionGraphUtilities/link.h>
#include <agrum/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/multidim/utils/FunctionGraphUtilities/internalNode_inl.h>
#endif /* GUM_NO_INLINE */

#endif /* GUM_MULTI_DIM_FUNCTION_GRAPH_INTERNAL_NODE_H */