Node with supply/demand flow value. More...

#include <tpl_net_sup_dem.H>

Inheritance diagram for Aleph::Net_Sup_Dem_Node< Node_Info, F_Type >:

Collaboration diagram for Aleph::Net_Sup_Dem_Node< Node_Info, F_Type >:

Public Types
using	Flow_Type = F_Type
	Type representing flow values.

using	Base = Graph_Anode< Node_Info >
	Base class type.

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

using	Node = GTNodeCommon
	Common alias for set types.

using	Node_Type = Node_Info
	The node.

Public Member Functions
Flow_Type &	get_supply_flow () noexcept
	Get the supply/demand flow value.

const Flow_Type &	get_supply_flow () const noexcept
	Get the supply/demand flow value (const version).

	Net_Sup_Dem_Node ()
	Default constructor. Initializes all values to zero.

	Net_Sup_Dem_Node (const Node_Info &node_info)
	Construct node with info.

	Net_Sup_Dem_Node (Net_Sup_Dem_Node *node)
	Copy constructor from pointer.

Public Member Functions inherited from Aleph::Graph_Anode< Node_Info >
	Graph_Anode ()

	Graph_Anode (const Node_Info &info)

	Graph_Anode (Node_Info &&info)

	Graph_Anode (const Graph_Anode &node)

	Graph_Anode (Graph_Anode *p)

Graph_Anode &	operator= (const Graph_Anode &node)

virtual	~Graph_Anode ()

void	allocate_more (size_t new_size)

void *	insert_arc (void *arc)

void	remove_arc_ne (const void *arc) noexcept

void	remove_arc (const void *arc)

bool	compress () noexcept

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< Node_Info >
	GTNodeCommon () noexcept=default
	another alias for set type

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

	GTNodeCommon (Node_Info &&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.

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

const Node_Info &	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
Flow_Type	supply_flow = Flow_Type{0}
	Supply flow value: positive = supply, negative = demand, zero = transit.

Flow_Type	out_cap = Flow_Type{0}
	Outgoing capacity constraint.

Flow_Type	in_cap = Flow_Type{0}
	Incoming capacity constraint.

Flow_Type	out_flow = Flow_Type{0}
	Tracked outgoing flow.

Flow_Type	in_flow = Flow_Type{0}
	Tracked incoming flow.

Public Attributes inherited from Aleph::Graph_Anode< Node_Info >
void **	arc_array

size_t	arcs_dim

size_t	contract_threshold

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

Node_Info	node_info

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

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

Dlink *	next

Detailed Description

template<typename Node_Info, typename F_Type = long>
class Aleph::Net_Sup_Dem_Node< Node_Info, F_Type >

Node with supply/demand flow value.

Extends Net_Node with a supply_flow attribute that indicates:

Positive value: the node supplies (produces) that amount of flow
Negative value: the node demands (consumes) the absolute amount
Zero: the node is a transit node (neither supplies nor demands)

Template Parameters

Node_Info	Type of information stored in the node
F_Type	Type representing flow values (default: long)

Definition at line 119 of file tpl_net_sup_dem.H.

Member Typedef Documentation

◆ Base

template<typename Node_Info , typename F_Type = long>

using Aleph::Net_Sup_Dem_Node< Node_Info, F_Type >::Base = Graph_Anode<Node_Info>

Base class type.

Definition at line 126 of file tpl_net_sup_dem.H.

◆ Flow_Type

template<typename Node_Info , typename F_Type = long>

using Aleph::Net_Sup_Dem_Node< Node_Info, F_Type >::Flow_Type = F_Type

Type representing flow values.

Definition at line 123 of file tpl_net_sup_dem.H.

Constructor & Destructor Documentation

◆ Net_Sup_Dem_Node() [1/3]

template<typename Node_Info , typename F_Type = long>

Aleph::Net_Sup_Dem_Node< Node_Info, F_Type >::Net_Sup_Dem_Node ( )

inline

Default constructor. Initializes all values to zero.

Definition at line 159 of file tpl_net_sup_dem.H.

◆ Net_Sup_Dem_Node() [2/3]

template<typename Node_Info , typename F_Type = long>

Aleph::Net_Sup_Dem_Node< Node_Info, F_Type >::Net_Sup_Dem_Node ( const Node_Info & node_info )

inlineexplicit

Construct node with info.

Creates a node with the given information. Capacity and flow attributes are initialized to zero.

Parameters

node_info Information to store in the node

Definition at line 169 of file tpl_net_sup_dem.H.

◆ Net_Sup_Dem_Node() [3/3]

template<typename Node_Info , typename F_Type = long>

Aleph::Net_Sup_Dem_Node< Node_Info, F_Type >::Net_Sup_Dem_Node ( Net_Sup_Dem_Node< Node_Info, F_Type > * node )

inline

Copy constructor from pointer.

Creates a copy of the node pointed to, including its supply_flow value.

Parameters

node	Pointer to the node to copy

Definition at line 180 of file tpl_net_sup_dem.H.

Member Function Documentation

◆ get_supply_flow() [1/2]

template<typename Node_Info , typename F_Type = long>

const Flow_Type & Aleph::Net_Sup_Dem_Node< Node_Info, F_Type >::get_supply_flow ( ) const

inlinenoexcept

Get the supply/demand flow value (const version).

Returns: Const reference to the supply_flow attribute

Definition at line 153 of file tpl_net_sup_dem.H.

References Aleph::Net_Sup_Dem_Node< Node_Info, F_Type >::supply_flow.

◆ get_supply_flow() [2/2]

template<typename Node_Info , typename F_Type = long>

Flow_Type & Aleph::Net_Sup_Dem_Node< Node_Info, F_Type >::get_supply_flow ( )

inlinenoexcept

Get the supply/demand flow value.

Returns: Reference to the supply_flow attribute

Definition at line 147 of file tpl_net_sup_dem.H.

References Aleph::Net_Sup_Dem_Node< Node_Info, F_Type >::supply_flow.

Member Data Documentation

◆ in_cap

template<typename Node_Info , typename F_Type = long>

Flow_Type Aleph::Net_Sup_Dem_Node< Node_Info, F_Type >::in_cap = Flow_Type{0}

Incoming capacity constraint.

Definition at line 135 of file tpl_net_sup_dem.H.

◆ in_flow

template<typename Node_Info , typename F_Type = long>

Flow_Type Aleph::Net_Sup_Dem_Node< Node_Info, F_Type >::in_flow = Flow_Type{0}

Tracked incoming flow.

Definition at line 141 of file tpl_net_sup_dem.H.

◆ out_cap

template<typename Node_Info , typename F_Type = long>

Flow_Type Aleph::Net_Sup_Dem_Node< Node_Info, F_Type >::out_cap = Flow_Type{0}

Outgoing capacity constraint.

Definition at line 132 of file tpl_net_sup_dem.H.

◆ out_flow

template<typename Node_Info , typename F_Type = long>

Flow_Type Aleph::Net_Sup_Dem_Node< Node_Info, F_Type >::out_flow = Flow_Type{0}

Tracked outgoing flow.

Definition at line 138 of file tpl_net_sup_dem.H.

◆ supply_flow

template<typename Node_Info , typename F_Type = long>

Flow_Type Aleph::Net_Sup_Dem_Node< Node_Info, F_Type >::supply_flow = Flow_Type{0}

Supply flow value: positive = supply, negative = demand, zero = transit.

Definition at line 129 of file tpl_net_sup_dem.H.

Referenced by Aleph::Net_Sup_Dem_Node< Node_Info, F_Type >::get_supply_flow(), and Aleph::Net_Sup_Dem_Node< Node_Info, F_Type >::get_supply_flow().

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

tpl_net_sup_dem.H

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

◆ Flow_Type

Constructor & Destructor Documentation

◆ Net_Sup_Dem_Node() [1/3]

◆ Net_Sup_Dem_Node() [2/3]

◆ Net_Sup_Dem_Node() [3/3]

Member Function Documentation

◆ get_supply_flow() [1/2]

◆ get_supply_flow() [2/2]

Member Data Documentation

◆ in_cap

◆ in_flow

◆ out_cap

◆ out_flow

◆ supply_flow