Loading...
Searching...
No Matches
LELUnary.h
Go to the documentation of this file.
//# LELUnary.h: LELUnary.h
//# Copyright (C) 1997,1998,1999,2000
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef LATTICES_LELUNARY_H
#define LATTICES_LELUNARY_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/lattices/LEL/LELInterface.h>
#include <casacore/lattices/LEL/LELScalar.h>
#include <casacore/lattices/LEL/LELUnaryEnums.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
// <summary> This LEL class handles scalar (unary) constants </summary>
//
// <use visibility=local>
//
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
//
// <prerequisite>
// <li> <linkto class="Lattice"> Lattice</linkto>
// <li> <linkto class="LatticeExpr"> LatticeExpr</linkto>
// <li> <linkto class="LatticeExprNode"> LatticeExprNode</linkto>
// <li> <linkto class="LELInterface"> LELInterface</linkto>
// <li> <linkto class="LELUnaryEnums"> LELUnaryEnums</linkto>
// </prerequisite>
//
// <etymology>
// This derived LEL letter class handles scalar (unary) constants
// </etymology>
//
// <synopsis>
// This LEL letter class is derived from LELInterface. It
// is used to construct LEL objects that represent scalars
// constants. They can be of type Float,Double,Complex,DComplex
// and Bool.
//
// A description of the implementation details of the LEL classes can
// be found in
// <a href="../notes/216.html">Note 216</a>
// </synopsis>
//
// <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:
// <srcblock>
// IPosition shape(2,5,10);
// ArrayLattice<Float> x(shape); x.set(1.0);
// ArrayLattice<Float> y(shape);
// ArrayLattice<Float> z(shape);
// y.copyData(x+2.0); // y = x + 2.0
// z.copyData(True); // z = True
// </srcblock>
// </example>
//
// <motivation>
// Constants are a basic mathematical expression.
// </motivation>
//
// <todo asof="1998/01/20">
// </todo>
template <class T> class LELUnaryConst : public LELInterface<T>
{
//# Make members of parent class known.
protected:
using LELInterface<T>::setAttr;
public:
// Default constructor creates a scalar with a false mask.
LELUnaryConst();
// Constructor takes a scalar.
LELUnaryConst(const T val);
// Destructor does nothing
~LELUnaryConst();
// Evaluate the expression.
// This throws an exception, since only a scalar can be returned.
virtual void eval (LELArray<T>& result,
const Slicer& section) const;
// Evaluate the scalar expression (get the constant)
virtual LELScalar<T> getScalar() const;
// Do further preparations (e.g. optimization) on the expression.
virtual Bool prepareScalarExpr();
// Get class name
virtual String className() const;
private:
LELScalar<T> val_p;
};
// <summary> This LEL class handles numerical unary operators </summary>
//
// <use visibility=local>
//
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
//
// <prerequisite>
// <li> <linkto class="Lattice"> Lattice</linkto>
// <li> <linkto class="LatticeExpr"> LatticeExpr</linkto>
// <li> <linkto class="LatticeExprNode"> LatticeExprNode</linkto>
// <li> <linkto class="LELInterface"> LELInterface</linkto>
// <li> <linkto class="LELUnaryEnums"> LELUnaryEnums</linkto>
// </prerequisite>
//
// <etymology>
// This derived LEL letter class handles numerical unary
// operators
// </etymology>
//
// <synopsis>
// This LEL letter class is derived from LELInterface. It
// is used to construct LEL objects that apply numerical unary
// operators to Lattice expressions. They operate on numerical
// Lattice (Float,Double,Complex,DComplex) expressions and return the
// same numerical type. The available C++ operators
// are <src>+,-</src> with equivalents in the enum
// of PLUS and MINUS.
//
// A description of the implementation details of the LEL classes can
// be found in
// <a href="../notes/216.html">Note 216</a>
// </synopsis>
//
// <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. An example of how the user
// would indirectly use this class (through the envelope) is:
// <srcblock>
// IPosition shape(2,5,10);
// ArrayLattice<Float> x(shape); x.set(1.0);
// ArrayLattice<Float> y(shape);
// y.copyData(-x); // y = -x
// </srcblock>
// </example>
//
// <motivation>
// Numerical unary operations are a basic mathematical expression.
// </motivation>
//
// <todo asof="1998/01/20">
// </todo>
template <class T> class LELUnary : public LELInterface<T>
{
public:
// Constructor takes operation and expression
// to be operated upon
LELUnary(const LELUnaryEnums::Operation op,
const std::shared_ptr<LELInterface<T>>& pExpr);
// Destructor does nothing
~LELUnary();
// Recursively evaluate the expression.
virtual void eval (LELArray<T>& result,
const Slicer& section) const;
// Recursively evaluate the scalar expression.
virtual LELScalar<T> getScalar() const;
// Do further preparations (e.g. optimization) on the expression.
virtual Bool prepareScalarExpr();
// Get class name
virtual String className() const;
// Handle locking/syncing of a lattice in a lattice expression.
// <group>
virtual Bool lock (FileLocker::LockType, uInt nattempts);
virtual void unlock();
virtual Bool hasLock (FileLocker::LockType) const;
virtual void resync();
// </group>
private:
LELUnaryEnums::Operation op_p;
std::shared_ptr<LELInterface<T>> pExpr_p;
};
// <summary> This LEL class handles logical unary operators </summary>
//
// <use visibility=local>
//
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
//
// <prerequisite>
// <li> <linkto class="Lattice"> Lattice</linkto>
// <li> <linkto class="LatticeExpr"> LatticeExpr</linkto>
// <li> <linkto class="LatticeExprNode"> LatticeExprNode</linkto>
// <li> <linkto class="LELInterface"> LELInterface</linkto>
// <li> <linkto class="LELUnaryEnums"> LELUnaryEnums</linkto>
// </prerequisite>
//
// <etymology>
// This derived LEL letter class handles logical unary
// operators
// </etymology>
//
// <synopsis>
// This LEL letter class is derived from LELInterface. It
// is used to construct LEL objects that apply logical unary
// operators to Lattice expressions. They operate on Bool
// Lattice expressions only and return a Bool.
// The available C++ operator is <src>!</src> with the equivalent
// in the enum of NOT.
//
// A description of the implementation details of the LEL classes can
// be found in
// <a href="../notes/216.html">Note 216</a>
// </synopsis>
//
// <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. An example of how the user
// would indirectly use this class (through the envelope) is:
// <srcblock>
// IPosition shape(2,5,10);
// ArrayLattice<Bool> x(shape); x.set(True);
// ArrayLattice<Bool> y(shape);
// y.copyData(!x); // y = !x
// </srcblock>
// </example>
//
// <motivation>
// Logical unary operations are a basic mathematical expression.
// </motivation>
//
// <todo asof="1998/01/20">
// </todo>
class LELUnaryBool : public LELInterface<Bool>
{
public:
// Constructor takes operation and expression
// to be operated upon
LELUnaryBool(const LELUnaryEnums::Operation op,
const std::shared_ptr<LELInterface<Bool>>& pExpr);
// Destructor does nothing
~LELUnaryBool();
// Recursively evaluate the expression.
virtual void eval (LELArray<Bool>& result,
const Slicer& section) const;
// Recursively evaluate the scalar expression.
virtual LELScalar<Bool> getScalar() const;
// Do further preparations (e.g. optimization) on the expression.
virtual Bool prepareScalarExpr();
// Get class name
virtual String className() const;
// Handle locking/syncing of a lattice in a lattice expression.
// <group>
virtual Bool lock (FileLocker::LockType, uInt nattempts);
virtual void unlock();
virtual Bool hasLock (FileLocker::LockType) const;
virtual void resync();
// </group>
private:
LELUnaryEnums::Operation op_p;
std::shared_ptr<LELInterface<Bool>> pExpr_p;
};
} //# NAMESPACE CASACORE - END
//# See comments in LELInterface why LELInterface.tcc is included here.
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/lattices/LEL/LELInterface.tcc>
#include <casacore/lattices/LEL/LELUnary.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
casacore::FileLocker::LockType
LockType
Define the possible lock types.
Definition FileLocker.h:93
casacore::LELArray
Definition LELArray.h:61
casacore::LELInterface
Definition LELInterface.h:149
casacore::LELInterface::setAttr
void setAttr(const LELAttribute &attrib)
Set the expression attributes of this object.
casacore::LELScalar
Definition LELScalar.h:58
casacore::LELUnaryBool::lock
virtual Bool lock(FileLocker::LockType, uInt nattempts)
Handle locking/syncing of a lattice in a lattice expression.
casacore::LELUnaryBool::pExpr_p
std::shared_ptr< LELInterface< Bool > > pExpr_p
Definition LELUnary.h:314
casacore::LELUnaryBool::getScalar
virtual LELScalar< Bool > getScalar() const
Recursively evaluate the scalar expression.
casacore::LELUnaryBool::className
virtual String className() const
Get class name.
casacore::LELUnaryBool::~LELUnaryBool
~LELUnaryBool()
Destructor does nothing.
casacore::LELUnaryBool::hasLock
virtual Bool hasLock(FileLocker::LockType) const
casacore::LELUnaryBool::op_p
LELUnaryEnums::Operation op_p
Definition LELUnary.h:313
casacore::LELUnaryBool::prepareScalarExpr
virtual Bool prepareScalarExpr()
Do further preparations (e.g.
casacore::LELUnaryBool::unlock
virtual void unlock()
casacore::LELUnaryBool::eval
virtual void eval(LELArray< Bool > &result, const Slicer &section) const
Recursively evaluate the expression.
casacore::LELUnaryBool::resync
virtual void resync()
casacore::LELUnaryBool::LELUnaryBool
LELUnaryBool(const LELUnaryEnums::Operation op, const std::shared_ptr< LELInterface< Bool > > &pExpr)
Constructor takes operation and expression to be operated upon.
casacore::LELUnaryConst::prepareScalarExpr
virtual Bool prepareScalarExpr()
Do further preparations (e.g.
casacore::LELUnaryConst::val_p
LELScalar< T > val_p
Definition LELUnary.h:125
casacore::LELUnaryConst::className
virtual String className() const
Get class name.
casacore::LELUnaryConst::getScalar
virtual LELScalar< T > getScalar() const
Evaluate the scalar expression (get the constant).
casacore::LELUnaryConst::LELUnaryConst
LELUnaryConst(const T val)
Constructor takes a scalar.
casacore::LELUnaryConst::eval
virtual void eval(LELArray< T > &result, const Slicer &section) const
Evaluate the expression.
casacore::LELUnaryConst::LELUnaryConst
LELUnaryConst()
Default constructor creates a scalar with a false mask.
casacore::LELUnaryConst::~LELUnaryConst
~LELUnaryConst()
Destructor does nothing.
casacore::LELUnaryEnums::Operation
Operation
Definition LELUnaryEnums.h:65
casacore::LELUnary::getScalar
virtual LELScalar< T > getScalar() const
Recursively evaluate the scalar expression.
casacore::LELUnary::hasLock
virtual Bool hasLock(FileLocker::LockType) const
casacore::LELUnary::unlock
virtual void unlock()
casacore::LELUnary::lock
virtual Bool lock(FileLocker::LockType, uInt nattempts)
Handle locking/syncing of a lattice in a lattice expression.
casacore::LELUnary::resync
virtual void resync()
casacore::LELUnary::pExpr_p
std::shared_ptr< LELInterface< T > > pExpr_p
Definition LELUnary.h:219
casacore::LELUnary::op_p
LELUnaryEnums::Operation op_p
Definition LELUnary.h:218
casacore::LELUnary::LELUnary
LELUnary(const LELUnaryEnums::Operation op, const std::shared_ptr< LELInterface< T > > &pExpr)
Constructor takes operation and expression to be operated upon.
casacore::LELUnary::eval
virtual void eval(LELArray< T > &result, const Slicer &section) const
Recursively evaluate the expression.
casacore::LELUnary::~LELUnary
~LELUnary()
Destructor does nothing.
casacore::LELUnary::prepareScalarExpr
virtual Bool prepareScalarExpr()
Do further preparations (e.g.
casacore::LELUnary::className
virtual String className() const
Get class name.
casacore::Slicer
Definition Slicer.h:287
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::uInt
unsigned int uInt
Definition aipstype.h:49
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40