Sundance::FuncElementBase Class Reference

FuncElementBase defines the interface for scalar-valued elements of Sundance functions. More...

Inheritance diagram for Sundance::FuncElementBase:

List of all members.

Public Member Functions
	FuncElementBase (const std::string &rootName, const std::string &suffix, const FunctionIdentifier &fid)
	FuncElementBase (const std::string &rootName)
virtual	~FuncElementBase ()
	virtual destructor
const std::string &	name () const
	Return the name of this function.
const std::string &	rootName () const
	Return the root name of this function.
const std::string &	suffix () const
	Return the root name of this function.
virtual std::ostream &	toText (std::ostream &os, bool paren) const
	Write self in text form.
virtual bool	lessThan (const ScalarExpr *other) const
	Ordering operator for use in transforming exprs to standard form.
Private Attributes
std::string	name_
std::string	rootName_
std::string	suffix_

---

Detailed Description

FuncElementBase defines the interface for scalar-valued elements of Sundance functions.

At the user level, Sundance functions can be list (e.g, vector or tensor) valued; internally, however, compound expressions use only scalar functions deriving from the FuncElementBase class.

Definition at line 60 of file SundanceFuncElementBase.hpp.

---

Constructor & Destructor Documentation

FuncElementBase::FuncElementBase	(	const std::string &	rootName,
		const std::string &	suffix,
		const FunctionIdentifier &	fid
	)

Definition at line 42 of file SundanceFuncElementBase.cpp.

Sundance::FuncElementBase::FuncElementBase

(

const std::string &

rootName

)

virtual Sundance::FuncElementBase::~FuncElementBase

(

)

[inline, virtual]

virtual destructor

Definition at line 72 of file SundanceFuncElementBase.hpp.

---

Member Function Documentation

bool FuncElementBase::lessThan

(

const ScalarExpr *

other

)

const [virtual]

Ordering operator for use in transforming exprs to standard form.

Implements Sundance::ScalarExpr.

Reimplemented in Sundance::DiscreteFuncElement, Sundance::TestFuncElement, Sundance::UnknownFuncElement, and Sundance::UnknownParameterElement.

Definition at line 57 of file SundanceFuncElementBase.cpp.

References Sundance::FunctionWithID::fid().

const std::string& Sundance::FuncElementBase::name

(

)

const [inline]

Return the name of this function.

Definition at line 75 of file SundanceFuncElementBase.hpp.

References name_.

Referenced by Sundance::describeFunction(), Sundance::DiscreteFuncElementEvaluator::DiscreteFuncElementEvaluator(), Sundance::StringEvalMediator::evalDiscreteFuncElement(), Sundance::UnknownParameterElement::lessThan(), Sundance::Parameter::toText(), Sundance::UnknownParameterElement::toXML(), Sundance::UnknownFuncElement::toXML(), Sundance::TestFuncElement::toXML(), and Sundance::DiscreteFuncElement::toXML().

const std::string& Sundance::FuncElementBase::rootName

(

)

const [inline]

Return the root name of this function.

Definition at line 78 of file SundanceFuncElementBase.hpp.

References rootName_.

const std::string& Sundance::FuncElementBase::suffix

(

)

const [inline]

Return the root name of this function.

Definition at line 81 of file SundanceFuncElementBase.hpp.

References suffix_.

std::ostream & FuncElementBase::toText	(	std::ostream &	os,
		bool	paren
	)			const [virtual]

Write self in text form.

Implements Sundance::ExprBase.

Reimplemented in Sundance::Parameter.

Definition at line 50 of file SundanceFuncElementBase.cpp.

References name_.

---

Member Data Documentation

std::string Sundance::FuncElementBase::name_ [private]

Definition at line 93 of file SundanceFuncElementBase.hpp.

Referenced by name(), and toText().

std::string Sundance::FuncElementBase::rootName_ [private]

Definition at line 95 of file SundanceFuncElementBase.hpp.

Referenced by rootName().

std::string Sundance::FuncElementBase::suffix_ [private]

Definition at line 97 of file SundanceFuncElementBase.hpp.

Referenced by suffix().