GCC Middle and Back End API Reference
dnode< GraphTraits > Class Template Referenceabstract

#include <digraph.h>

Inheritance diagram for dnode< GraphTraits >:
Collaboration diagram for dnode< GraphTraits >:

Public Types

typedef GraphTraits::edge_t edge_t
typedef GraphTraits::dump_args_t dump_args_t

Public Member Functions

virtual ~dnode ()
virtual void dump_dot (graphviz_out *gv, const dump_args_t &args) const =0
void add_in_edge (edge_t *e)
void remove_in_edge (edge_t *e)
void add_out_edge (edge_t *e)
void remove_out_edge (edge_t *e)

Data Fields

auto_vec< edge_t * > m_preds
auto_vec< edge_t * > m_succs

Static Private Member Functions

static unsigned find_edge_idx (auto_vec< edge_t * > &edges, edge_t *e)

Detailed Description

template<typename GraphTraits>
class dnode< GraphTraits >
Template classes for directed graphs.
   Copyright (C) 2019-2026 Free Software Foundation, Inc.
   Contributed by David Malcolm <dmalcolm@redhat.com>.

This file is part of GCC.

GCC is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3, or (at your option)
any later version.

GCC is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING3.  If not see
<http://www.gnu.org/licenses/>.   
Templates for a family of classes: digraph, node, edge, and cluster.
This assumes a traits type with the following typedefs:
node_t: the node class
edge_t: the edge class
dump_args_t: additional args for dot-dumps
cluster_t: the cluster class (for use when generating .dot files).

Using a template allows for typesafe nodes and edges: a node's
predecessor and successor edges can be of a node-specific edge
subclass, without needing casting.   
Abstract base class for a node in a directed graph.   

Member Typedef Documentation

◆ dump_args_t

template<typename GraphTraits>
typedef GraphTraits::dump_args_t dnode< GraphTraits >::dump_args_t

◆ edge_t

template<typename GraphTraits>
typedef GraphTraits::edge_t dnode< GraphTraits >::edge_t

Constructor & Destructor Documentation

◆ ~dnode()

template<typename GraphTraits>
virtual dnode< GraphTraits >::~dnode ( )
inlinevirtual

Member Function Documentation

◆ add_in_edge()

template<typename GraphTraits>
void dnode< GraphTraits >::add_in_edge ( edge_t * e)
inline

References m_preds.

◆ add_out_edge()

template<typename GraphTraits>
void dnode< GraphTraits >::add_out_edge ( edge_t * e)
inline

References m_succs.

◆ dump_dot()

template<typename GraphTraits>
virtual void dnode< GraphTraits >::dump_dot ( graphviz_out * gv,
const dump_args_t & args ) const
pure virtual

◆ find_edge_idx()

template<typename GraphTraits>
unsigned dnode< GraphTraits >::find_edge_idx ( auto_vec< edge_t * > & edges,
edge_t * e )
inlinestaticprivate

References gcc_unreachable, and i.

Referenced by remove_in_edge(), and remove_out_edge().

◆ remove_in_edge()

template<typename GraphTraits>
void dnode< GraphTraits >::remove_in_edge ( edge_t * e)
inline

References find_edge_idx(), and m_preds.

◆ remove_out_edge()

template<typename GraphTraits>
void dnode< GraphTraits >::remove_out_edge ( edge_t * e)
inline

References find_edge_idx(), and m_succs.

Field Documentation

◆ m_preds

◆ m_succs

template<typename GraphTraits>
auto_vec<edge_t *> dnode< GraphTraits >::m_succs

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