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

This LEL class handles numerical (real and complex) 1-argument functions. More...

#include <LELFunction.h>

Inheritance diagram for casacore::LELFunction1D< T >:
casacore::LELInterface< T >

Public Member Functions

 LELFunction1D (const LELFunctionEnums::Function function, const CountedPtr< LELInterface< T > > &expr)
 Constructor takes operation and expression to be operated upon. More...
 
 ~LELFunction1D ()
 Destructor. More...
 
virtual void eval (LELArray< T > &result, const Slicer &section) const
 Recursively evaluate the expression. More...
 
virtual LELScalar< T > 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< T >
virtual ~LELInterface ()
 Virtual destructor. More...
 
virtual void evalRef (LELArrayRef< T > &result, const Slicer &section) const
 
LELArray< T > 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
 
CountedPtr< LELInterface< T > > pExpr_p
 

Additional Inherited Members

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

Detailed Description

template<class T>
class casacore::LELFunction1D< T >

This LEL class handles numerical (real and complex) 1-argument functions.

Intended use:

Internal

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

This derived LEL letter class handles numerical (real and complex) 1-argument functions

Synopsis

This LEL letter class is derived from LELInterface. It is used to construct LEL objects that apply numerical 1-argument functions to Lattice expressions. They operate on numerical (Float,Double,Complex,DComplex) Lattice expressions and return the same type. The available C++ functions are sin,sinh,cos,cosh,exp,log,log10,sqrt,min,max,mean,sum with equivalents in the enum of SIN,SINH,COS,COSH,EXP,LOG,LOG10,SQRT,MIN1D,MAX1D, MEAN1D, and SUM.

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(1.0);
ArrayLattice<Complex> y(shape);
y.copyData(sin(x)); // y = sin(x)
y.copyData(min(x)); // y = min(x)

Note that the min function returns a scalar, and the output Lattice is filled with that one value.

Motivation

Numerical functions are a basic mathematical expression.

Definition at line 104 of file LELFunction.h.

Constructor & Destructor Documentation

template<class T >
casacore::LELFunction1D< T >::LELFunction1D ( const LELFunctionEnums::Function  function,
const CountedPtr< LELInterface< T > > &  expr 
)

Constructor takes operation and expression to be operated upon.

template<class T >
casacore::LELFunction1D< T >::~LELFunction1D ( )

Destructor.

Member Function Documentation

template<class T >
virtual String casacore::LELFunction1D< T >::className ( ) const
virtual

Get class name.

Implements casacore::LELInterface< T >.

template<class T >
virtual void casacore::LELFunction1D< T >::eval ( LELArray< T > &  result,
const Slicer section 
) const
virtual

Recursively evaluate the expression.

Implements casacore::LELInterface< T >.

template<class T >
virtual LELScalar<T> casacore::LELFunction1D< T >::getScalar ( ) const
virtual

Recursively evaluate the scalar expression.

Implements casacore::LELInterface< T >.

template<class T >
virtual Bool casacore::LELFunction1D< T >::hasLock ( FileLocker::LockType  ) const
virtual

Reimplemented from casacore::LELInterface< T >.

template<class T >
virtual Bool casacore::LELFunction1D< T >::lock ( FileLocker::LockType  ,
uInt  nattempts 
)
virtual

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

Reimplemented from casacore::LELInterface< T >.

template<class T >
virtual Bool casacore::LELFunction1D< T >::prepareScalarExpr ( )
virtual

Do further preparations (e.g.

optimization) on the expression.

Implements casacore::LELInterface< T >.

template<class T >
virtual void casacore::LELFunction1D< T >::resync ( )
virtual

Reimplemented from casacore::LELInterface< T >.

template<class T >
virtual void casacore::LELFunction1D< T >::unlock ( )
virtual

Reimplemented from casacore::LELInterface< T >.

Member Data Documentation

template<class T >
LELFunctionEnums::Function casacore::LELFunction1D< T >::function_p
private

Definition at line 140 of file LELFunction.h.

template<class T >
CountedPtr<LELInterface<T> > casacore::LELFunction1D< T >::pExpr_p
private

Definition at line 141 of file LELFunction.h.


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