Node belonging to a graph implemented with a double linked adjacency list. More...

#include <tpl_graph.H>

Inheritance diagram for Aleph::Graph_Node< __Node_Info >:

Collaboration diagram for Aleph::Graph_Node< __Node_Info >:

Public Types
using	Base = GTNodeCommon< __Node_Info >

using	Node_Info = __Node_Info

Public Types inherited from GTNodeCommon< NodeInfo >
using	Item_Type = NodeInfo

using	Node = GTNodeCommon
	Common alias for set types.

using	Node_Type = NodeInfo
	The node.

Public Member Functions
	Graph_Node (const Node_Info &info) noexcept
	The type of data stored in the node.

	Graph_Node (Node_Info &&info=Node_Info()) noexcept
	Move or rvalue constructor.

	Graph_Node (const Graph_Node &node) noexcept

Graph_Node &	operator= (const Graph_Node &node)

	Graph_Node (Graph_Node *node)
	Copy constructor from a node pointer.

Public Member Functions inherited from Aleph::Dlink
template<typename T >
Dnode< T > *	to_dnode () noexcept

template<typename T >
const Dnode< T > *	to_dnode () const noexcept

template<typename T >
T &	to_data () noexcept

template<typename T >
const T &	to_data () const noexcept

	Dlink () noexcept
	Initialize a node or an empty list.

	Dlink (const Dlink &l) noexcept
	Copy constructor.

void	swap (Dlink *link) noexcept
	Swap `this` with list whose header is `link`.

void	swap (Dlink &l) noexcept
	Swap `this` with list whose header is `l`.

	Dlink (Dlink &&l) noexcept
	Construct a new list with the items of l moved.

Dlink &	operator= (const Dlink &l) noexcept
	Copy assignation.

Dlink &	operator= (Dlink &&l) noexcept
	Move assignation.

void	reset () noexcept
	Reset `this`

void	init () noexcept

constexpr bool	is_empty () const noexcept
	Return `true` if `this` (as header node) is empty.

constexpr bool	is_unitarian () const noexcept
	Return `true` if `this` (as header node) has exactly one element.

constexpr bool	is_unitarian_or_empty () const noexcept
	Return `true` if `this` (as header node) has zero or one element.

void	insert (Dlink *node) noexcept
	Insert `node` after `this`.

void	push (Dlink *node) noexcept

void	append (Dlink *node) noexcept
	Insert `node` before `this`.

Dlink *&	get_next () const noexcept
	Return the link that is after `this`

Dlink *&	get_prev () const noexcept
	Return the link that is before `this`

constexpr Dlink *&	get_first_ne () const noexcept
	If `this` is a header node, it return the first node of `this`

constexpr Dlink *&	get_last_ne () const noexcept
	If `this` is a header node, it return the last node of `this`

constexpr Dlink *&	get_first () const noexcept
	If `this` is a header node, it return the first node of `this`

constexpr Dlink *&	get_last () const noexcept
	If `this` is a header node, it return the last node of `this`

void	wrap_header (Dlink *l) noexcept
	Wrap a header to a list (without header).

void	insert_list (Dlink *head) noexcept
	Insert the list `head` before `this`

void	append_list (Dlink *head) noexcept
	Insert the list `head` after `this`

void	splice (Dlink *l) noexcept
	Insert a list `l` without header node after the node `this`.

void	concat_list (Dlink *head) noexcept
	Concatenate list `head` to list `this`

void	concat_list (Dlink &head) noexcept

Dlink *	del () noexcept
	Remove `this` from the list. `this` must not be a header node.

void	erase () noexcept

Dlink *	remove_prev () noexcept
	Remove the item that is before `this`

Dlink *	remove_next () noexcept
	Remove the item that is after `this`

Dlink *	remove_last_ne () noexcept

Dlink *	remove_first_ne () noexcept

Dlink *	remove_last () noexcept

Dlink *	remove_first () noexcept

Dlink *	top () const

Dlink *	pop ()

size_t	reverse_list () noexcept
	Reverse the list.

size_t	reverse () noexcept

size_t	split_list_ne (Dlink &l, Dlink &r) noexcept
	Split `this` in the middle in two lists.

size_t	split_list (Dlink &l, Dlink &r) noexcept

Dlink	cut_list (Dlink *link) noexcept
	Cut `this` from `link`.

void	remove_all_and_delete () noexcept
	Remove and free memory for all the items of list.

void	rotate_left (size_t n)
	Rotate to left the list n positions.

void	rotate_right (size_t n)
	Analogous to rotate_left() but to right.

bool	check ()
	Return `true` if the list is consistent.

Public Member Functions inherited from GTNodeCommon< NodeInfo >
	GTNodeCommon () noexcept=default
	another alias for set type

	GTNodeCommon (const NodeInfo &info)
	Copy constructor from info value.

	GTNodeCommon (NodeInfo &&info)
	Move constructor from info value.

	GTNodeCommon (const GTNodeCommon &other)
	Copy constructor.

	GTNodeCommon (GTNodeCommon &&other) noexcept
	Move constructor.

GTNodeCommon &	operator= (const GTNodeCommon &other)
	Copy assignment operator.

GTNodeCommon &	operator= (GTNodeCommon &&other) noexcept
	Move assignment operator.

NodeInfo &	get_info () noexcept
	Return a modifiable reference to the data contained in the node.

const NodeInfo &	get_info () const noexcept
	Return a constant reference to the data contained in the node.

unsigned int	state () const noexcept
	Return the state's value.

void	set_state (unsigned int s) noexcept
	Set the state to value `s`

Public Attributes
Dlink	arc_list

Public Attributes inherited from GTNodeCommon< NodeInfo >
Graph_Attr	attrs
	Attributes of node.

NodeInfo	node_info

size_t	num_arcs = 0
	data associated to the node. Access it with get_info()

Friends
class	GTNodeCommon< __Node_Info >

class	Arc_Node

Additional Inherited Members
Protected Attributes inherited from Aleph::Dlink
Dlink *	prev

Dlink *	next

Detailed Description

template<typename __Node_Info = Empty_Class>
struct Aleph::Graph_Node< __Node_Info >

Node belonging to a graph implemented with a double linked adjacency list.

This class is used for defining a node of the graph implemented with double-linked adjacency lists.

Basically, there are three ways for defining the information to be stored in a node:

Specifying the data as a template parameter of this class.
By inheriting from this class and in the derived class to define the data
Combination of two above

Note: The purpose of this class is only for specifying the node of a graph. It is not intended for declaration. Use the internal node subclass instead. Although you could access data and function members of this class, at the exception to get_info() it is not advisable to use them. They are accessible for implementation purposes.; A node has three additional attributes: the control bits, the counter and the cookie.

See also: List_Graph List_Digraph Graph_Arc Bit_Fields

Definition at line 118 of file tpl_graph.H.

Member Typedef Documentation

◆ Base

template<typename __Node_Info = Empty_Class>

using Aleph::Graph_Node< __Node_Info >::Base = GTNodeCommon<__Node_Info>

Definition at line 125 of file tpl_graph.H.

◆ Node_Info

template<typename __Node_Info = Empty_Class>

using Aleph::Graph_Node< __Node_Info >::Node_Info = __Node_Info

Definition at line 126 of file tpl_graph.H.

Constructor & Destructor Documentation

◆ Graph_Node() [1/4]

template<typename __Node_Info = Empty_Class>

Aleph::Graph_Node< __Node_Info >::Graph_Node ( const Node_Info & info )

inlinenoexcept

The type of data stored in the node.

Copy constructor.

Construct a node whose data is copied from info. The control attributes are reset.

Parameters

[in] info data to copy to the node

Note: The copy constructor of Node_Info must be defined

Definition at line 137 of file tpl_graph.H.

◆ Graph_Node() [2/4]

template<typename __Node_Info = Empty_Class>

Aleph::Graph_Node< __Node_Info >::Graph_Node ( Node_Info && info = Node_Info() )

inlinenoexcept

Move or rvalue constructor.

Construct a node whose data is moved from info. The control attributes are reset.

Parameters

[in] info data to move to the node

Note: The move constructor of Node_Info must be defined

Definition at line 150 of file tpl_graph.H.

◆ Graph_Node() [3/4]

template<typename __Node_Info = Empty_Class>

Aleph::Graph_Node< __Node_Info >::Graph_Node ( const Graph_Node< __Node_Info > & node )

inlinenoexcept

Definition at line 156 of file tpl_graph.H.

◆ Graph_Node() [4/4]

template<typename __Node_Info = Empty_Class>

Aleph::Graph_Node< __Node_Info >::Graph_Node ( Graph_Node< __Node_Info > * node )

inline

Copy constructor from a node pointer.

Creates a node and assigns node->get_info() as the value of the information contained in the node.

The control bits and the counter values are set to zero. The cookie is set to nullptr.

Parameters

[in] node pointer to the node from which the information value to be assigned to the newly created node is copied.

Note: The copy constructor of the Node_Info class must be defined.; The created instance is a different node from node.

Definition at line 184 of file tpl_graph.H.

Member Function Documentation

◆ operator=()

template<typename __Node_Info = Empty_Class>

Graph_Node & Aleph::Graph_Node< __Node_Info >::operator= ( const Graph_Node< __Node_Info > & node )

inline

Definition at line 162 of file tpl_graph.H.

References GTNodeCommon< NodeInfo >::node_info.

Friends And Related Symbol Documentation

◆ Arc_Node

template<typename __Node_Info = Empty_Class>

friend class Arc_Node

friend

Definition at line 123 of file tpl_graph.H.

◆ GTNodeCommon< __Node_Info >

template<typename __Node_Info = Empty_Class>

friend class GTNodeCommon< __Node_Info >

friend

Definition at line 3843 of file tpl_graph.H.

Member Data Documentation

◆ arc_list

template<typename __Node_Info = Empty_Class>

Dlink Aleph::Graph_Node< __Node_Info >::arc_list

Definition at line 190 of file tpl_graph.H.

The documentation for this struct was generated from the following file:

tpl_graph.H

Public Types

Public Member Functions

Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

◆ Node_Info

Constructor & Destructor Documentation

◆ Graph_Node() [1/4]

◆ Graph_Node() [2/4]

◆ Graph_Node() [3/4]

◆ Graph_Node() [4/4]

Member Function Documentation

◆ operator=()

Friends And Related Symbol Documentation

◆ Arc_Node

◆ GTNodeCommon< __Node_Info >

Member Data Documentation

◆ arc_list