casacore
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
casacore::LELFunctionDComplex Class Reference

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

#include <LELFunction.h>

Inheritance diagram for casacore::LELFunctionDComplex:
casacore::LELInterface< DComplex >

Public Member Functions

 LELFunctionDComplex (const LELFunctionEnums::Function function, const Block< LatticeExprNode > &expr)
 Constructor takes operation and left and right expressions to be operated upon. More...
 
 ~LELFunctionDComplex ()
 Destructor. More...
 
virtual void eval (LELArray< DComplex > &result, const Slicer &section) const
 Recursively evaluate the expression. More...
 
virtual LELScalar< DComplex > 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< DComplex >
virtual ~LELInterface ()
 Virtual destructor. More...
 
virtual void evalRef (LELArrayRef< DComplex > &result, const Slicer &section) const
 
LELArray< DComplex > getArray () const
 Get the result of an array subexpression. More...
 
Bool isScalar () const
 Is the result of evaluating this expression a scalar ? More...
 
const IPositionshape () const
 Get the shape of the expression result. More...
 
const LELAttributegetAttribute () const
 Get expression attribute. More...
 

Private Attributes

LELFunctionEnums::Function function_p
 
Block< LatticeExprNodearg_p
 

Additional Inherited Members

- Static Public Member Functions inherited from casacore::LELInterface< DComplex >
static Bool replaceScalarExpr (CountedPtr< LELInterface< DComplex > > &expr)
 If the given expression is a valid scalar, replace it by its result. More...
 
- Protected Member Functions inherited from casacore::LELInterface< DComplex >
void setAttr (const LELAttribute &attrib)
 Set the expression attributes of this object. More...
 

Detailed Description

This LEL class handles double complex numerical functions.

Intended use:

Internal

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

This derived LEL letter class handles double 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 double complex numerical functions of arbitrary number of arguments (but only 1 or 2 arguments currently implemented) to Lattice expressions. They operate on DComplex Lattice expressions only and return a DComplex. 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<DComplex> x(shape); x.set(DComplex(2.0,3.0));
ArrayLattice<DComplex> y(shape);
y.copyData(conj(x)); // y = conj(x)

Motivation

Numerical functions are a basic mathematical expression.

Definition at line 730 of file LELFunction.h.

Constructor & Destructor Documentation

casacore::LELFunctionDComplex::LELFunctionDComplex ( const LELFunctionEnums::Function  function,
const Block< LatticeExprNode > &  expr 
)

Constructor takes operation and left and right expressions to be operated upon.

casacore::LELFunctionDComplex::~LELFunctionDComplex ( )

Destructor.

Member Function Documentation

virtual String casacore::LELFunctionDComplex::className ( ) const
virtual

Get class name.

Implements casacore::LELInterface< DComplex >.

virtual void casacore::LELFunctionDComplex::eval ( LELArray< DComplex > &  result,
const Slicer section 
) const
virtual

Recursively evaluate the expression.

Implements casacore::LELInterface< DComplex >.

virtual LELScalar<DComplex> casacore::LELFunctionDComplex::getScalar ( ) const
virtual

Recursively evaluate the scalar expression.

Implements casacore::LELInterface< DComplex >.

virtual Bool casacore::LELFunctionDComplex::hasLock ( FileLocker::LockType  ) const
virtual
virtual Bool casacore::LELFunctionDComplex::lock ( FileLocker::LockType  ,
uInt  nattempts 
)
virtual

Handle locking/syncing of a lattice in a lattice expression.

Reimplemented from casacore::LELInterface< DComplex >.

virtual Bool casacore::LELFunctionDComplex::prepareScalarExpr ( )
virtual

Do further preparations (e.g.

optimization) on the expression.

Implements casacore::LELInterface< DComplex >.

virtual void casacore::LELFunctionDComplex::resync ( )
virtual
virtual void casacore::LELFunctionDComplex::unlock ( )
virtual

Member Data Documentation

Block<LatticeExprNode> casacore::LELFunctionDComplex::arg_p
private

Definition at line 765 of file LELFunction.h.

LELFunctionEnums::Function casacore::LELFunctionDComplex::function_p
private

Definition at line 764 of file LELFunction.h.


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