#include <nodes.h>

Inheritance diagram for Variable:

Collaboration diagram for Variable:

Public Types
using	var_map = std::unordered_map< char, Complex >
	Specialization for mapping name to value.

Public Types inherited from Node
enum	Select { NONE, START, END, ALL }

Public Member Functions
Constructor and Virtual Destructor
	Variable (Parser &p, Node *parent)

	Variable (char name, Node *parent, bool neg=false, Node::Select s=Node::Select::NONE)

	Variable (EqnXMLParser &in, Node *parent)

	~Variable ()

Virtual Public Member Functions
std::string	toString () const

const std::string &	getName () const

std::type_index	getType () const

Public Member Functions inherited from Node
void	calculateSize (UI::Graphics &gc)

void	out (XML::Stream &xml)

void	calculateOrigin (UI::Graphics &gc, int x, int y)

void	setUpDraw (UI::Graphics &gc)

void	draw (UI::Graphics &gc) const

void	setSelect (Select s)

Select	getSelect () const

void	setDrawParenthesis (bool fDrawPar)

bool	getDrawParenthesis () const

const Frame &	getFrame () const

Node *	first ()

Node *	last ()

Node *	getNextLeft ()

Node *	getNextRight ()

void	setParent (Node *parent)

Node *	getParent () const

int	getDepth () const

int	getNth () const

void	addNth (int n)

void	multNth (int n)

void	setNth (int n)

void	negative ()

bool	getSign () const

Complex	getValue () const

std::shared_ptr< Node >	getSharedPtr ()

	Node (Node *parent=nullptr, bool fNeg=false, Select s=NONE)

	Node (EqnXMLParser &in, Node *parent)

virtual	~Node ()
	Abstract base class needs virtual desctructor.

virtual bool	isLeaf () const

virtual bool	isFactor () const

virtual Node *	findNode (int x, int y)

virtual Node *	findNode (const Box &b)

virtual int	numFactors () const

virtual void	normalize ()

virtual bool	simplify ()

virtual bool	less (NodePtr b) const

Static Public Member Functions
static Variable *	parse (Parser &p, Node *parent)

static void	setValue (char name, Complex value)

Static Public Member Functions inherited from Node
static bool	createNodeByName (std::string name, Equation &eqn)

Static Public Attributes
static const std::string	name = "variable"
	Name of Variable class.

static const std::type_index	type = typeid(Variable)
	Type of Variable class.

Static Public Attributes inherited from Node
static const std::vector< std::string >	select_tags = { "NONE", "START", "END", "ALL" }

Private Member Functions
Virtual Private Member Functions
void	xml_out (XML::Stream &xml) const

Frame	calcSize (UI::Graphics &gc)

void	calcOrig (UI::Graphics &gc, int x, int y)

void	drawNode (UI::Graphics &gc) const

Complex	getNodeValue () const

Private Attributes
char	m_name
	Name of Variable.

Box	m_internal
	Bounding box of this node.

Static Private Attributes
static var_map	values
	Mapping of all variable name to their values.

Detailed Description

Represents a Variable factor node.

Constructor & Destructor Documentation

Variable::Variable	(	Parser &	p,
		Node *	parent
	)

Parser constructor for Variable class.

Parameters

p	Parser object.
parent	Parent node.

Variable::Variable	(	char	name,
		Node *	parent,
		bool	neg = `false`,
		Node::Select	s = `Node::Select::NONE`
	)

inline

Constructor for Constant class.

Parameters

name	Variable name.
parent	Parent node.
neg	If true, node is negative.
s	Selection state of node.

Variable::Variable	(	EqnXMLParser &	in,
		Node *	parent
	)

XML constructor for Variable class. Read in XML for Variable class.

Parameters

in	XML input stream.
parent	Parent node object.

Variable::~Variable ( )

inline

Abstract base class needs virtual destructor.

Member Function Documentation

void Variable::calcOrig	(	UI::Graphics &	gc,
		int	x,
		int	y
	)

privatevirtual

Calculate origin of this node offset from the point (x,y) given it.

Parameters

gc	Graphics context.
x	Horizontal origin.
y	Vertical origin.

Implements Node.

Node::Frame Variable::calcSize ( UI::Graphics & gc )

privatevirtual

Calculate size of this node in given graphics context.

Parameters

gc	Graphics context.

Returns: Return frame containing size of this node.

Implements Node.

void Variable::drawNode ( UI::Graphics & gc ) const

privatevirtual

Draw this node in the given graphical context.

Parameters

gc	Graphical context.

Implements Node.

const std::string& Variable::getName ( ) const

inlinevirtual

Get name of this class.

Returns: Name of this class.

Implements Node.

Complex Variable::getNodeValue ( ) const

inlineprivatevirtual

Get value of this subtree.

Returns: Complex value of this subtree.

Implements Node.

std::type_index Variable::getType ( ) const

inlinevirtual

Get name of this class.

Returns: Name of this class.

Implements Node.

Variable * Variable::parse	(	Parser &	p,
		Node *	parent
	)

static

Static helper function to parse Variable class.

Parameters

p	Parser object pointing to operator.
parent	Parent node.

Returns: Variable object or null if variable not present.

void Variable::setValue	(	char	name,
		Complex	value
	)

static

Static helper function to set value of a variable.

Parameters

name	Variable name.
value	Value of Variable.

std::string Variable::toString ( ) const

inlinevirtual

String representation of variable is its name.

Returns: Name of variable.

Implements Node.

void Variable::xml_out ( XML::Stream & xml ) const

privatevirtual

Output XML of this node.

Parameters

xml	XML output stream.

Implements Node.

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation