This LEL class handles complex numerical functions. More...

#include <LELFunction.h>

Inheritance diagram for casacore::LELFunctionComplex:

Public Member Functions
	LELFunctionComplex (const LELFunctionEnums::Function function, const Block< LatticeExprNode > &expr)
	Constructor takes operation and left and right expressions to be operated upon. More...

	~LELFunctionComplex ()
	Destructor. More...

virtual void	eval (LELArray< Complex > &result, const Slicer &section) const
	Recursively evaluate the expression. More...

virtual LELScalar< Complex >	getScalar () const
	Recursively evaluate the scalar expression. More...

virtual Bool	prepareScalarExpr ()
	Do further preparations (e.g. More...

virtual String	className () const
	Get class name. More...

virtual Bool	lock (FileLocker::LockType, uInt nattempts)
	Handle locking/syncing of a lattice in a lattice expression. More...

virtual void	unlock ()

virtual Bool	hasLock (FileLocker::LockType) const

virtual void	resync ()

Public Member Functions inherited from casacore::LELInterface< Complex >
virtual	~LELInterface ()
	Virtual destructor. More...

virtual void	evalRef (LELArrayRef< Complex > &result, const Slicer &section) const

LELArray< Complex >	getArray () const
	Get the result of an array subexpression. More...

Bool	isScalar () const
	Is the result of evaluating this expression a scalar ? More...

const IPosition &	shape () const
	Get the shape of the expression result. More...

const LELAttribute &	getAttribute () const
	Get expression attribute. More...

Private Attributes
LELFunctionEnums::Function	function_p

Block< LatticeExprNode >	arg_p

Additional Inherited Members
Static Public Member Functions inherited from casacore::LELInterface< Complex >
static Bool	replaceScalarExpr (CountedPtr< LELInterface< Complex > > &expr)
	If the given expression is a valid scalar, replace it by its result. More...

Protected Member Functions inherited from casacore::LELInterface< Complex >
void	setAttr (const LELAttribute &attrib)
	Set the expression attributes of this object. More...

Detailed Description

This LEL class handles complex numerical functions.

Intended use:

Internal

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

Etymology

This derived LEL letter class handles complex numerical functions (arbitrary number of arguments)

Synopsis

This LEL letter class is derived from LELInterface. It is used to construct LEL objects that apply complex numerical functions of arbitrary number of arguments (but only 1 or 2 arguments currently implemented) to Lattice expressions. They operate on Complex Lattice expressions only and return a Complex. The available C++ functions are pow,conj with equivalents in the enum of POW and CONJ.

A description of the implementation details of the LEL classes can be found in Note 216

Example

Examples are not very useful as the user would never use these classes directly. Look in LatticeExprNode.cc to see how it invokes these classes. Examples of how the user would indirectly use this class (through the envelope) are:

IPosition shape(2,5,10);
ArrayLattice<Complex> x(shape); x.set(Complex(2.0,3.0));
ArrayLattice<Complex> y(shape); 
y.copyData(conj(x));                // y = conj(x)