CYCLUS
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 http://en.wikipedia.org/wiki/Bipartite_graph). 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

cyclus::Arc::Arc ( )
inline

default required for usage in maps

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

Definition at line 72 of file exchange_graph.h.

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

Definition at line 58 of file exchange_graph.cc.

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

Definition at line 82 of file exchange_graph.cc.

Member Function Documentation

double cyclus::Arc::excl_val ( ) const
inline

Definition at line 98 of file exchange_graph.h.

bool cyclus::Arc::exclusive ( ) const
inline

Definition at line 97 of file exchange_graph.h.

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

Definition at line 86 of file exchange_graph.h.

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

Definition at line 78 of file exchange_graph.h.

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

Definition at line 91 of file exchange_graph.h.

double cyclus::Arc::pref ( ) const
inline

Definition at line 99 of file exchange_graph.h.

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

Definition at line 100 of file exchange_graph.h.

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

Definition at line 95 of file exchange_graph.h.

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

Definition at line 96 of file exchange_graph.h.


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