Public Member Functions | List of all members
cyclus::Arc Class Reference

Detailed Description

An arc represents a possible connection between two nodes in the bipartite resource exchange graph.

It is common to refer to the two sets of nodes in a bipartite graph by the set variables U and V (see By convention, arc.unode() == request node, arc.vnode() == bid node.

Definition at line 67 of file exchange_graph.h.

#include <exchange_graph.h>

Public Member Functions

 Arc ()
 Arc (boost::shared_ptr< ExchangeNode > unode, boost::shared_ptr< ExchangeNode > vnode)
 Arc (const Arc &other)
double excl_val () const
bool exclusive () const
bool operator< (const Arc &rhs) const
Arcoperator= (const Arc &other)
bool operator== (const Arc &rhs) const
double pref () const
void pref (double pref)
boost::shared_ptr< ExchangeNodeunode () const
boost::shared_ptr< ExchangeNodevnode () const

Constructor & Destructor Documentation

◆ Arc() [1/3]

cyclus::Arc::Arc ( )

default required for usage in maps

, in general do not use this constructor; it exists for arcs to be map values

Definition at line 72 of file exchange_graph.h.

◆ Arc() [2/3]

cyclus::Arc::Arc ( boost::shared_ptr< ExchangeNode unode,
boost::shared_ptr< ExchangeNode vnode 

Definition at line 58 of file

◆ Arc() [3/3]

cyclus::Arc::Arc ( const Arc other)

Definition at line 82 of file

Member Function Documentation

◆ excl_val()

double cyclus::Arc::excl_val ( ) const

Definition at line 98 of file exchange_graph.h.

◆ exclusive()

bool cyclus::Arc::exclusive ( ) const

Definition at line 97 of file exchange_graph.h.

◆ operator<()

bool cyclus::Arc::operator< ( const Arc rhs) const

Definition at line 86 of file exchange_graph.h.

◆ operator=()

Arc& cyclus::Arc::operator= ( const Arc other)

Definition at line 78 of file exchange_graph.h.

◆ operator==()

bool cyclus::Arc::operator== ( const Arc rhs) const

Definition at line 91 of file exchange_graph.h.

◆ pref() [1/2]

double cyclus::Arc::pref ( ) const

Definition at line 99 of file exchange_graph.h.

◆ pref() [2/2]

void cyclus::Arc::pref ( double  pref)

Definition at line 100 of file exchange_graph.h.

◆ unode()

boost::shared_ptr<ExchangeNode> cyclus::Arc::unode ( ) const

Definition at line 95 of file exchange_graph.h.

◆ vnode()

boost::shared_ptr<ExchangeNode> cyclus::Arc::vnode ( ) const

Definition at line 96 of file exchange_graph.h.

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