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

Class to hold the table expression nodes for an element in a set. More...

#include <ExprNodeSet.h>

Inheritance diagram for casacore::TableExprNodeSetElem:
casacore::TableExprNodeRep

Public Member Functions

 TableExprNodeSetElem (const TableExprNode &node)
 Create the object for a single expression node. More...
 
 TableExprNodeSetElem (const TableExprNode *start, const TableExprNode *end, const TableExprNode *incr, Bool isEndExcl=False)
 Create the object for a discrete interval. More...
 
 TableExprNodeSetElem (Bool isLeftClosed, const TableExprNode &start, const TableExprNode &end, Bool isRightClosed)
 Create the object for a continuous bounded interval. More...
 
 TableExprNodeSetElem (Bool isLeftClosed, const TableExprNode &start)
 Create the object for a continuous left-bounded interval. More...
 
 TableExprNodeSetElem (const TableExprNode &end, Bool isRightClosed)
 Create the object for a continuous right-bounded interval. More...
 
 TableExprNodeSetElem (const TableExprNodeSetElem &)
 Copy constructor (copy semantics). More...
 
 ~TableExprNodeSetElem ()
 
void show (ostream &os, uInt indent) const
 Show the node. More...
 
virtual void getAggrNodes (std::vector< TableExprNodeRep * > &aggr)
 Get the nodes representing an aggregate function. More...
 
virtual void getColumnNodes (std::vector< TableExprNodeRep * > &cols)
 Get the nodes representing a table column. More...
 
Bool isDiscrete () const
 Is it a discrete set element. More...
 
Bool isSingle () const
 Is a single value given? More...
 
Bool isLeftClosed () const
 Is the interval left or right closed? More...
 
Bool isRightClosed () const
 
const TENShPtrstart () const
 Get the start, end or increment expression. More...
 
const TENShPtrend () const
 
const TENShPtrincrement () const
 
void fillVector (Vector< Bool > &vec, Int64 &cnt, const TableExprId &id) const
 Fill a vector with the value(s) from this element by appending them at the end of the vector; the end is given by argument cnt which gets incremented with the number of values appended. More...
 
void fillVector (Vector< Int64 > &vec, Int64 &cnt, const TableExprId &id) const
 
void fillVector (Vector< Double > &vec, Int64 &cnt, const TableExprId &id) const
 
void fillVector (Vector< DComplex > &vec, Int64 &cnt, const TableExprId &id) const
 
void fillVector (Vector< String > &vec, Int64 &cnt, const TableExprId &id) const
 
void fillVector (Vector< MVTime > &vec, Int64 &cnt, const TableExprId &id) const
 
void matchBool (Bool *match, const Bool *value, uInt nval, const TableExprId &id) const
 Set a flag in the match output array if the corresponding element in the value array is included in this set element. More...
 
void matchInt (Bool *match, const Int64 *value, uInt nval, const TableExprId &id) const
 
void matchDouble (Bool *match, const Double *value, uInt nval, const TableExprId &id) const
 
void matchDComplex (Bool *match, const DComplex *value, uInt nval, const TableExprId &id) const
 
void matchString (Bool *match, const String *value, uInt nval, const TableExprId &id) const
 
void matchDate (Bool *match, const MVTime *value, uInt nval, const TableExprId &id) const
 
TableExprNodeSetElemevaluate (const TableExprId &id) const
 Evaluate the element for the given row and construct a new (constant) element from it. More...
 
void checkTable ()
 Get the table of a node and check if the children use the same table. More...
 
virtual void adaptSetUnits (const Unit &)
 Let a set node convert itself to the given unit. More...
 
- Public Member Functions inherited from casacore::TableExprNodeRep
 TableExprNodeRep (NodeDataType, ValueType, OperType, ArgType, ExprType, Int ndim, const IPosition &shape, const Table &table)
 Construct a node. More...
 
 TableExprNodeRep (NodeDataType, ValueType, OperType, const Table &)
 This constructor is called from the derived TableExprNodeRep. More...
 
 TableExprNodeRep (const TableExprNodeRep &)
 Copy constructor. More...
 
virtual ~TableExprNodeRep ()
 The destructor deletes all the underlying TableExprNode objects. More...
 
virtual void disableApplySelection ()
 Do not apply the selection. More...
 
virtual void applySelection (const Vector< uInt > &rownrs)
 Re-create the column object for a selection of rows. More...
 
virtual Double getUnitFactor () const
 Get the unit conversion factor. More...
 
void checkAggrFuncs ()
 Throw an exception if an aggregate function is used in the expression node or its children. More...
 
virtual CountedPtr
< TableExprGroupFuncBase
makeGroupAggrFunc ()
 Create the correct immediate aggregate function object. More...
 
virtual Bool isLazyAggregate () const
 Is the aggregate function a lazy or an immediate one? The default implementation returns True (because all UDF aggregate functions have to be lazy). More...
 
virtual Bool getBool (const TableExprId &id)
 Get a scalar value for this node in the given row. More...
 
virtual Int64 getInt (const TableExprId &id)
 
virtual Double getDouble (const TableExprId &id)
 
virtual DComplex getDComplex (const TableExprId &id)
 
virtual String getString (const TableExprId &id)
 
virtual TaqlRegex getRegex (const TableExprId &id)
 
virtual MVTime getDate (const TableExprId &id)
 
virtual MArray< BoolgetArrayBool (const TableExprId &id)
 Get an array value for this node in the given row. More...
 
virtual MArray< Int64getArrayInt (const TableExprId &id)
 
virtual MArray< DoublegetArrayDouble (const TableExprId &id)
 
virtual MArray< DComplex > getArrayDComplex (const TableExprId &id)
 
virtual MArray< StringgetArrayString (const TableExprId &id)
 
virtual MArray< MVTimegetArrayDate (const TableExprId &id)
 
void get (const TableExprId &id, Bool &value)
 General get functions for template purposes. More...
 
void get (const TableExprId &id, Int64 &value)
 
void get (const TableExprId &id, Double &value)
 
void get (const TableExprId &id, DComplex &value)
 
void get (const TableExprId &id, MVTime &value)
 
void get (const TableExprId &id, String &value)
 
void get (const TableExprId &id, MArray< Bool > &value)
 
void get (const TableExprId &id, MArray< Int64 > &value)
 
void get (const TableExprId &id, MArray< Double > &value)
 
void get (const TableExprId &id, MArray< DComplex > &value)
 
void get (const TableExprId &id, MArray< MVTime > &value)
 
void get (const TableExprId &id, MArray< String > &value)
 
MArray< BoolgetBoolAS (const TableExprId &id)
 Get a value as an array, even it it is a scalar. More...
 
MArray< Int64getIntAS (const TableExprId &id)
 
MArray< DoublegetDoubleAS (const TableExprId &id)
 
MArray< DComplex > getDComplexAS (const TableExprId &id)
 
MArray< StringgetStringAS (const TableExprId &id)
 
MArray< MVTimegetDateAS (const TableExprId &id)
 
virtual Bool hasBool (const TableExprId &id, Bool value)
 Does a value occur in an array or set? The default implementation tests if it is in an array. More...
 
virtual Bool hasInt (const TableExprId &id, Int64 value)
 
virtual Bool hasDouble (const TableExprId &id, Double value)
 
virtual Bool hasDComplex (const TableExprId &id, const DComplex &value)
 
virtual Bool hasString (const TableExprId &id, const String &value)
 
virtual Bool hasDate (const TableExprId &id, const MVTime &value)
 
virtual MArray< BoolhasArrayBool (const TableExprId &id, const MArray< Bool > &value)
 
virtual MArray< BoolhasArrayInt (const TableExprId &id, const MArray< Int64 > &value)
 
virtual MArray< BoolhasArrayDouble (const TableExprId &id, const MArray< Double > &value)
 
virtual MArray< BoolhasArrayDComplex (const TableExprId &id, const MArray< DComplex > &value)
 
virtual MArray< BoolhasArrayString (const TableExprId &id, const MArray< String > &value)
 
virtual MArray< BoolhasArrayDate (const TableExprId &id, const MArray< MVTime > &value)
 
uInt nrow () const
 Get the number of rows in the table associated with this expression. More...
 
virtual Bool getColumnDataType (DataType &) const
 Get the data type of the column. More...
 
virtual Array< BoolgetColumnBool (const Vector< uInt > &rownrs)
 Get the value of the expression evaluated for the entire column. More...
 
virtual Array< uChargetColumnuChar (const Vector< uInt > &rownrs)
 
virtual Array< ShortgetColumnShort (const Vector< uInt > &rownrs)
 
virtual Array< uShortgetColumnuShort (const Vector< uInt > &rownrs)
 
virtual Array< IntgetColumnInt (const Vector< uInt > &rownrs)
 
virtual Array< uIntgetColumnuInt (const Vector< uInt > &rownrs)
 
virtual Array< Int64getColumnInt64 (const Vector< uInt > &rownrs)
 
virtual Array< FloatgetColumnFloat (const Vector< uInt > &rownrs)
 
virtual Array< DoublegetColumnDouble (const Vector< uInt > &rownrs)
 
virtual Array< Complex > getColumnComplex (const Vector< uInt > &rownrs)
 
virtual Array< DComplex > getColumnDComplex (const Vector< uInt > &rownrs)
 
virtual Array< StringgetColumnString (const Vector< uInt > &rownrs)
 
virtual void ranges (Block< TableExprRange > &)
 Convert the tree to a number of range vectors which at least select the same things. More...
 
NodeDataType dataType () const
 Get the data type of the derived TableExprNode object. More...
 
Bool isReal () const
 Is the data type real (i.e., integer or double)? More...
 
ValueType valueType () const
 Get the value type. More...
 
void setValueType (ValueType vtype)
 Set the value type. More...
 
OperType operType () const
 Get the operator type. More...
 
ExprType exprType () const
 Get the expression type. More...
 
Bool isConstant () const
 Is the expression a constant? More...
 
const Unitunit () const
 Get the unit. More...
 
void setUnit (const Unit &unit)
 Set the unit. More...
 
const Recordattributes () const
 Get the attributes. More...
 
void setAttributes (const Record &)
 Set the attributes. More...
 
Int ndim () const
 Get the fixed dimensionality (same for all rows). More...
 
const IPositionshape () const
 Get the fixed shape (same for all rows). More...
 
const IPositionshape (const TableExprId &id)
 Get the shape for the given row. More...
 
virtual Bool isDefined (const TableExprId &id)
 Is the value in the given row defined? The default implementation returns True. More...
 
Tabletable ()
 Get table. More...
 
const Tabletable () const
 

Private Member Functions

TableExprNodeSetElemoperator= (const TableExprNodeSetElem &)
 A copy of a TableExprNodeSetElem cannot be made. More...
 
 TableExprNodeSetElem (const TableExprNodeSetElem &that, const TENShPtr &start, const TENShPtr &end, const TENShPtr &incr)
 Construct an element from the given parts and take over their pointers. More...
 
void setup (Bool isLeftClosed, const TableExprNode *start, const TableExprNode *end, Bool isRightClosed)
 Setup the object for a continuous interval. More...
 

Private Attributes

TENShPtr itsStart
 
TENShPtr itsEnd
 
TENShPtr itsIncr
 
Bool itsEndExcl
 
Bool itsLeftClosed
 
Bool itsRightClosed
 
Bool itsDiscrete
 
Bool itsSingle
 

Additional Inherited Members

- Public Types inherited from casacore::TableExprNodeRep
enum  NodeDataType {
  NTBool,
  NTInt,
  NTDouble,
  NTComplex,
  NTString,
  NTRegex,
  NTDate,
  NTReal,
  NTDouCom,
  NTNumeric,
  NTAny
}
 Define the data types of a node. More...
 
enum  ValueType {
  VTScalar,
  VTArray,
  VTRecord,
  VTSetElem,
  VTSet,
  VTIndex
}
 Define the value types. More...
 
enum  OperType {
  OtPlus,
  OtMinus,
  OtTimes,
  OtDivide,
  OtModulo,
  OtBitAnd,
  OtBitOr,
  OtBitXor,
  OtBitNegate,
  OtEQ,
  OtGE,
  OtGT,
  OtNE,
  OtIN,
  OtAND,
  OtOR,
  OtNOT,
  OtMIN,
  OtColumn,
  OtField,
  OtLiteral,
  OtFunc,
  OtSlice,
  OtUndef,
  OtRownr,
  OtRandom
}
 Define the operator types. More...
 
enum  ArgType {
  NoArr,
  ArrArr,
  ArrSca,
  ScaArr
}
 Define the value types of the 2 arguments when arrays are involved. More...
 
enum  ExprType {
  Constant,
  Variable
}
 Define (sub-)expression type. More...
 
- Static Public Member Functions inherited from casacore::TableExprNodeRep
static TENShPtr replaceConstNode (const TENShPtr &node)
 Replace a node with a constant expression by node with its value. More...
 
static void createRange (Block< TableExprRange > &, TableExprNodeColumn *, Double start, Double end)
 Create a range object from a column and an interval. More...
 
static void createRange (Block< TableExprRange > &)
 Create a empty range object. More...
 
static String typeString (NodeDataType)
 Convert a NodeDataType to a string. More...
 
static String typeString (ValueType)
 Convert a ValueType to a string. More...
 
- Protected Member Functions inherited from casacore::TableExprNodeRep
virtual const IPositiongetShape (const TableExprId &id)
 Get the shape for the given row. More...
 
virtual void convertConstChild ()
 If one of the children is a constant, convert its data type to that of the other operand (if appropriate). More...
 
void checkTablePtr (const TENShPtr &node)
 Check if this node uses the same table pointer. More...
 
void fillExprType (const TENShPtr &node)
 Set expression type to Variable if node is Variable. More...
 
- Static Protected Member Functions inherited from casacore::TableExprNodeRep
static void checkTablePtr (Table &table, const TENShPtr &node)
 
static void fillExprType (ExprType &, const TENShPtr &node)
 
static TENShPtr convertNode (const TENShPtr &thisNode, Bool convertConstType)
 If the node is constant, it is evaluated and replaced by the appropriate TableExprNodeConst object. More...
 
- Protected Attributes inherited from casacore::TableExprNodeRep
Table table_p
 
NodeDataType dtype_p
 
ValueType vtype_p
 
OperType optype_p
 
ArgType argtype_p
 
ExprType exprtype_p
 
Int ndim_p
 
IPosition shape_p
 
Unit unit_p
 
Record attributes_p
 

Detailed Description

Class to hold the table expression nodes for an element in a set.

Intended use:

Public interface

Review Status

Reviewed By:
UNKNOWN
Date Reviewed:
before2004/08/25

Prerequisite

Synopsis

This class is used to assemble the table expression nodes representing an element in a set. A set element can be of 3 types:

  1. A single discrete value, which can be of any type. It can be used for 3 purposes:
    - A function argument.
    - A single index in an array indexing operation.
    - A single value in a set (used with the IN operator). This is in fact a bounded discrete interval (see below).
  2. A discrete interval consisting of start, end and increment. Each of those has to be an int scalar. Increment defaults to 1. It can be used for 2 purposes:
    - A slice in an array indexing operation. In that case start defaults to the beginning of the dimension and end defaults to the end.
    - A discrete interval in a set. Start has to be given. When end is not given, the result is an unbounded discrete interval. For a discrete interval, the type of start and end can also be a datetime scalar.
  3. A continuous interval, which can only be used in a set. It consists of a start and/or an end scalar value of type int, double, datetime, or string. The interval can be open or closed on one or both sides.

Note the difference between a discrete and a continuous interval. E.g. the discrete interval 2,6 consists of the five values 2,3,4,5,6. The continuous interval 2,6 consists of all values between them.
Further note that a bounded discrete interval is automatically converted to a vector, which makes it possible to apply array functions to it.

Definition at line 94 of file ExprNodeSet.h.

Constructor & Destructor Documentation

casacore::TableExprNodeSetElem::TableExprNodeSetElem ( const TableExprNode node)
explicit

Create the object for a single expression node.

casacore::TableExprNodeSetElem::TableExprNodeSetElem ( const TableExprNode start,
const TableExprNode end,
const TableExprNode incr,
Bool  isEndExcl = False 
)

Create the object for a discrete interval.

Each of the start, end, and incr pointers can be zero meaning that they are not given (see the synopsis for an explanation). Optionally the end is inclusive (C++ and Glish style) or exclusive (Python style).

casacore::TableExprNodeSetElem::TableExprNodeSetElem ( Bool  isLeftClosed,
const TableExprNode start,
const TableExprNode end,
Bool  isRightClosed 
)

Create the object for a continuous bounded interval.

It can be open or closed on either side.

casacore::TableExprNodeSetElem::TableExprNodeSetElem ( Bool  isLeftClosed,
const TableExprNode start 
)

Create the object for a continuous left-bounded interval.

casacore::TableExprNodeSetElem::TableExprNodeSetElem ( const TableExprNode end,
Bool  isRightClosed 
)

Create the object for a continuous right-bounded interval.

casacore::TableExprNodeSetElem::TableExprNodeSetElem ( const TableExprNodeSetElem )

Copy constructor (copy semantics).

casacore::TableExprNodeSetElem::~TableExprNodeSetElem ( )
casacore::TableExprNodeSetElem::TableExprNodeSetElem ( const TableExprNodeSetElem that,
const TENShPtr start,
const TENShPtr end,
const TENShPtr incr 
)
private

Construct an element from the given parts and take over their pointers.

It is used by evaluate to construct an element in a rather cheap way.

Member Function Documentation

virtual void casacore::TableExprNodeSetElem::adaptSetUnits ( const Unit )
virtual

Let a set node convert itself to the given unit.

Reimplemented from casacore::TableExprNodeRep.

void casacore::TableExprNodeSetElem::checkTable ( )

Get the table of a node and check if the children use the same table.

const TENShPtr & casacore::TableExprNodeSetElem::end ( ) const
inline

Definition at line 253 of file ExprNodeSet.h.

References itsEnd.

TableExprNodeSetElem* casacore::TableExprNodeSetElem::evaluate ( const TableExprId id) const

Evaluate the element for the given row and construct a new (constant) element from it.

This is used by the system to implement a set in a GIVING clause.

void casacore::TableExprNodeSetElem::fillVector ( Vector< Bool > &  vec,
Int64 cnt,
const TableExprId id 
) const

Fill a vector with the value(s) from this element by appending them at the end of the vector; the end is given by argument cnt which gets incremented with the number of values appended.

This is used by the system to convert a set to a vector.

void casacore::TableExprNodeSetElem::fillVector ( Vector< Int64 > &  vec,
Int64 cnt,
const TableExprId id 
) const
void casacore::TableExprNodeSetElem::fillVector ( Vector< Double > &  vec,
Int64 cnt,
const TableExprId id 
) const
void casacore::TableExprNodeSetElem::fillVector ( Vector< DComplex > &  vec,
Int64 cnt,
const TableExprId id 
) const
void casacore::TableExprNodeSetElem::fillVector ( Vector< String > &  vec,
Int64 cnt,
const TableExprId id 
) const
void casacore::TableExprNodeSetElem::fillVector ( Vector< MVTime > &  vec,
Int64 cnt,
const TableExprId id 
) const
virtual void casacore::TableExprNodeSetElem::getAggrNodes ( std::vector< TableExprNodeRep * > &  aggr)
virtual

Get the nodes representing an aggregate function.

Reimplemented from casacore::TableExprNodeRep.

virtual void casacore::TableExprNodeSetElem::getColumnNodes ( std::vector< TableExprNodeRep * > &  cols)
virtual

Get the nodes representing a table column.

Reimplemented from casacore::TableExprNodeRep.

const TENShPtr & casacore::TableExprNodeSetElem::increment ( ) const
inline

Definition at line 257 of file ExprNodeSet.h.

References itsIncr.

Bool casacore::TableExprNodeSetElem::isDiscrete ( ) const
inline

Is it a discrete set element.

Definition at line 233 of file ExprNodeSet.h.

References itsDiscrete.

Bool casacore::TableExprNodeSetElem::isLeftClosed ( ) const
inline

Is the interval left or right closed?

Definition at line 241 of file ExprNodeSet.h.

References itsLeftClosed.

Bool casacore::TableExprNodeSetElem::isRightClosed ( ) const
inline

Definition at line 245 of file ExprNodeSet.h.

References itsRightClosed.

Bool casacore::TableExprNodeSetElem::isSingle ( ) const
inline

Is a single value given?

Definition at line 237 of file ExprNodeSet.h.

References itsSingle.

void casacore::TableExprNodeSetElem::matchBool ( Bool match,
const Bool value,
uInt  nval,
const TableExprId id 
) const

Set a flag in the match output array if the corresponding element in the value array is included in this set element.

This is used by the system to implement the IN operator.
Note that it does NOT set match values to False; it is assumed they are initialized that way.

void casacore::TableExprNodeSetElem::matchDate ( Bool match,
const MVTime value,
uInt  nval,
const TableExprId id 
) const
void casacore::TableExprNodeSetElem::matchDComplex ( Bool match,
const DComplex *  value,
uInt  nval,
const TableExprId id 
) const
void casacore::TableExprNodeSetElem::matchDouble ( Bool match,
const Double value,
uInt  nval,
const TableExprId id 
) const
void casacore::TableExprNodeSetElem::matchInt ( Bool match,
const Int64 value,
uInt  nval,
const TableExprId id 
) const
void casacore::TableExprNodeSetElem::matchString ( Bool match,
const String value,
uInt  nval,
const TableExprId id 
) const
TableExprNodeSetElem& casacore::TableExprNodeSetElem::operator= ( const TableExprNodeSetElem )
private

A copy of a TableExprNodeSetElem cannot be made.

void casacore::TableExprNodeSetElem::setup ( Bool  isLeftClosed,
const TableExprNode start,
const TableExprNode end,
Bool  isRightClosed 
)
private

Setup the object for a continuous interval.

void casacore::TableExprNodeSetElem::show ( ostream &  os,
uInt  indent 
) const
virtual

Show the node.

Reimplemented from casacore::TableExprNodeRep.

const TENShPtr & casacore::TableExprNodeSetElem::start ( ) const
inline

Get the start, end or increment expression.

Note that the pointer returned can be zero indicating that that value was not given.

Definition at line 249 of file ExprNodeSet.h.

References itsStart.

Member Data Documentation

Bool casacore::TableExprNodeSetElem::itsDiscrete
private

Definition at line 227 of file ExprNodeSet.h.

Referenced by isDiscrete().

TENShPtr casacore::TableExprNodeSetElem::itsEnd
private

Definition at line 222 of file ExprNodeSet.h.

Referenced by end().

Bool casacore::TableExprNodeSetElem::itsEndExcl
private

Definition at line 224 of file ExprNodeSet.h.

TENShPtr casacore::TableExprNodeSetElem::itsIncr
private

Definition at line 223 of file ExprNodeSet.h.

Referenced by increment().

Bool casacore::TableExprNodeSetElem::itsLeftClosed
private

Definition at line 225 of file ExprNodeSet.h.

Referenced by isLeftClosed().

Bool casacore::TableExprNodeSetElem::itsRightClosed
private

Definition at line 226 of file ExprNodeSet.h.

Referenced by isRightClosed().

Bool casacore::TableExprNodeSetElem::itsSingle
private

Definition at line 228 of file ExprNodeSet.h.

Referenced by isSingle().

TENShPtr casacore::TableExprNodeSetElem::itsStart
private

Definition at line 221 of file ExprNodeSet.h.

Referenced by start().


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