Arc of a flow network implemented with adjacency lists. More...

#include <tpl_net.H>

Inheritance diagram for Aleph::Net_Arc< Arc_Info, F_Type >:

Collaboration diagram for Aleph::Net_Arc< Arc_Info, F_Type >:

Public Types
using	Base = Graph_Aarc< Arc_Info >

using	Flow_Type = F_Type

Public Types inherited from GTArcCommon< Arc_Info >
using	Item_Type = Arc_Info

using	Arc_Type = Arc_Info

Public Member Functions
bool	check_arc () const noexcept
	Return true if flow satisfies 0 <= flow <= cap.

	Net_Arc (const Arc_Info &info)
	Construct from arc info.

	Net_Arc (const Net_Arc &arc)
	Copy constructor.

	Net_Arc ()
	Default constructor.

Net_Arc &	operator= (const Net_Arc &arc)
	Copy assignment.

Public Member Functions inherited from Aleph::Graph_Aarc< Arc_Info >
	Graph_Aarc (const Arc_Info &info)

	Graph_Aarc (Arc_Info &&info=Arc_Info())

	Graph_Aarc (const Graph_Aarc &arc)

	Graph_Aarc (void src, void tgt, const Arc_Info &data)

	Graph_Aarc (void src, void tgt, Arc_Info &&data=Arc_Info())

Graph_Aarc &	operator= (const Graph_Aarc &arc)

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 GTArcCommon< Arc_Info >
	GTArcCommon () noexcept=default
	data contained in arc

	GTArcCommon (const Arc_Info &info)
	Construct from info value (copy)

	GTArcCommon (Arc_Info &&info)
	Construct from info value (move)

	GTArcCommon (void src, void tgt, const Arc_Info &data)
	Construct with endpoints and info (copy)

	GTArcCommon (void src, void tgt, Arc_Info &&data=Arc_Info())
	Construct with endpoints and info (move)

	GTArcCommon (const GTArcCommon &other)
	Copy constructor.

	GTArcCommon (GTArcCommon &&other) noexcept
	Move constructor.

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

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

unsigned int	state () const noexcept
	Return the state of arc.

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

Arc_Info &	get_info () noexcept
	Return a modifiable reference to the arc data.

const Arc_Info &	get_info () const noexcept
	Return a constant reference to the arc data.

void *	get_connected_node (void *node) noexcept

void *	get_img_node (void *node) noexcept

Public Attributes
Flow_Type	cap = 0
	Capacity value.

Flow_Type	flow = 0
	Flow value.

Public Attributes inherited from GTArcCommon< Arc_Info >
void *	src_node

void *	tgt_node
	Please don't use.

Graph_Attr	attrs
	Please don't use.

Arc_Info	arc_info

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

Dlink *	next

Detailed Description

template<typename Arc_Info, typename F_Type = double>
struct Aleph::Net_Arc< Arc_Info, F_Type >

Arc of a flow network implemented with adjacency lists.

Net_Arc models a capacitated network arc with Arc_Info and a numeric Flow_Type for capacity and flow.

This class is only intended as the arc type for Net_Graph; do not instantiate it directly. Use Net_Graph::insert_arc() instead.

See also: Array_Graph Net_Graph Net_Node

Definition at line 114 of file tpl_net.H.

Member Typedef Documentation

◆ Base

template<typename Arc_Info , typename F_Type = double>

using Aleph::Net_Arc< Arc_Info, F_Type >::Base = Graph_Aarc<Arc_Info>

Definition at line 116 of file tpl_net.H.

◆ Flow_Type

template<typename Arc_Info , typename F_Type = double>

using Aleph::Net_Arc< Arc_Info, F_Type >::Flow_Type = F_Type

Definition at line 118 of file tpl_net.H.

Constructor & Destructor Documentation

◆ Net_Arc() [1/3]

template<typename Arc_Info , typename F_Type = double>

Aleph::Net_Arc< Arc_Info, F_Type >::Net_Arc ( const Arc_Info & info )

inline

Construct from arc info.

Definition at line 130 of file tpl_net.H.

◆ Net_Arc() [2/3]

template<typename Arc_Info , typename F_Type = double>

Aleph::Net_Arc< Arc_Info, F_Type >::Net_Arc ( const Net_Arc< Arc_Info, F_Type > & arc )

inline

Copy constructor.

Definition at line 136 of file tpl_net.H.

◆ Net_Arc() [3/3]

template<typename Arc_Info , typename F_Type = double>

Aleph::Net_Arc< Arc_Info, F_Type >::Net_Arc ( )

inline

Default constructor.

Definition at line 143 of file tpl_net.H.

Member Function Documentation

◆ check_arc()

template<typename Arc_Info , typename F_Type = double>

bool Aleph::Net_Arc< Arc_Info, F_Type >::check_arc ( ) const

inlinenoexcept

Return true if flow satisfies 0 <= flow <= cap.

Definition at line 127 of file tpl_net.H.

References Aleph::Net_Arc< Arc_Info, F_Type >::cap, Aleph::Net_Arc< Arc_Info, F_Type >::flow, and Aleph::maps().

◆ operator=()

template<typename Arc_Info , typename F_Type = double>

Net_Arc & Aleph::Net_Arc< Arc_Info, F_Type >::operator= ( const Net_Arc< Arc_Info, F_Type > & arc )

inline

Copy assignment.

Definition at line 148 of file tpl_net.H.

References Aleph::Net_Arc< Arc_Info, F_Type >::cap, and Aleph::Net_Arc< Arc_Info, F_Type >::flow.

Referenced by Aleph::Net_Cost_Arc< Arc_Info, F_Type >::operator=().

Member Data Documentation

◆ cap

template<typename Arc_Info , typename F_Type = double>

Flow_Type Aleph::Net_Arc< Arc_Info, F_Type >::cap = 0

Capacity value.

Definition at line 121 of file tpl_net.H.

Referenced by Aleph::Net_Arc< Arc_Info, F_Type >::check_arc(), and Aleph::Net_Arc< Arc_Info, F_Type >::operator=().

◆ flow

template<typename Arc_Info , typename F_Type = double>

Flow_Type Aleph::Net_Arc< Arc_Info, F_Type >::flow = 0

Flow value.

Definition at line 124 of file tpl_net.H.

Referenced by Aleph::Net_Arc< Arc_Info, F_Type >::check_arc(), Aleph::Net_Cost_Arc< Arc_Info, F_Type >::flow_cost(), and Aleph::Net_Arc< Arc_Info, F_Type >::operator=().

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

tpl_net.H

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

◆ Flow_Type

Constructor & Destructor Documentation

◆ Net_Arc() [1/3]

◆ Net_Arc() [2/3]

◆ Net_Arc() [3/3]

Member Function Documentation

◆ check_arc()

◆ operator=()

Member Data Documentation

◆ cap

◆ flow