casacore
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::TableExprFuncNodeArray Class Reference

Class representing an array function in table select expression. More...

#include <ExprFuncNodeArray.h>

Public Member Functions

 TableExprFuncNodeArray (TableExprFuncNode::FunctionType, NodeDataType, ValueType, const TableExprNodeSet &source, const TaQLStyle &)
 Constructor. More...
 
 ~TableExprFuncNodeArray ()
 Destructor. More...
 
virtual void getAggrNodes (vector< TableExprNodeRep * > &aggr)
 Get the nodes representing an aggregate function. More...
 
virtual void getColumnNodes (vector< TableExprNodeRep * > &cols)
 Get the nodes representing a table column. More...
 
virtual Array< BoolgetArrayBool (const TableExprId &id)
 'get' Functions to get the desired result of a function More...
 
virtual Array< Int64getArrayInt (const TableExprId &id)
 
virtual Array< DoublegetArrayDouble (const TableExprId &id)
 The default implementation of getArrayDouble does getArrayInt and converts the result. More...
 
virtual Array< DComplex > getArrayDComplex (const TableExprId &id)
 The default implementation of getArrayDComplex does getArrayDouble and converts the result. More...
 
virtual Array< StringgetArrayString (const TableExprId &id)
 
virtual Array< MVTimegetArrayDate (const TableExprId &id)
 
const TableExprFuncNodegetChild () const
 Get the function node. More...
 
TableExprFuncNodegetChild ()
 
- Public Member Functions inherited from casacore::TableExprNodeArray
 TableExprNodeArray (NodeDataType, OperType)
 Create the object. More...
 
 TableExprNodeArray (const TableExprNodeRep &node, NodeDataType, OperType)
 
 TableExprNodeArray (NodeDataType, OperType, const IPosition &shape)
 
 ~TableExprNodeArray ()
 
virtual TableExprNodeRepmakeConstantScalar ()
 Turn a constant array with one element into a scalar. More...
 
virtual const IPositiongetShape (const TableExprId &id)
 Get the shape of the array in the given row. More...
 
virtual Bool hasBool (const TableExprId &id, Bool value)
 Does a value occur in the set? 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 Array< BoolhasArrayBool (const TableExprId &id, const Array< Bool > &value)
 
virtual Array< BoolhasArrayInt (const TableExprId &id, const Array< Int64 > &value)
 
virtual Array< BoolhasArrayDouble (const TableExprId &id, const Array< Double > &value)
 
virtual Array< BoolhasArrayDComplex (const TableExprId &id, const Array< DComplex > &value)
 
virtual Array< BoolhasArrayString (const TableExprId &id, const Array< String > &value)
 
virtual Array< BoolhasArrayDate (const TableExprId &id, const Array< MVTime > &value)
 
virtual Bool getElemBool (const TableExprId &id, const Slicer &index)
 Get a single element from the array in the given row. More...
 
virtual Int64 getElemInt (const TableExprId &id, const Slicer &index)
 
virtual Double getElemDouble (const TableExprId &id, const Slicer &index)
 
virtual DComplex getElemDComplex (const TableExprId &id, const Slicer &index)
 
virtual String getElemString (const TableExprId &id, const Slicer &index)
 
virtual MVTime getElemDate (const TableExprId &id, const Slicer &index)
 
virtual Array< BoolgetSliceBool (const TableExprId &id, const Slicer &)
 Get a slice of the array in the given row. More...
 
virtual Array< Int64getSliceInt (const TableExprId &id, const Slicer &)
 
virtual Array< DoublegetSliceDouble (const TableExprId &id, const Slicer &)
 
virtual Array< DComplex > getSliceDComplex (const TableExprId &id, const Slicer &)
 
virtual Array< StringgetSliceString (const TableExprId &id, const Slicer &)
 
virtual Array< MVTimegetSliceDate (const TableExprId &id, const Slicer &)
 
virtual Array< BoolgetElemColumnBool (const Vector< uInt > &rownrs, const Slicer &)
 Get a single element for the entire column (used by sort). More...
 
virtual Array< uChargetElemColumnuChar (const Vector< uInt > &rownrs, const Slicer &)
 
virtual Array< ShortgetElemColumnShort (const Vector< uInt > &rownrs, const Slicer &)
 
virtual Array< uShortgetElemColumnuShort (const Vector< uInt > &rownrs, const Slicer &)
 
virtual Array< IntgetElemColumnInt (const Vector< uInt > &rownrs, const Slicer &)
 
virtual Array< uIntgetElemColumnuInt (const Vector< uInt > &rownrs, const Slicer &)
 
virtual Array< FloatgetElemColumnFloat (const Vector< uInt > &rownrs, const Slicer &)
 
virtual Array< DoublegetElemColumnDouble (const Vector< uInt > &rownrs, const Slicer &)
 
virtual Array< Complex > getElemColumnComplex (const Vector< uInt > &rownrs, const Slicer &)
 
virtual Array< DComplex > getElemColumnDComplex (const Vector< uInt > &rownrs, const Slicer &)
 
virtual Array< StringgetElemColumnString (const Vector< uInt > &rownrs, const Slicer &)
 
- Public Member Functions inherited from casacore::TableExprNodeBinary
 TableExprNodeBinary (NodeDataType, ValueType, OperType, const Table &)
 Constructor. More...
 
 TableExprNodeBinary (NodeDataType, const TableExprNodeRep &, OperType)
 
virtual ~TableExprNodeBinary ()
 Destructor. More...
 
virtual void show (ostream &, uInt indent) const
 Show the expression tree. More...
 
virtual void handleUnits ()
 Handle the units of the children and possibly set the parent's unit. More...
 
void convertConstChild ()
 When one of the children is a constant, convert its data type to that of the other operand. More...
 
const TableExprNodeRepgetLeftChild () const
 Get the child nodes. More...
 
const TableExprNodeRepgetRightChild () const
 
- 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...
 
TableExprNodeReplink ()
 Link to this object, i.e. 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...
 
virtual CountedPtr< TableExprGroupFuncBasemakeGroupAggrFunc ()
 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)
 
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, Array< Bool > &value)
 
void get (const TableExprId &id, Array< Int64 > &value)
 
void get (const TableExprId &id, Array< Double > &value)
 
void get (const TableExprId &id, Array< DComplex > &value)
 
void get (const TableExprId &id, Array< MVTime > &value)
 
void get (const TableExprId &id, Array< String > &value)
 
Array< BoolgetBoolAS (const TableExprId &id)
 Get a value as an array, even it it is a scalar. More...
 
Array< Int64getIntAS (const TableExprId &id)
 
Array< DoublegetDoubleAS (const TableExprId &id)
 
Array< DComplex > getDComplexAS (const TableExprId &id)
 
Array< StringgetStringAS (const TableExprId &id)
 
Array< MVTimegetDateAS (const TableExprId &id)
 
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< 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...
 
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...
 
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
 
virtual void adaptSetUnits (const Unit &)
 Let a set node convert itself to the given unit. More...
 

Static Public Member Functions

static TableExprNodeRepfillNode (TableExprFuncNodeArray *thisNode, PtrBlock< TableExprNodeRep * > &nodes, const Block< Int > &dtypeOper)
 Link the children to the node and convert the children to constants if possible. More...
 
- Static Public Member Functions inherited from casacore::TableExprNodeArray
static Array< Int64makeArray (const IPosition &shape, Int64 value)
 Make an array with the given shape and fill it with the value. More...
 
static Array< DoublemakeArray (const IPosition &shape, Double value)
 
static Array< DComplex > makeArray (const IPosition &shape, const DComplex &value)
 
- Static Public Member Functions inherited from casacore::TableExprNodeBinary
static NodeDataType getDT (NodeDataType leftDtype, NodeDataType rightDype, OperType operType)
 Check the data types and get the common one. More...
 
static TableExprNodeRep getTypes (const TableExprNodeRep &left, const TableExprNodeRep &right, OperType operType)
 Check the data and value types and get the common one. More...
 
static TableExprNodeRepfillNode (TableExprNodeBinary *thisNode, TableExprNodeRep *left, TableExprNodeRep *right, Bool convertConstType, Bool adaptDataType=True)
 Link the children to the node and convert the children to constants if needed and possible. More...
 
- Static Public Member Functions inherited from casacore::TableExprNodeRep
static void unlink (TableExprNodeRep *)
 Unlink from the given object. More...
 
static void checkAggrFuncs (const TableExprNodeRep *node)
 Throw an exception if an aggregate function is used in the expression node. 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

void tryToConst ()
 Try if the function gives a constant result. More...
 
const PtrBlock< TableExprNodeRep * > & operands () const
 Some functions to be used by TableExprNodeFuncArray. More...
 
PtrBlock< TableExprNodeRep * > & rwOperands ()
 
TableExprFuncNode::FunctionType funcType () const
 
NodeDataType argDataType () const
 
- Protected Member Functions inherited from casacore::TableExprNodeRep
void checkTablePtr (const TableExprNodeRep *node)
 Check if this node uses the same table pointer. More...
 
void fillExprType (const TableExprNodeRep *node)
 Set expression type to Variable if node is Variable. More...
 

Private Member Functions

void setScale (Double scale)
 Set unit scale factor (needed for sqrt). More...
 
IPosition getAxes (const TableExprId &id, Int ndim, uInt axarg=1, Bool swapRemove=True)
 Get the collapse axes for the partial functions. More...
 
IPosition removeAxes (const IPosition &axes, Int ndim) const
 Remove axes exceeding ndim. More...
 
const IPositiongetArrayShape (const TableExprId &id, uInt axarg=1)
 Get the shape for the array function. More...
 
IPosition getOrder (const TableExprId &id, Int ndim)
 Get the transpose order of the array axes. More...
 
const IPositiongetAlternate (const TableExprId &id)
 Set the alternate value expandAlt_p for array expand and return it. More...
 

Private Attributes

TableExprFuncNode node_p
 
Int origin_p
 
Bool isCOrder_p
 
Bool constAxes_p
 
Bool constAlt_p
 
IPosition ipos_p
 
IPosition iposN_p
 
IPosition expandAlt_p
 

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 Protected Member Functions inherited from casacore::TableExprNodeBinary
static const UnitmakeEqualUnits (TableExprNodeRep *left, TableExprNodeRep *&right)
 Make the units equal. More...
 
- Static Protected Member Functions inherited from casacore::TableExprNodeRep
static TableExprNodeRepgetRep (TableExprNode &)
 Get pointer to REPresentation object. More...
 
static void checkTablePtr (Table &table, const TableExprNodeRep *node)
 
static void fillExprType (ExprType &, const TableExprNodeRep *node)
 
static TableExprNodeRepconvertNode (TableExprNodeRep *thisNode, Bool convertConstType)
 When the node is constant, it is evaluated and replaced by the appropriate TableExprNodeConst object. More...
 
- Protected Attributes inherited from casacore::TableExprNodeArray
IPosition varShape_p
 
- Protected Attributes inherited from casacore::TableExprNodeBinary
TableExprNodeReplnode_p
 
TableExprNodeReprnode_p
 
- Protected Attributes inherited from casacore::TableExprNodeRep
uInt count_p
 
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
 

Detailed Description

Class representing an array function in table select expression.

Intended use:

Internal

Review Status

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

Prerequisite

Synopsis

This class can be seen as a specialization of TableExprFuncNode for functions returning arrays. However, it is derived from TableExprNodeArray to make it possible that the ExprNode classes use all array functionality offered by that base class.
Internally an TableExprFuncNode object is used.

When a TaQL function is used, TableExprFuncNode::checkOperands determines whether the result is a scalar or an array. Thereafter TableExprNode::newFunctionNode creates a TableExprFuncNode for scalars or a TableExprFuncNodeArray for arrays.

Definition at line 70 of file ExprFuncNodeArray.h.

Constructor & Destructor Documentation

casacore::TableExprFuncNodeArray::TableExprFuncNodeArray ( TableExprFuncNode::FunctionType  ,
NodeDataType  ,
ValueType  ,
const TableExprNodeSet source,
const TaQLStyle  
)

Constructor.

casacore::TableExprFuncNodeArray::~TableExprFuncNodeArray ( )

Destructor.

Member Function Documentation

NodeDataType casacore::TableExprFuncNodeArray::argDataType ( ) const
inlineprotected

Definition at line 124 of file ExprFuncNodeArray.h.

References casacore::TableExprFuncNode::argDataType(), and node_p.

static TableExprNodeRep* casacore::TableExprFuncNodeArray::fillNode ( TableExprFuncNodeArray thisNode,
PtrBlock< TableExprNodeRep * > &  nodes,
const Block< Int > &  dtypeOper 
)
static

Link the children to the node and convert the children to constants if possible.

Also convert the node to constant if possible.

Referenced by getChild().

TableExprFuncNode::FunctionType casacore::TableExprFuncNodeArray::funcType ( ) const
inlineprotected

Definition at line 122 of file ExprFuncNodeArray.h.

References casacore::TableExprFuncNode::funcType(), and node_p.

virtual void casacore::TableExprFuncNodeArray::getAggrNodes ( vector< TableExprNodeRep * > &  aggr)
virtual

Get the nodes representing an aggregate function.

Reimplemented from casacore::TableExprNodeBinary.

Reimplemented in casacore::TableExprAggrNodeArray.

const IPosition& casacore::TableExprFuncNodeArray::getAlternate ( const TableExprId id)
private

Set the alternate value expandAlt_p for array expand and return it.

Referenced by setScale().

virtual Array<Bool> casacore::TableExprFuncNodeArray::getArrayBool ( const TableExprId id)
virtual

'get' Functions to get the desired result of a function

Reimplemented from casacore::TableExprNodeRep.

Reimplemented in casacore::TableExprConeNodeArray, and casacore::TableExprAggrNodeArray.

virtual Array<MVTime> casacore::TableExprFuncNodeArray::getArrayDate ( const TableExprId id)
virtual

Reimplemented from casacore::TableExprNodeRep.

Reimplemented in casacore::TableExprAggrNodeArray.

virtual Array<DComplex> casacore::TableExprFuncNodeArray::getArrayDComplex ( const TableExprId id)
virtual

The default implementation of getArrayDComplex does getArrayDouble and converts the result.

Reimplemented from casacore::TableExprNodeArray.

Reimplemented in casacore::TableExprAggrNodeArray.

virtual Array<Double> casacore::TableExprFuncNodeArray::getArrayDouble ( const TableExprId id)
virtual

The default implementation of getArrayDouble does getArrayInt and converts the result.

Reimplemented from casacore::TableExprNodeArray.

Reimplemented in casacore::TableExprAggrNodeArray.

virtual Array<Int64> casacore::TableExprFuncNodeArray::getArrayInt ( const TableExprId id)
virtual
const IPosition& casacore::TableExprFuncNodeArray::getArrayShape ( const TableExprId id,
uInt  axarg = 1 
)
private

Get the shape for the array function.

axarg gives the argument nr of the shape.

Referenced by setScale().

virtual Array<String> casacore::TableExprFuncNodeArray::getArrayString ( const TableExprId id)
virtual

Reimplemented from casacore::TableExprNodeRep.

Reimplemented in casacore::TableExprAggrNodeArray.

IPosition casacore::TableExprFuncNodeArray::getAxes ( const TableExprId id,
Int  ndim,
uInt  axarg = 1,
Bool  swapRemove = True 
)
private

Get the collapse axes for the partial functions.

It compares the values with the #dim and removes them if too high. axarg gives the argument nr of the axes.

Referenced by setScale().

const TableExprFuncNode* casacore::TableExprFuncNodeArray::getChild ( ) const
inline

Get the function node.

Definition at line 99 of file ExprFuncNodeArray.h.

References node_p.

TableExprFuncNode* casacore::TableExprFuncNodeArray::getChild ( )
inline

Definition at line 101 of file ExprFuncNodeArray.h.

References fillNode(), node_p, and tryToConst().

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

Get the nodes representing a table column.

Reimplemented from casacore::TableExprNodeBinary.

IPosition casacore::TableExprFuncNodeArray::getOrder ( const TableExprId id,
Int  ndim 
)
private

Get the transpose order of the array axes.

Referenced by setScale().

const PtrBlock<TableExprNodeRep*>& casacore::TableExprFuncNodeArray::operands ( ) const
inlineprotected

Some functions to be used by TableExprNodeFuncArray.

Definition at line 118 of file ExprFuncNodeArray.h.

References node_p, and casacore::TableExprFuncNode::operands().

Referenced by casacore::TableExprAggrNodeArray::operand().

IPosition casacore::TableExprFuncNodeArray::removeAxes ( const IPosition axes,
Int  ndim 
) const
private

Remove axes exceeding ndim.

Referenced by setScale().

PtrBlock<TableExprNodeRep*>& casacore::TableExprFuncNodeArray::rwOperands ( )
inlineprotected

Definition at line 120 of file ExprFuncNodeArray.h.

References node_p, and casacore::TableExprFuncNode::rwOperands().

void casacore::TableExprFuncNodeArray::setScale ( Double  scale)
inlineprivate
void casacore::TableExprFuncNodeArray::tryToConst ( )
protected

Try if the function gives a constant result.

If so, set the expression type to Constant.

Referenced by getChild().

Member Data Documentation

Bool casacore::TableExprFuncNodeArray::constAlt_p
private

Definition at line 156 of file ExprFuncNodeArray.h.

Bool casacore::TableExprFuncNodeArray::constAxes_p
private

Definition at line 155 of file ExprFuncNodeArray.h.

IPosition casacore::TableExprFuncNodeArray::expandAlt_p
private

Definition at line 159 of file ExprFuncNodeArray.h.

IPosition casacore::TableExprFuncNodeArray::ipos_p
private

Definition at line 157 of file ExprFuncNodeArray.h.

IPosition casacore::TableExprFuncNodeArray::iposN_p
private

Definition at line 158 of file ExprFuncNodeArray.h.

Bool casacore::TableExprFuncNodeArray::isCOrder_p
private

Definition at line 154 of file ExprFuncNodeArray.h.

TableExprFuncNode casacore::TableExprFuncNodeArray::node_p
private

Definition at line 152 of file ExprFuncNodeArray.h.

Referenced by argDataType(), funcType(), getChild(), operands(), rwOperands(), and setScale().

Int casacore::TableExprFuncNodeArray::origin_p
private

Definition at line 153 of file ExprFuncNodeArray.h.


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