Structure used to represent a node internal structure. More...

#include <agrum/multidim/FunctionGraphUtilities/internalNode.h>

Collaboration diagram for gum::InternalNode:

Public Member Functions
Constructors and Destructors
	InternalNode ()
	Default Constructor Creates an empty node with no variable attached. More...

	InternalNode (const DiscreteVariable *v)
	Class constructor. More...

	InternalNode (const DiscreteVariable v, NodeId sons)
	Constructor. More...

	~InternalNode ()
	Class destructors. More...

Allocators and Deallocators redefinition
void *	operator new (size_t s)
	New operator. More...

void	operator delete (void *p)
	Delete operator. More...

Node handlers
void	setNode (const DiscreteVariable v, NodeId sons)
	Allows you to respecify the node, changing its attached variable as well as its son map. More...

Var handlers
void	setNodeVar (const DiscreteVariable *v)
	Set the node variable. More...

const DiscreteVariable *	nodeVar () const
	Returns the node variable. More...

Sons handlers
void	setSon (Idx modality, NodeId son)
	Sets the node's son. More...

NodeId	son (Idx modality) const
	Returns the son at a given index. More...

Idx	nbSons () const
	Returns the number of sons. More...

Parent handlers
void	addParent (NodeId parent, Idx modality)
	Adds a parent. More...

void	removeParent (NodeId parent, Idx modality)
	Removes a parent. More...

Link< Parent > *	parents ()
	Returns the list of parents. More...

const Link< Parent > *	parents () const
	Returns the list of parents. More...

Static Public Member Functions
Allocator/deallocator
static NodeId *	allocateNodeSons (const DiscreteVariable *v)
	Allocates a table of nodeid of the size given in parameter. More...

static void	deallocateNodeSons (const DiscreteVariable v, NodeId s)
	Deallocates a NodeSons table. More...

Detailed Description

Structure used to represent a node internal structure.

Definition at line 102 of file internalNode.h.

Constructor & Destructor Documentation

◆ InternalNode() [1/3]

gum::InternalNode::InternalNode ( )

Default Constructor Creates an empty node with no variable attached.

Definition at line 41 of file internalNode.cpp.

References __nodeVar.

                              {
     GUM_CONSTRUCTOR(InternalNode);
     __nodeVar = nullptr;
   }

◆ InternalNode() [2/3]

gum::InternalNode::InternalNode ( const DiscreteVariable * v )

explicit

Class constructor.

Creates a node and attached the specified variable. Initializes the sons.

Definition at line 46 of file internalNode.cpp.

References __setNodeVar().

                                                       {
     GUM_CONSTRUCTOR(InternalNode);
     __setNodeVar(v);
   }

Here is the call graph for this function:

◆ InternalNode() [3/3]

gum::InternalNode::InternalNode	(	const DiscreteVariable *	v,
		NodeId *	sons
	)

Constructor.

Creates a node and attached the specified variable. Also attached the given on map (and will handle it by itself especially deallocate it)

Warning: You'd better known what you're doing if you're using this one. sons must have the size of domainSize of v or the program will fail!

Definition at line 51 of file internalNode.cpp.

References __nodeSons, and __nodeVar.

                                                                     {
     GUM_CONSTRUCTOR(InternalNode);
     __nodeVar = v;
     __nodeSons = sons;
   }

◆ ~InternalNode()

gum::InternalNode::~InternalNode ( )

Class destructors.

Definition at line 60 of file internalNode.cpp.

References __nodeSons, __nodeVar, and deallocateNodeSons().

                               {
     GUM_DESTRUCTOR(InternalNode);
     if (__nodeVar != nullptr) deallocateNodeSons(__nodeVar, __nodeSons);
   }

Here is the call graph for this function:

Member Function Documentation

◆ __setNodeVar()

void gum::InternalNode::__setNodeVar ( const DiscreteVariable * v )

private

Set the node variable.

Definition at line 100 of file internalNode.cpp.

References __nodeSons, __nodeVar, and allocateNodeSons().

Referenced by InternalNode(), and setNodeVar().

                                                            {
     __nodeVar = v;
     __nodeSons = allocateNodeSons(v);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addParent()

void gum::InternalNode::addParent	(	NodeId	parent,
		Idx	modality
	)

Adds a parent.

Definition at line 108 of file internalNode.cpp.

References __nodeParents.

                                                           {
     __nodeParents.addLink(Parent(parent, modality));
   }

◆ allocateNodeSons()

NodeId * gum::InternalNode::allocateNodeSons ( const DiscreteVariable * v )

static

Allocates a table of nodeid of the size given in parameter.

Definition at line 68 of file internalNode.cpp.

References ALLOCATE, and gum::DiscreteVariable::domainSize().

Referenced by gum::MultiDimFunctionGraphManager< bool, ExactTerminalNodePolicy >::__adjacentSwap(), and __setNodeVar().

                                                                   {
     NodeId* sons =
        static_cast< NodeId* >(ALLOCATE(sizeof(NodeId) * v->domainSize()));
     for (gum::Idx i = 0; i < v->domainSize(); ++i)
       sons[i] = 0;
     return sons;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deallocateNodeSons()

void gum::InternalNode::deallocateNodeSons	(	const DiscreteVariable *	v,
		NodeId *	s
	)

static

Deallocates a NodeSons table.

Definition at line 79 of file internalNode.cpp.

References DEALLOCATE, and gum::DiscreteVariable::domainSize().

Referenced by setNode(), setNodeVar(), and ~InternalNode().

                                                                             {
     DEALLOCATE(s, sizeof(NodeId) * v->domainSize());
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nbSons()

INLINE Idx gum::InternalNode::nbSons ( ) const

Returns the number of sons.

Definition at line 92 of file internalNode_inl.h.

Referenced by gum::MultiDimFunctionGraphManager< bool, ExactTerminalNodePolicy >::_addInternalNode(), gum::MultiDimFunctionGraphManager< bool, ExactTerminalNodePolicy >::_migrateNode(), gum::MultiDimFunctionGraph< bool, ExactTerminalNodePolicy >::copy(), gum::MultiDimFunctionGraph< bool, ExactTerminalNodePolicy >::copyAndMultiplyByScalar(), gum::MultiDimFunctionGraph< bool, ExactTerminalNodePolicy >::copyAndReassign(), gum::StructuredPlaner< double >::optimalPolicy2String(), and gum::MultiDimFunctionGraph< bool, ExactTerminalNodePolicy >::toDot().

92 { return __nodeVar->domainSize(); }

gum::DiscreteVariable::domainSize

virtual Size domainSize() const =0

gum::InternalNode::__nodeVar

const DiscreteVariable * __nodeVar

Variable associated to such node.

Definition: internalNode.h:105

Here is the caller graph for this function:

◆ nodeVar()

INLINE const DiscreteVariable * gum::InternalNode::nodeVar ( ) const

Returns the node variable.

Definition at line 81 of file internalNode_inl.h.

Referenced by gum::Regress< GUM_SCALAR, COMBINEOPERATOR, PROJECTOPERATOR, TerminalNodePolicy >::__compute(), gum::MultiDimFunctionGraphOperator< GUM_SCALAR, FUNCTOR, TerminalNodePolicy >::__compute(), gum::StatesCounter::__incState(), gum::StatesChecker::__insertState(), gum::StructuredPlaner< double >::__recurArgMaxCopy(), gum::StructuredPlaner< double >::__recurExtractOptPol(), gum::TreeOperator< GUM_SCALAR, COMBINEOPERATOR, TerminalNodePolicy >::__xPloreDT2(), gum::TreeRegress< GUM_SCALAR, COMBINEOPERATOR, PROJECTOPERATOR, TerminalNodePolicy >::__xPloreVFunc(), gum::StatesChecker::addState(), gum::MultiDimFunctionGraphGenerator::generate(), gum::MultiDimFunctionGraph< bool, ExactTerminalNodePolicy >::get(), gum::StatesCounter::incState(), gum::StatesCounter::nodeVar(), gum::StructuredPlaner< double >::optimalPolicy2String(), gum::MultiDimFunctionGraphProjector< GUM_SCALAR, FUNCTOR, TerminalNodePolicy >::project(), and gum::MultiDimFunctionGraph< bool, ExactTerminalNodePolicy >::toDot().

81 { return __nodeVar; }

gum::InternalNode::__nodeVar

const DiscreteVariable * __nodeVar

Variable associated to such node.

Definition: internalNode.h:105

Here is the caller graph for this function:

◆ operator delete()

INLINE void gum::InternalNode::operator delete ( void * p )

Delete operator.

Definition at line 76 of file internalNode_inl.h.

References gum::SmallObjectAllocator::deallocate(), and gum::SmallObjectAllocator::instance().

                                             {
     SmallObjectAllocator::instance().deallocate(p, sizeof(InternalNode));
   }

Here is the call graph for this function:

◆ operator new()

INLINE void * gum::InternalNode::operator new ( size_t s )

New operator.

Definition at line 71 of file internalNode_inl.h.

References gum::SmallObjectAllocator::allocate(), and gum::SmallObjectAllocator::instance().

                                            {
     return SmallObjectAllocator::instance().allocate(s);
   }

Here is the call graph for this function:

◆ parents() [1/2]

INLINE Link< Parent > * gum::InternalNode::parents ( )

Returns the list of parents.

Definition at line 95 of file internalNode_inl.h.

Referenced by gum::MultiDimFunctionGraphManager< bool, ExactTerminalNodePolicy >::_migrateNode(), gum::MultiDimFunctionGraphManager< bool, ExactTerminalNodePolicy >::eraseNode(), and gum::MultiDimFunctionGraph< bool, ExactTerminalNodePolicy >::toDot().

95 { return __nodeParents.list(); }

gum::InternalNode::__nodeParents

LinkedList< Parent > __nodeParents

The list of the node's parent.

Definition: internalNode.h:125

Here is the caller graph for this function:

◆ parents() [2/2]

INLINE const Link< Parent > * gum::InternalNode::parents ( ) const

Returns the list of parents.

Definition at line 98 of file internalNode_inl.h.

                                                     {
     return __nodeParents.list();
   }

◆ removeParent()

void gum::InternalNode::removeParent	(	NodeId	parent,
		Idx	modality
	)

Removes a parent.

Definition at line 112 of file internalNode.cpp.

References __nodeParents.

                                                              {
     __nodeParents.searchAndRemoveLink(Parent(parent, modality));
   }

◆ setNode()

void gum::InternalNode::setNode	(	const DiscreteVariable *	v,
		NodeId *	sons
	)

Allows you to respecify the node, changing its attached variable as well as its son map.

Warning: You'd better known what you're doing if you're using this one. sons must have the size of domainSize of v or the program will fail!

Definition at line 86 of file internalNode.cpp.

References __nodeSons, __nodeVar, and deallocateNodeSons().

                                                                     {
     if (__nodeVar != nullptr) deallocateNodeSons(__nodeVar, __nodeSons);
     __nodeVar = v;
     __nodeSons = sons;
   }

Here is the call graph for this function:

◆ setNodeVar()

void gum::InternalNode::setNodeVar ( const DiscreteVariable * v )

Set the node variable.

Definition at line 95 of file internalNode.cpp.

References __nodeSons, __nodeVar, __setNodeVar(), and deallocateNodeSons().

                                                          {
     if (__nodeVar != nullptr) deallocateNodeSons(__nodeVar, __nodeSons);
     __setNodeVar(v);
   }

Here is the call graph for this function:

◆ setSon()

INLINE void gum::InternalNode::setSon	(	Idx	modality,
		NodeId	son
	)

Sets the node's son.

Definition at line 84 of file internalNode_inl.h.

References gum::Parent::modality.

                                                     {
     __nodeSons[modality] = son;
   }

◆ son()

INLINE NodeId gum::InternalNode::son ( Idx modality ) const

Returns the son at a given index.

Definition at line 89 of file internalNode_inl.h.

References gum::Parent::modality.

89 { return __nodeSons[modality]; }

gum::InternalNode::__nodeSons

NodeId * __nodeSons

Table of sons of the node.

Definition: internalNode.h:122

Here is the caller graph for this function:

Member Data Documentation

◆ __nodeParents

LinkedList< Parent > gum::InternalNode::__nodeParents

private

The list of the node's parent.

Definition at line 125 of file internalNode.h.

Referenced by addParent(), and removeParent().

◆ __nodeSons

NodeId* gum::InternalNode::__nodeSons

private

Table of sons of the node.

Each son is bound to a modality of the variable. So those modalities are used has indexes for that table.

_____________________________
|      |      |      |      |
| son1 | son2 | son3 | son4 |
|______|______|______|______|
   x1     x2     x3     x4

Definition at line 122 of file internalNode.h.

Referenced by __setNodeVar(), InternalNode(), setNode(), setNodeVar(), and ~InternalNode().

◆ __nodeVar

const DiscreteVariable* gum::InternalNode::__nodeVar

private

Variable associated to such node.

Definition at line 105 of file internalNode.h.

Referenced by __setNodeVar(), InternalNode(), setNode(), setNodeVar(), and ~InternalNode().

The documentation for this class was generated from the following files:

agrum/multidim/utils/FunctionGraphUtilities/internalNode.h
agrum/multidim/utils/FunctionGraphUtilities/internalNode.cpp
agrum/multidim/utils/FunctionGraphUtilities/internalNode_inl.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ InternalNode() [1/3]

◆ InternalNode() [2/3]

◆ InternalNode() [3/3]

◆ ~InternalNode()

Member Function Documentation

◆ __setNodeVar()

◆ addParent()

◆ allocateNodeSons()

◆ deallocateNodeSons()

◆ nbSons()

◆ nodeVar()

◆ operator delete()

◆ operator new()

◆ parents() [1/2]

◆ parents() [2/2]

◆ removeParent()

◆ setNode()

◆ setNodeVar()

◆ setSon()

◆ son()

Member Data Documentation

◆ __nodeParents

◆ __nodeSons

◆ __nodeVar