casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Attributes
casa::LELAttribute Class Reference

Ancillary information for the LEL letter classes. More...

#include <LELAttribute.h>

List of all members.

Public Member Functions

 LELAttribute ()
 Default constructor sets it as a scalar.
 LELAttribute (Bool isMasked, const IPosition &shape, const IPosition &tileShape, const LELCoordinates &coordinates, Bool isReduced=False)
 Constructor sets it as lattice with given attributes.
 LELAttribute (uInt regionNdim)
 Constructor sets it as a region with given attributes.
 LELAttribute (const LELAttribute &attr)
 Copy constructor (copy semantics)
 LELAttribute (const LELAttribute &attrLeft, const LELAttribute &attrRight, Bool matchAxes=True)
 Constructor that combines the two attributes given.
 ~LELAttribute ()
 Destructor.
LELAttributeoperator= (const LELAttribute &other)
 Assignment (copy semantics)
Bool isScalar () const
 Is expression a scalar?
Bool isReduced () const
 Is expression a reduced array? A scalar is always reduced.
Bool isRegion () const
 Is expression a region?
Bool isMasked () const
 Is the expression result masked?
const IPositionshape () const
 What is the shape of the expression?
const IPositiontileShape () const
 What is the tile shape of the expression?
const LELCoordinatescoordinates () const
 What are the coordinates of the expression?
Int compareCoord (const LELAttribute &other) const
 Compare the coordinates and shapes to see if this is a subset of other.

Private Attributes

Bool isScalar_p
Bool isReduced_p
Bool isRegion_p
Bool isMasked_p
IPosition shape_p
IPosition tileShape_p
LELCoordinates coords_p

Detailed Description

Ancillary information for the LEL letter classes.

Intended use:

Internal

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

Holds attribute information for the Lattice Expression Language letter classes.

Synopsis

The Lattice Expression Language letter classes provide expression objects. There is ancilliary information or attributes associated with these objects:

Two attribute objects can be combined mirroring the combination of two expressions (like the addition of two lattices). Regions cannot be combined.

Definition at line 80 of file LELAttribute.h.


Constructor & Destructor Documentation

Default constructor sets it as a scalar.

casa::LELAttribute::LELAttribute ( Bool  isMasked,
const IPosition shape,
const IPosition tileShape,
const LELCoordinates coordinates,
Bool  isReduced = False 
)

Constructor sets it as lattice with given attributes.

An empty shape indicates that the shape is not known.

casa::LELAttribute::LELAttribute ( uInt  regionNdim) [explicit]

Constructor sets it as a region with given attributes.

Copy constructor (copy semantics)

casa::LELAttribute::LELAttribute ( const LELAttribute attrLeft,
const LELAttribute attrRight,
Bool  matchAxes = True 
)

Constructor that combines the two attributes given.

An array can be combined with a scalar. If matchAxes is True and if two arrays are given, the shapes and coordinates have to match exactly, otherwise one can be a subset of the other (and LEL will auto-extend).

Destructor.


Member Function Documentation

Compare the coordinates and shapes to see if this is a subset of other.

What are the coordinates of the expression?

Definition at line 134 of file LELAttribute.h.

References coords_p.

Bool casa::LELAttribute::isMasked ( ) const [inline]

Is the expression result masked?

Definition at line 125 of file LELAttribute.h.

References isMasked_p.

Referenced by casa::LatticeExprNode::isMasked().

Bool casa::LELAttribute::isReduced ( ) const [inline]

Is expression a reduced array? A scalar is always reduced.

Definition at line 119 of file LELAttribute.h.

References isReduced_p.

Bool casa::LELAttribute::isRegion ( ) const [inline]

Is expression a region?

Definition at line 122 of file LELAttribute.h.

References isRegion_p.

Referenced by casa::LatticeExprNode::isRegion().

Bool casa::LELAttribute::isScalar ( ) const [inline]

Is expression a scalar?

Definition at line 116 of file LELAttribute.h.

References isScalar_p.

Referenced by casa::LELInterface< Complex >::isScalar(), and casa::LatticeExprNode::isScalar().

LELAttribute& casa::LELAttribute::operator= ( const LELAttribute other)

Assignment (copy semantics)

const IPosition& casa::LELAttribute::shape ( ) const [inline]

What is the shape of the expression?

Definition at line 128 of file LELAttribute.h.

References shape_p.

Referenced by casa::LELInterface< Complex >::shape(), and casa::LatticeExprNode::shape().

const IPosition& casa::LELAttribute::tileShape ( ) const [inline]

What is the tile shape of the expression?

Definition at line 131 of file LELAttribute.h.

References tileShape_p.


Member Data Documentation

Definition at line 146 of file LELAttribute.h.

Referenced by coordinates().

Definition at line 143 of file LELAttribute.h.

Referenced by isMasked().

Definition at line 141 of file LELAttribute.h.

Referenced by isReduced().

Definition at line 142 of file LELAttribute.h.

Referenced by isRegion().

Definition at line 140 of file LELAttribute.h.

Referenced by isScalar().

Definition at line 144 of file LELAttribute.h.

Referenced by shape().

Definition at line 145 of file LELAttribute.h.

Referenced by tileShape().


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