gum::Link< T > Class Template Reference

Link of a chain list allocated using the SmallObjectAllocator. More...

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

Public Member Functions
Constructors and Destructors
	Link (const T &elem)
	Constructor. More...
	Link (const T &elem, Link< T > *nextLink)
	Constructor that insert link before the given link. More...
	~Link ()
	Destructor. More...
void *	operator new (size_t s)
	Operator new overload to use the SmallObjectAllocator. More...
void	operator delete (void *p)
	Operator delete overload to use the SmallObjectAllocator. More...
Getters and setters
const T &	element () const
	Returns the element stored in this link. More...
T &	element ()
	Returns the element stored in this link. More...
const Link< T > *	nextLink () const
	Returns next link. More...
Link< T > *	nextLink ()
	Returns next link. More...
void	setNextLink (Link< T > *newLink)
	Sets the next link. More...

Detailed Description

template<typename T>
class gum::Link< T >

Link of a chain list allocated using the SmallObjectAllocator.

Template Parameters

T	The type stored by the chain list.

Definition at line 48 of file link.h.

Constructor & Destructor Documentation

Link() [1/2]

template<typename T>

INLINE gum::Link< T >::Link ( const T &  elem )

explicit

Constructor.

Definition at line 35 of file link_tpl.h.

                                      : __element(elem) {
    GUM_CONSTRUCTOR(Link);
  }

Link() [2/2]

template<typename T>

INLINE gum::Link< T >::Link	(	const T &	elem,
		Link< T > *	nextLink
	)

Constructor that insert link before the given link.

Definition at line 41 of file link_tpl.h.

                                                           :
      __element(elem), __nextLink(nextLink) {
    GUM_CONSTRUCTOR(Link);
  }

~Link()

template<typename T >

INLINE gum::Link< T >::~Link

(

)

Destructor.

Definition at line 48 of file link_tpl.h.

                          {
    GUM_DESTRUCTOR(Link);
  }

Member Function Documentation

element() [1/2]

template<typename T >

INLINE const T & gum::Link< T >::element

(

)

const

Returns the element stored in this link.

Definition at line 63 of file link_tpl.h.

Referenced by gum::MultiDimFunctionGraphManager< bool, ExactTerminalNodePolicy >::__checkIsomorphism(), gum::Regress< GUM_SCALAR, COMBINEOPERATOR, PROJECTOPERATOR, TerminalNodePolicy >::__findRetrogradeVariables(), gum::MultiDimFunctionGraphOperator< GUM_SCALAR, FUNCTOR, TerminalNodePolicy >::__findRetrogradeVariables(), gum::MultiDimFunctionGraphManager< bool, ExactTerminalNodePolicy >::_migrateNode(), gum::MultiDimFunctionGraphManager< bool, ExactTerminalNodePolicy >::_reduce(), gum::LeastSquareTestPolicy< GUM_SCALAR >::add(), gum::LeastSquareTestPolicy< GUM_SCALAR >::computeScore(), gum::MultiDimFunctionGraphManager< bool, ExactTerminalNodePolicy >::eraseNode(), gum::MultiDimFunctionGraphGenerator::generate(), gum::StructuredPlaner< double >::optimalPolicy2String(), gum::LinkedList< gum::Parent >::searchAndRemoveLink(), gum::MultiDimFunctionGraph< bool, ExactTerminalNodePolicy >::toDot(), and gum::IncrementalGraphLearner< AttributeSelection, isScalar >::updateVar().

                                           {
    return __element;
  }

Here is the caller graph for this function:

element() [2/2]

template<typename T >

INLINE T & gum::Link< T >::element

(

)

Returns the element stored in this link.

Definition at line 68 of file link_tpl.h.

                               {
    return __element;
  }

nextLink() [1/2]

template<typename T >

INLINE const Link< T > * gum::Link< T >::nextLink

(

)

const

Returns next link.

Definition at line 73 of file link_tpl.h.

Referenced by gum::MultiDimFunctionGraphManager< bool, ExactTerminalNodePolicy >::__checkIsomorphism(), gum::Regress< GUM_SCALAR, COMBINEOPERATOR, PROJECTOPERATOR, TerminalNodePolicy >::__findRetrogradeVariables(), gum::MultiDimFunctionGraphOperator< GUM_SCALAR, FUNCTOR, TerminalNodePolicy >::__findRetrogradeVariables(), gum::MultiDimFunctionGraphManager< bool, ExactTerminalNodePolicy >::_migrateNode(), gum::MultiDimFunctionGraphManager< bool, ExactTerminalNodePolicy >::_reduce(), gum::LeastSquareTestPolicy< GUM_SCALAR >::add(), gum::LinkedList< gum::Parent >::clear(), gum::LeastSquareTestPolicy< GUM_SCALAR >::computeScore(), gum::MultiDimFunctionGraphManager< bool, ExactTerminalNodePolicy >::eraseNode(), gum::MultiDimFunctionGraphGenerator::generate(), gum::MultiDimFunctionGraphManager< bool, ExactTerminalNodePolicy >::minimizeSize(), gum::StructuredPlaner< double >::optimalPolicy2String(), gum::LinkedList< gum::Parent >::searchAndRemoveLink(), gum::MultiDimFunctionGraph< bool, ExactTerminalNodePolicy >::toDot(), and gum::IncrementalGraphLearner< AttributeSelection, isScalar >::updateVar().

                                                    {
    return __nextLink;
  }

Here is the caller graph for this function:

nextLink() [2/2]

template<typename T >

INLINE Link< T > * gum::Link< T >::nextLink

(

)

Returns next link.

Definition at line 78 of file link_tpl.h.

                                        {
    return __nextLink;
  }

operator delete()

template<typename T >

INLINE void gum::Link< T >::operator delete

(

void *

p

)

Operator delete overload to use the SmallObjectAllocator.

Definition at line 58 of file link_tpl.h.

                                                {
    SmallObjectAllocator::instance().deallocate(p, sizeof(Link< T >));
  }

operator new()

template<typename T >

INLINE void * gum::Link< T >::operator new

(

size_t

s

)

Operator new overload to use the SmallObjectAllocator.

Definition at line 53 of file link_tpl.h.

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

setNextLink()

template<typename T>

INLINE void gum::Link< T >::setNextLink

(

Link< T > *

newLink

)

Sets the next link.

Definition at line 83 of file link_tpl.h.

Referenced by gum::LinkedList< gum::Parent >::searchAndRemoveLink().

                                                       {
    __nextLink = newLink;
  }

Here is the caller graph for this function:

Member Data Documentation

__element

template<typename T>

T gum::Link< T >::__element

private

The element embedded in this link.

Definition at line 115 of file link.h.

__nextLink

template<typename T>

Link< T >* gum::Link< T >::__nextLink

private

The next link in the list.

Definition at line 118 of file link.h.

---

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

• agrum/multidim/utils/FunctionGraphUtilities/link.h
• agrum/multidim/utils/FunctionGraphUtilities/link_tpl.h