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
Arc &	operator= (const Arc &other)
bool	operator== (const Arc &rhs) const
double	pref () const
void	pref (double pref)
boost::shared_ptr< ExchangeNode >	unode () const
boost::shared_ptr< ExchangeNode >	vnode () const

Constructor & Destructor Documentation

Arc() [1/3]

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.

Arc() [2/3]

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

Definition at line 48 of file exchange_graph.cc.

Arc() [3/3]

cyclus::Arc::Arc

(

const Arc &

other

)

Definition at line 72 of file exchange_graph.cc.

Member Function Documentation

excl_val()

double cyclus::Arc::excl_val ( ) const

inline

Definition at line 99 of file exchange_graph.h.

exclusive()

bool cyclus::Arc::exclusive ( ) const

inline

Definition at line 98 of file exchange_graph.h.

operator<()

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

inline

Definition at line 87 of file exchange_graph.h.

operator=()

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

inline

Definition at line 79 of file exchange_graph.h.

operator==()

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

inline

Definition at line 92 of file exchange_graph.h.

pref() [1/2]

double cyclus::Arc::pref ( ) const

inline

Definition at line 100 of file exchange_graph.h.

pref() [2/2]

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

inline

Definition at line 101 of file exchange_graph.h.

unode()

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

inline

Definition at line 96 of file exchange_graph.h.

vnode()

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

inline

Definition at line 97 of file exchange_graph.h.

---

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

• exchange_graph.h
• exchange_graph.cc