minsky::Port Class Reference

#include <port.h>

Inheritance diagram for minsky::Port:

Collaboration diagram for minsky::Port:

Public Member Functions
std::vector< Wire * > const &	wires () const
	returns a vector of weak references to the wires attached to this port More...
std::size_t	numWires () const
void	eraseWire (Wire *)
	remove wire from wires. No ownership passed. More...
void	deleteWires ()
	delete all attached wires More...
virtual bool	input () const
	true if input port More...
virtual bool	multiWireAllowed () const
	true if multiple wires are allowed to connect to an input port, such as an input port of an add operation. Irrelevant, otherwise More...
virtual void	combineInput (double &x, double y) const
	combine two input wires More...
virtual double	identity () const
	input port value if no wire attached More...
float	x () const
float	y () const
void	moveTo (float x, float y)
	Port (Item &item)
	~Port ()
double	value () const
	value associated with this port More...
Units	units (bool) const
Units	checkUnits () const
	dimensional analysis with consistency check More...
Item &	item ()
	owner of this port More...
const Item &	item () const
	owner of this port More...

Private Member Functions
	CLASSDESC_ACCESS (Port)
	Port (const Port &)=delete
void	operator= (const Port &)=delete

Private Attributes
float	m_x {0}
float	m_y {0}

Friends
struct	SchemaHelper
class	Wire

Detailed Description

Definition at line 53 of file port.h.

Constructor & Destructor Documentation

Port() [1/2]

minsky::Port::Port ( const Port &  )

privatedelete

Port() [2/2]

minsky::Port::Port ( Item &  item )

inline

Definition at line 96 of file port.h.

: classdesc::Exclude<PortExclude>(item) {}

~Port()

minsky::Port::~Port ( )

inline

Definition at line 99 of file port.h.

References deleteWires().

{deleteWires();}

Here is the call graph for this function:

Member Function Documentation

checkUnits()

Units minsky::Port::checkUnits ( ) const

inline

dimensional analysis with consistency check

Definition at line 105 of file port.h.

References units().

{return units(true);}

Here is the call graph for this function:

CLASSDESC_ACCESS()

minsky::Port::CLASSDESC_ACCESS ( Port  )

private

combineInput()

virtual void minsky::Port::combineInput ( double &  x, double  y  ) const

inlinevirtual

combine two input wires

Parameters

x	input to be updated
y	input to be combined with x

Reimplemented in minsky::anonymous_namespace{operation.cc}::OrInputPort, minsky::anonymous_namespace{operation.cc}::AndInputPort, minsky::anonymous_namespace{operation.cc}::MinInputPort, minsky::anonymous_namespace{operation.cc}::MaxInputPort, minsky::anonymous_namespace{operation.cc}::MulInputPort, and minsky::anonymous_namespace{operation.cc}::SumInputPort.

Definition at line 89 of file port.h.

References x(), and y().

{x=y;}

Here is the call graph for this function:

deleteWires()

void minsky::Port::deleteWires

(

)

delete all attached wires

wires could be anywhere, so we need to walk the whole heirachy

Definition at line 70 of file port.cc.

References minsky::group.

Referenced by ~Port().

  {
    if (auto g=item().group.lock())
      {
        auto& gg=g->globalGroup();
        auto wires=m_wires; // save copy, as Group::removeWire mutates it
        vector<WirePtr> wireHold; // postpone actual wire destruction until after loop
        wireHold.reserve(wires.size());
        for (auto& w: wires)
          wireHold.push_back(gg.removeWire(*w));
      }
    m_wires.clear();
  }

Here is the caller graph for this function:

eraseWire()

void minsky::Port::eraseWire

(

Wire *

w

)

remove wire from wires. No ownership passed.

Definition at line 60 of file port.cc.

  {
    for (auto i=m_wires.begin(); i!=m_wires.end(); ++i)
      if (*i==w) 
        {
          m_wires.erase(i);
          break;
        }
  }

identity()

virtual double minsky::Port::identity ( ) const

inlinevirtual

input port value if no wire attached

Reimplemented in minsky::anonymous_namespace{operation.cc}::AndInputPort, minsky::anonymous_namespace{operation.cc}::MinInputPort, minsky::anonymous_namespace{operation.cc}::MaxInputPort, and minsky::anonymous_namespace{operation.cc}::MulInputPort.

Definition at line 91 of file port.h.

{return 0;}

input()

virtual bool minsky::Port::input ( ) const

inlinevirtual

true if input port

Reimplemented in minsky::InputPort.

Definition at line 80 of file port.h.

Referenced by minsky::TensorsFromPort::tensorsFromPort().

{return false;}

Here is the caller graph for this function:

item() [1/2]

Item& minsky::Port::item ( )

inline

owner of this port

Definition at line 66 of file port.h.

Referenced by minsky::anonymous_namespace{minsky.cc}::Network::followWire().

{return m_item;};

Here is the caller graph for this function:

item() [2/2]

const Item& minsky::Port::item ( ) const

inline

owner of this port

Definition at line 67 of file port.h.

{return m_item;}

moveTo()

void minsky::Port::moveTo	(	float	x,
		float	y
	)

Definition at line 49 of file port.cc.

  {
    m_x=x-item().x();
    m_y=y-item().y();
  }

multiWireAllowed()

virtual bool minsky::Port::multiWireAllowed ( ) const

inlinevirtual

true if multiple wires are allowed to connect to an input port, such as an input port of an add operation. Irrelevant, otherwise

Reimplemented in minsky::MultiWireInputPort.

Definition at line 85 of file port.h.

{return false;}

numWires()

std::size_t minsky::Port::numWires ( ) const

inline

Definition at line 72 of file port.h.

{return m_wires.size();}

operator=()

void minsky::Port::operator= ( const Port &  )

privatedelete

units()

Units minsky::Port::units

(

bool

check

)

const

Definition at line 107 of file port.cc.

Referenced by checkUnits().

  {
    if (!wires().empty())
      return wires()[0]->units(check);
    return {};
  }

Here is the caller graph for this function:

value()

double minsky::Port::value

(

)

const

value associated with this port

Definition at line 92 of file port.cc.

                           {
    if (input())
      {
        double r=identity();
        for (auto* w: m_wires)
          combineInput(r, w->from()->value());
        return r;
      }
    auto vv=getVariableValue();
    if (vv && vv->type()!=VariableType::undefined)
      return vv->value();
    return item().value();
  }

wires()

std::vector<Wire*> const& minsky::Port::wires ( ) const

inline

returns a vector of weak references to the wires attached to this port

Definition at line 71 of file port.h.

Referenced by minsky::TensorsFromPort::tensorsFromPort().

{return m_wires;}

Here is the caller graph for this function:

x()

float minsky::Port::x

(

)

const

Definition at line 39 of file port.cc.

Referenced by combineInput().

  {
    return m_x+item().x();
  }

Here is the caller graph for this function:

y()

float minsky::Port::y

(

)

const

Definition at line 44 of file port.cc.

Referenced by combineInput().

  {
    return m_y+item().y();
  }

Here is the caller graph for this function:

Friends And Related Function Documentation

SchemaHelper

friend struct SchemaHelper

friend

Definition at line 59 of file port.h.

Wire

friend class Wire

friend

Definition at line 62 of file port.h.

Member Data Documentation

m_x

float minsky::Port::m_x {0}

private

Definition at line 57 of file port.h.

m_y

float minsky::Port::m_y {0}

private

Definition at line 57 of file port.h.

---

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

• model/port.h
• model/port.cc