Ophidian
 All Classes Namespaces Functions
Public Types | Public Member Functions | Static Public Member Functions | List of all members
ophidian::interconnection::rc_tree Class Reference

RC Tree Class. More...

#include <rc_tree.h>

Public Types

using graph_t = lemon::ListGraph
 
using capacitor_id = lemon::ListGraph::Node
 
using resistor_id = lemon::ListGraph::Edge
 
using resistor_it = lemon::ListGraph::IncEdgeIt
 

Public Member Functions

 rc_tree ()
 Creates an RC Tree.
 
 rc_tree (const rc_tree &other)
 Copies an RC Tree.
 
rc_treeoperator= (const rc_tree &other)
 Assigns the contents from another RC Tree, replacing its current. More...
 
virtual ~rc_tree ()
 RC Tree destructor.
 
quantity< si::capacitance > lumped () const
 Returns the sum of the capacitance of all capacitors in the RC Tree. More...
 
void tap_insert (capacitor_id cap)
 Set a capacitor as a tap node of the RC Tree.
 
capacitor_id capacitor_insert (std::string name)
 Capacitor insertion. More...
 
std::string capacitor_name (capacitor_id u) const
 Return capacitor's name. More...
 
std::size_t capacitor_count () const
 Number of Capacitors. More...
 
resistor_id resistor_insert (capacitor_id u, capacitor_id v, quantity< si::resistance > res)
 
void capacitance (capacitor_id u, quantity< si::capacitance > cap)
 
capacitor_id capacitor_by_name (std::string name) const
 
quantity< si::capacitance > capacitance (capacitor_id u) const
 
quantity< si::resistance > resistance (resistor_id uv) const
 
resistor_it capacitor_resistors (capacitor_id u) const
 
capacitor_id other_capacitor (resistor_id res, capacitor_id cap) const
 
const graph_t & graph () const
 
packed_rc_tree pack (capacitor_id source) const
 

Static Public Member Functions

static resistor_it invalid ()
 

Detailed Description

A graph where the vertex set represents capacitors and the edge set represents resistors.

Member Function Documentation

std::size_t ophidian::interconnection::rc_tree::capacitor_count ( ) const
inline

Returns the number of capacitors.

Returns
The number of capacitors.
lemon::ListGraph::Node ophidian::interconnection::rc_tree::capacitor_insert ( std::string  name)

Inserts a capacitor.

Parameters
nameThe name of the capacitor. The names must be unique.
Returns
The handler to the capacitor.
std::string ophidian::interconnection::rc_tree::capacitor_name ( capacitor_id  u) const
inline

Returns the name of a capacitor.

Parameters
uhandler to a capacitor.
Returns
The name of the capacitor u.
quantity<si::capacitance> ophidian::interconnection::rc_tree::lumped ( ) const
inline

Return Lumped Capacitance.

Returns
The RC Tree's lumped capacitance.
rc_tree & ophidian::interconnection::rc_tree::operator= ( const rc_tree other)
Parameters
other_capacitor(resistor_idres, capacitor_id cap) const
Returns
*this

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