Aleph-w 3.0
A C++ Library for Data Structures and Algorithms
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
GTArcCommon< ArcInfo > Class Template Reference
Graphs

Common methods for the arc of a graph. More...

#include <graph-dry.H>

Inheritance diagram for GTArcCommon< ArcInfo >:
[legend]

Public Types

using Item_Type = ArcInfo
 
using Arc_Type = ArcInfo
 

Public Member Functions

 GTArcCommon () noexcept=default
 data contained in arc
 
 GTArcCommon (const ArcInfo &info)
 Construct from info value (copy)
 
 GTArcCommon (ArcInfo &&info)
 Construct from info value (move)
 
 GTArcCommon (void *src, void *tgt, const ArcInfo &data)
 Construct with endpoints and info (copy)
 
 GTArcCommon (void *src, void *tgt, ArcInfo &&data=ArcInfo())
 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
 
ArcInfo & get_info () noexcept
 Return a modifiable reference to the arc data.
 
const ArcInfo & 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

void * src_node = nullptr
 
void * tgt_node = nullptr
 Please don't use.
 
Graph_Attr attrs
 Please don't use.
 
ArcInfo arc_info
 

Detailed Description

template<typename ArcInfo>
class GTArcCommon< ArcInfo >

Common methods for the arc of a graph.

This class defines common attributes and methods for arcs graphs. All graph arcs inherit the data and function members of this class. Although this class exports data members, it is not recommended to directly access them. Instead use the macros ARC_BITS, ARC_COUNTER and ARC_COOKIE, which define access to the three attributes.

See also
ARC_BITS ARC_COUNTER ARC_COOKIE IS_ARC_VISITED ARC_COLOR
Warning
This class is not intended to be used explicitly by the user. Its use is internal to the graphs implementations.

Definition at line 527 of file graph-dry.H.

Member Typedef Documentation

◆ Arc_Type

template<typename ArcInfo >
using GTArcCommon< ArcInfo >::Arc_Type = ArcInfo

Definition at line 531 of file graph-dry.H.

◆ Item_Type

template<typename ArcInfo >
using GTArcCommon< ArcInfo >::Item_Type = ArcInfo

Definition at line 530 of file graph-dry.H.

Constructor & Destructor Documentation

◆ GTArcCommon() [1/7]

template<typename ArcInfo >
GTArcCommon< ArcInfo >::GTArcCommon ( )
defaultnoexcept

data contained in arc

Default constructor

◆ GTArcCommon() [2/7]

template<typename ArcInfo >
GTArcCommon< ArcInfo >::GTArcCommon ( const ArcInfo &  info)
inline

Construct from info value (copy)

Definition at line 548 of file graph-dry.H.

◆ GTArcCommon() [3/7]

template<typename ArcInfo >
GTArcCommon< ArcInfo >::GTArcCommon ( ArcInfo &&  info)
inline

Construct from info value (move)

Definition at line 551 of file graph-dry.H.

◆ GTArcCommon() [4/7]

template<typename ArcInfo >
GTArcCommon< ArcInfo >::GTArcCommon ( void *  src,
void *  tgt,
const ArcInfo &  data 
)
inline

Construct with endpoints and info (copy)

Definition at line 554 of file graph-dry.H.

◆ GTArcCommon() [5/7]

template<typename ArcInfo >
GTArcCommon< ArcInfo >::GTArcCommon ( void *  src,
void *  tgt,
ArcInfo &&  data = ArcInfo() 
)
inline

Construct with endpoints and info (move)

Definition at line 558 of file graph-dry.H.

◆ GTArcCommon() [6/7]

template<typename ArcInfo >
GTArcCommon< ArcInfo >::GTArcCommon ( const GTArcCommon< ArcInfo > &  other)
inline

Copy constructor.

Definition at line 562 of file graph-dry.H.

◆ GTArcCommon() [7/7]

template<typename ArcInfo >
GTArcCommon< ArcInfo >::GTArcCommon ( GTArcCommon< ArcInfo > &&  other)
inlinenoexcept

Move constructor.

Definition at line 566 of file graph-dry.H.

Member Function Documentation

◆ get_connected_node()

template<typename ArcInfo >
void * GTArcCommon< ArcInfo >::get_connected_node ( void *  node)
inlinenoexcept

Definition at line 600 of file graph-dry.H.

References GTArcCommon< ArcInfo >::src_node, and GTArcCommon< ArcInfo >::tgt_node.

Referenced by Aleph::in_pairs(), and Aleph::out_pairs().

◆ get_img_node()

template<typename ArcInfo >
void * GTArcCommon< ArcInfo >::get_img_node ( void *  node)
inlinenoexcept

Definition at line 605 of file graph-dry.H.

References GTArcCommon< ArcInfo >::src_node, and GTArcCommon< ArcInfo >::tgt_node.

◆ get_info() [1/2]

template<typename ArcInfo >
const ArcInfo & GTArcCommon< ArcInfo >::get_info ( ) const
inlinenoexcept

Return a constant reference to the arc data.

Definition at line 598 of file graph-dry.H.

References GTArcCommon< ArcInfo >::arc_info.

◆ get_info() [2/2]

template<typename ArcInfo >
ArcInfo & GTArcCommon< ArcInfo >::get_info ( )
inlinenoexcept

Return a modifiable reference to the arc data.

Definition at line 595 of file graph-dry.H.

References GTArcCommon< ArcInfo >::arc_info.

Referenced by Aleph::build_subgraph(), copia_Arco_Arco(), Aleph::Matrix_Graph< GT, SA >::copy(), Aleph::invert_digraph(), Aleph::Prim_Min_Spanning_Tree< GT, Distance, SA >::min_spanning_tree(), Aleph::Initialize_Dist< AM >::operator()(), Aleph::Dft_Arc_Attr< GT >::operator()(), Aleph::Invert_Digraph< GT, SA >::operator()(), ArcInitializer::operator()(), GridDistance::operator()(), DoubleDistance::operator()(), Aleph::Init_Arc< GT >::operator()(), DoubleDistance::operator()(), Aleph::Dft_Load_Arc< GT >::operator()(), Aleph::Rarc< GT >::operator()(), Aleph::Dft_Load_Arc< GT >::operator()(), Aleph::Dft_Store_Arc< GT >::operator()(), Aleph::Warc< GT >::operator()(), Aleph::Dft_Store_Arc< GT >::operator()(), WeightFilter< GT >::operator()(), Weight_Filter< GT >::operator()(), Aleph::Dft_Dist< GT >::operator()(), Aleph::Dft_Dist< GT >::operator()(), EvenArcFilter< GT >::operator()(), Even_Arc_Filter< GT >::operator()(), DoubleDistance::set_zero(), Aleph::Dft_Dist< GT >::set_zero(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST_F(), and TEST_F().

◆ operator=() [1/2]

template<typename ArcInfo >
GTArcCommon & GTArcCommon< ArcInfo >::operator= ( const GTArcCommon< ArcInfo > &  other)
inline

Copy assignment operator.

Definition at line 570 of file graph-dry.H.

References GTArcCommon< ArcInfo >::arc_info.

◆ operator=() [2/2]

template<typename ArcInfo >
GTArcCommon & GTArcCommon< ArcInfo >::operator= ( GTArcCommon< ArcInfo > &&  other)
inlinenoexcept

Move assignment operator.

Definition at line 578 of file graph-dry.H.

References GTArcCommon< ArcInfo >::arc_info.

◆ set_state()

template<typename ArcInfo >
void GTArcCommon< ArcInfo >::set_state ( unsigned int  s)
inlinenoexcept

Set the state of arc to value s

Definition at line 589 of file graph-dry.H.

References ARC_BITS.

Referenced by Graph_Traverse< GT, Itor, Q, Show_Arc >::exec(), Graph_Traverse< GT, Itor, Q, Show_Arc >::operator()(), and Graph_Traverse< GT, Itor, Q, Show_Arc >::operator()().

◆ state()

template<typename ArcInfo >
unsigned int GTArcCommon< ArcInfo >::state ( ) const
inlinenoexcept

Return the state of arc.

Definition at line 586 of file graph-dry.H.

References ARC_BITS.

Referenced by Graph_Traverse< GT, Itor, Q, Show_Arc >::exec(), Graph_Traverse< GT, Itor, Q, Show_Arc >::operator()(), and Graph_Traverse< GT, Itor, Q, Show_Arc >::operator()().

Member Data Documentation

◆ arc_info

template<typename ArcInfo >
ArcInfo GTArcCommon< ArcInfo >::arc_info

Definition at line 542 of file graph-dry.H.

Referenced by GTArcCommon< ArcInfo >::get_info(), GTArcCommon< ArcInfo >::get_info(), Aleph::Graph_Aarc< Arc_Info >::operator=(), Aleph::Graph_Arc< _Arc_Info >::operator=(), Aleph::Graph_Sarc< Arc_Info >::operator=(), GTArcCommon< ArcInfo >::operator=(), and GTArcCommon< ArcInfo >::operator=().

◆ attrs

template<typename ArcInfo >
Graph_Attr GTArcCommon< ArcInfo >::attrs

Please don't use.

Arc control attributes.

See also
Graph_Attr

Definition at line 540 of file graph-dry.H.

◆ src_node

template<typename ArcInfo >
void* GTArcCommon< ArcInfo >::src_node = nullptr

Definition at line 533 of file graph-dry.H.

Referenced by GTArcCommon< ArcInfo >::get_connected_node(), GTArcCommon< ArcInfo >::get_img_node(), ArcHeap< GT, Distance, Access_Heap_Node >::get_min_arc(), Aleph::Dft_Arc_Cmp< GT >::operator()(), Aleph::IndexArc< GT, Tree, SA >::search(), Aleph::IndexArc< GT, Tree, SA >::search(), Aleph::IndexArc< GT, Tree, SA >::search_directed(), and TEST().

◆ tgt_node

template<typename ArcInfo >
void* GTArcCommon< ArcInfo >::tgt_node = nullptr

Please don't use.

Definition at line 534 of file graph-dry.H.

Referenced by GTArcCommon< ArcInfo >::get_connected_node(), GTArcCommon< ArcInfo >::get_img_node(), ArcHeap< GT, Distance, Access_Heap_Node >::get_min_arc(), Aleph::Dft_Arc_Cmp< GT >::operator()(), Aleph::IndexArc< GT, Tree, SA >::search(), Aleph::IndexArc< GT, Tree, SA >::search(), Aleph::IndexArc< GT, Tree, SA >::search_directed(), and TEST().

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