Loading...
Searching...
No Matches
LELBinary.h
Go to the documentation of this file.
//# LELBinary.h: LELBinary.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_LELBINARY_H
#define LATTICES_LELBINARY_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/lattices/LEL/LELInterface.h>
#include <casacore/lattices/LEL/LELBinaryEnums.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
// <summary> This LEL class handles numerical binary 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="LELBinaryEnums"> LELBinaryEnums</linkto>
// </prerequisite>
//
// <etymology>
// This derived LEL letter class handles numerical binary
// operators
// </etymology>
//
// <synopsis>
// This LEL letter class is derived from LELInterface. It
// is used to construct LEL objects that apply numerical binary
// 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 ADD, SUBTRACT, MULTIPLY, and DIVIDE.
//
// 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); y.set(2.0);
// ArrayLattice<Float> z(shape);
// z.copyData(x+y); // z = x + y;
// z.copyData(x-y); // z = x - y;
// z.copyData(x*y); // z = x * y;
// z.copyData(x/y); // z = x / y;
// </srcblock>
// </example>
//
// <motivation>
// Numerical binary operations are a basic mathematical expression.
// </motivation>
//
// <todo asof="1998/01/20">
// </todo>
template <class T> class LELBinary : public LELInterface<T>
{
//# Make members of parent class known.
protected:
using LELInterface<T>::setAttr;
public:
// Constructor takes operation and left and right expressions
// to be operated upon
LELBinary(const LELBinaryEnums::Operation op,
const std::shared_ptr<LELInterface<T>>& pLeftExpr,
const std::shared_ptr<LELInterface<T>>& pRightExpr);
// Destructor
~LELBinary();
// Recursively evaluate the expression
virtual void eval (LELArray<T>& result,
const Slicer& section) const;
// Recursively efvaluate 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:
LELBinaryEnums::Operation op_p;
std::shared_ptr<LELInterface<T>> pLeftExpr_p;
std::shared_ptr<LELInterface<T>> pRightExpr_p;
};
// <summary> This LEL class handles relational binary numerical 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="LELBinaryEnums"> LELBinaryEnums</linkto>
// </prerequisite>
//
// <etymology>
// This derived LEL letter class handles relational numerical binary
// operators
// </etymology>
//
// <synopsis>
// This LEL letter class is derived from LELInterface. It
// is used to construct LEL objects that apply relational numerical
// binary operators to Lattice expressions. They operate on numerical
// (Float,Double,Complex,DComplex) Lattice expressions and result
// in a Bool. The available C++ operators are
// <src>==,!=>,>=,<,<=,</src> with equivalents in the enum of
// EQ, NE, GT, GE, LT, and LE
//
// 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); y.set(2.0);
// ArrayLattice<Bool> z(shape);
// z.copyData(x==y); // z = x == y;
// z.copyData(x!=y); // z = x != y;
// z.copyData(x>y); // z = x > y;
// z.copyData(x>=y); // z = x >= y;
// z.copyData(x<y); // z = x < y;
// z.copyData(x<=y); // z = x <= y;
// </srcblock>
// </example>
//
// <motivation>
// Numerical relational binary operations are a basic mathematical expression.
// </motivation>
//
// <todo asof="1998/01/20">
// </todo>
template<class T> class LELBinaryCmp : public LELInterface<Bool>
{
public:
// Constructor takes operation and left and right expressions
// to be operated upon. It can only handle the comparison operators.
LELBinaryCmp(const LELBinaryEnums::Operation op,
const std::shared_ptr<LELInterface<T>>& pLeftExpr,
const std::shared_ptr<LELInterface<T>>& pRightExpr);
// Destructor
~LELBinaryCmp();
// 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:
LELBinaryEnums::Operation op_p;
std::shared_ptr<LELInterface<T>> pLeftExpr_p;
std::shared_ptr<LELInterface<T>> pRightExpr_p;
};
// <summary> This LEL class handles logical binary 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="LELBinaryEnums"> LELBinaryEnums</linkto>
// </prerequisite>
// <etymology>
// This derived LEL letter class handles logical binary operators
// </etymology>
//
// <synopsis>
// This LEL letter class is derived from LELInterface. It
// is used to construct LEL objects that apply logical
// binary operators to Lattice expressions. They apply only
// to Bool Lattice expressions and result in a Bool. The
// available C++ operators are <src>&&,||,==,!=</src> with
// equivalents in the enum of AND, OR, EQ, and NE
//
// 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<Bool> x(shape); x.set(False);
// ArrayLattice<Bool> y(shape); y.set(True);
// ArrayLattice<Bool> z(shape); z.set(False);
// z.copyData(x&&y); // z = x && y;
// z.copyData(x||y); // z = x || y;
// z.copyData(x==y); // z = x == y;
// z.copyData(x!=y); // z = x != y;
// </srcblock>
// </example>
//
// <motivation>
// Logical binary operations are a basic mathematical expression.
// </motivation>
//
// <todo asof="1998/01/20">
// </todo>
class LELBinaryBool : public LELInterface<Bool>
{
public:
// Constructor takes operation and left and right expressions
// to be operated upon.
LELBinaryBool(const LELBinaryEnums::Operation op,
const std::shared_ptr<LELInterface<Bool>>& pLeftExpr,
const std::shared_ptr<LELInterface<Bool>>& pRightExpr);
// Destructor
~LELBinaryBool();
// 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:
LELBinaryEnums::Operation op_p;
std::shared_ptr<LELInterface<Bool>> pLeftExpr_p;
std::shared_ptr<LELInterface<Bool>> pRightExpr_p;
};
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/lattices/LEL/LELBinary.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::LELBinaryBool::~LELBinaryBool
~LELBinaryBool()
Destructor.
casacore::LELBinaryBool::hasLock
virtual Bool hasLock(FileLocker::LockType) const
casacore::LELBinaryBool::className
virtual String className() const
Get class name.
casacore::LELBinaryBool::pLeftExpr_p
std::shared_ptr< LELInterface< Bool > > pLeftExpr_p
Definition LELBinary.h:345
casacore::LELBinaryBool::lock
virtual Bool lock(FileLocker::LockType, uInt nattempts)
Handle locking/syncing of a lattice in a lattice expression.
casacore::LELBinaryBool::getScalar
virtual LELScalar< Bool > getScalar() const
Recursively evaluate the scalar expression.
casacore::LELBinaryBool::pRightExpr_p
std::shared_ptr< LELInterface< Bool > > pRightExpr_p
Definition LELBinary.h:346
casacore::LELBinaryBool::LELBinaryBool
LELBinaryBool(const LELBinaryEnums::Operation op, const std::shared_ptr< LELInterface< Bool > > &pLeftExpr, const std::shared_ptr< LELInterface< Bool > > &pRightExpr)
Constructor takes operation and left and right expressions to be operated upon.
casacore::LELBinaryBool::resync
virtual void resync()
casacore::LELBinaryBool::eval
virtual void eval(LELArray< Bool > &result, const Slicer &section) const
Recursively evaluate the expression.
casacore::LELBinaryBool::op_p
LELBinaryEnums::Operation op_p
Definition LELBinary.h:344
casacore::LELBinaryBool::prepareScalarExpr
virtual Bool prepareScalarExpr()
Do further preparations (e.g.
casacore::LELBinaryBool::unlock
virtual void unlock()
casacore::LELBinaryCmp::~LELBinaryCmp
~LELBinaryCmp()
Destructor.
casacore::LELBinaryCmp::pRightExpr_p
std::shared_ptr< LELInterface< T > > pRightExpr_p
Definition LELBinary.h:245
casacore::LELBinaryCmp::unlock
virtual void unlock()
casacore::LELBinaryCmp::prepareScalarExpr
virtual Bool prepareScalarExpr()
Do further preparations (e.g.
casacore::LELBinaryCmp::LELBinaryCmp
LELBinaryCmp(const LELBinaryEnums::Operation op, const std::shared_ptr< LELInterface< T > > &pLeftExpr, const std::shared_ptr< LELInterface< T > > &pRightExpr)
Constructor takes operation and left and right expressions to be operated upon.
casacore::LELBinaryCmp::pLeftExpr_p
std::shared_ptr< LELInterface< T > > pLeftExpr_p
Definition LELBinary.h:244
casacore::LELBinaryCmp::resync
virtual void resync()
casacore::LELBinaryCmp::eval
virtual void eval(LELArray< Bool > &result, const Slicer &section) const
Recursively evaluate the expression.
casacore::LELBinaryCmp::className
virtual String className() const
Get class name.
casacore::LELBinaryCmp::getScalar
virtual LELScalar< Bool > getScalar() const
Recursively evaluate the scalar expression.
casacore::LELBinaryCmp::op_p
LELBinaryEnums::Operation op_p
Definition LELBinary.h:243
casacore::LELBinaryCmp::lock
virtual Bool lock(FileLocker::LockType, uInt nattempts)
Handle locking/syncing of a lattice in a lattice expression.
casacore::LELBinaryCmp::hasLock
virtual Bool hasLock(FileLocker::LockType) const
casacore::LELBinaryEnums::Operation
Operation
Definition LELBinaryEnums.h:65
casacore::LELBinary::eval
virtual void eval(LELArray< T > &result, const Slicer &section) const
Recursively evaluate the expression.
casacore::LELBinary::prepareScalarExpr
virtual Bool prepareScalarExpr()
Do further preparations (e.g.
casacore::LELBinary::hasLock
virtual Bool hasLock(FileLocker::LockType) const
casacore::LELBinary::className
virtual String className() const
Get class name.
casacore::LELBinary::lock
virtual Bool lock(FileLocker::LockType, uInt nattempts)
Handle locking/syncing of a lattice in a lattice expression.
casacore::LELBinary::~LELBinary
~LELBinary()
Destructor.
casacore::LELBinary::op_p
LELBinaryEnums::Operation op_p
Definition LELBinary.h:138
casacore::LELBinary::getScalar
virtual LELScalar< T > getScalar() const
Recursively efvaluate the scalar expression.
casacore::LELBinary::resync
virtual void resync()
casacore::LELBinary::LELBinary
LELBinary(const LELBinaryEnums::Operation op, const std::shared_ptr< LELInterface< T > > &pLeftExpr, const std::shared_ptr< LELInterface< T > > &pRightExpr)
Constructor takes operation and left and right expressions to be operated upon.
casacore::LELBinary::pRightExpr_p
std::shared_ptr< LELInterface< T > > pRightExpr_p
Definition LELBinary.h:140
casacore::LELBinary::unlock
virtual void unlock()
casacore::LELBinary::pLeftExpr_p
std::shared_ptr< LELInterface< T > > pLeftExpr_p
Definition LELBinary.h:139
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::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