Loading...
Searching...
No Matches
casacore::TableExprAggrNode Class Reference
tables package (libcasa_tables) » TaQL_module » TaQL_module_internal_classes

More...

`#include <ExprAggrNode.h>`

## Public Member Functions

| TableExprAggrNode (FunctionType, NodeDataType, ValueType, const TableExprNodeSet &source, const vector< TENShPtr > &nodes, const Block< Int > &dtypeOper)
| Constructor.
virtual Bool | isAggregate () const
| This node does aggregation.
TENShPtr | operand ()
| Get the operand node.
virtual std::shared_ptr< TableExprGroupFuncBase > | makeGroupAggrFunc ()
| Create the correct aggregate function object.
virtual Bool | isLazyAggregate () const
| Is the aggregate function a lazy or an immediate one?
virtual Bool | getBool (const TableExprId &id)
| Functions to get the result of an aggregate function.
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 MVTime | getDate (const TableExprId &id)
Public Member Functions inherited from casacore::TableExprFuncNode
| TableExprFuncNode (FunctionType, NodeDataType, ValueType, const TableExprNodeSet &source, const vector< TENShPtr > &nodes, const Block< Int > &dtypeOper, const TableExprInfo &=TableExprInfo())
| Constructor.
| ~TableExprFuncNode ()
| Destructor.
Bool | getBool (const TableExprId &id)
| 'get' Functions to get the desired result of a function
Int64 | getInt (const TableExprId &id)
Double | getDouble (const TableExprId &id)
DComplex | getDComplex (const TableExprId &id)
String | getString (const TableExprId &id)
TaqlRegex | getRegex (const TableExprId &id)
MVTime | getDate (const TableExprId &id)
void | fillUnits ()
| Fill the result unit in the node.
void | fillChildNodes (const vector< TENShPtr > &nodes, const Block< Int > &dtypeOper)
| Link the children to the node and convert the children to constants if possible.
Double | getScale () const
| Get possible unit scale factor (needed for sqrt).
const std::vector< TENShPtr > & | operands () const
| Some functions to be used by TableExprNodeFuncArray.
std::vector< TENShPtr > & | rwOperands ()
FunctionType | funcType () const
NodeDataType | argDataType () const
Public Member Functions inherited from casacore::TableExprNodeMulti
| TableExprNodeMulti (NodeDataType, ValueType, OperType, const TableExprNodeRep &source)
| Constructor.
| ~TableExprNodeMulti () override=default
| Destructor.
void | show (ostream &, uInt indent) const override
| Show the expression tree.
void | flattenTree (std::vector< TableExprNodeRep * > &) override
| Flatten the node tree by adding the node and its children to the vector.
const std::vector< TENShPtr > & | getChildren () const
| Get the child nodes.
Public Member Functions inherited from casacore::TableExprNodeRep
| TableExprNodeRep (NodeDataType, ValueType, OperType, ArgType, ExprType, Int ndim, const IPosition &shape)
| Construct a node.
| TableExprNodeRep (NodeDataType, ValueType, OperType, ExprType)
| This constructor is called from the derived TableExprNodeRep.
| TableExprNodeRep (const TableExprNodeRep &)=default
| Copy constructor.
TableExprNodeRep & | operator= (const TableExprNodeRep &)=delete
| Assign to a TableExprNodeRep cannot be done.
virtual | ~TableExprNodeRep ()=default
| The destructor deletes all the underlying TableExprNode objects.
virtual TableExprInfo | getTableInfo () const
| Get the table info.
virtual void | optimize ()
| Try to optimize the node (meant for the right hand of the IN operator).
virtual void | disableApplySelection ()
| Do not apply the selection.
virtual void | applySelection (const Vector< rownr_t > &rownrs)
| Re-create the column object for a selection of rows.
virtual Double | getUnitFactor () const
| Get the unit conversion factor.
virtual MArray< Bool > | getArrayBool (const TableExprId &id)
| Get an array value for this node in the given row.
virtual MArray< Int64 > | getArrayInt (const TableExprId &id)
virtual MArray< Double > | getArrayDouble (const TableExprId &id)
virtual MArray< DComplex > | getArrayDComplex (const TableExprId &id)
virtual MArray< String > | getArrayString (const TableExprId &id)
virtual MArray< MVTime > | getArrayDate (const TableExprId &id)
void | get (const TableExprId &id, Bool &value)
| General get functions for template purposes.
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< Bool > | getBoolAS (const TableExprId &id)
| Get a value as an array, even it it is a scalar.
MArray< Int64 > | getIntAS (const TableExprId &id)
MArray< Double > | getDoubleAS (const TableExprId &id)
MArray< DComplex > | getDComplexAS (const TableExprId &id)
MArray< String > | getStringAS (const TableExprId &id)
MArray< MVTime > | getDateAS (const TableExprId &id)
virtual Bool | contains (const TableExprId &id, Bool value)
| Does a set or array contain the value?
virtual Bool | contains (const TableExprId &id, Int64 value)
virtual Bool | contains (const TableExprId &id, Double value)
virtual Bool | contains (const TableExprId &id, DComplex value)
virtual Bool | contains (const TableExprId &id, String value)
virtual Bool | contains (const TableExprId &id, MVTime value)
virtual MArray< Bool > | contains (const TableExprId &id, const MArray< Bool > &value)
virtual MArray< Bool > | contains (const TableExprId &id, const MArray< Int64 > &value)
virtual MArray< Bool > | contains (const TableExprId &id, const MArray< Double > &value)
virtual MArray< Bool > | contains (const TableExprId &id, const MArray< DComplex > &value)
virtual MArray< Bool > | contains (const TableExprId &id, const MArray< String > &value)
virtual MArray< Bool > | contains (const TableExprId &id, const MArray< MVTime > &value)
rownr_t | nrow ()
| Get the number of rows in the table associated with this expression.
virtual Bool | getColumnDataType (DataType &) const
| Get the data type of the column.
virtual Array< Bool > | getColumnBool (const Vector< rownr_t > &rownrs)
| Get the value of the expression evaluated for the entire column.
virtual Array< uChar > | getColumnuChar (const Vector< rownr_t > &rownrs)
virtual Array< Short > | getColumnShort (const Vector< rownr_t > &rownrs)
virtual Array< uShort > | getColumnuShort (const Vector< rownr_t > &rownrs)
virtual Array< Int > | getColumnInt (const Vector< rownr_t > &rownrs)
virtual Array< uInt > | getColumnuInt (const Vector< rownr_t > &rownrs)
virtual Array< Int64 > | getColumnInt64 (const Vector< rownr_t > &rownrs)
virtual Array< Float > | getColumnFloat (const Vector< rownr_t > &rownrs)
virtual Array< Double > | getColumnDouble (const Vector< rownr_t > &rownrs)
virtual Array< Complex > | getColumnComplex (const Vector< rownr_t > &rownrs)
virtual Array< DComplex > | getColumnDComplex (const Vector< rownr_t > &rownrs)
virtual Array< String > | getColumnString (const Vector< rownr_t > &rownrs)
virtual void | ranges (Block< TableExprRange > &)
| Convert the tree to a number of range vectors which at least select the same things.
NodeDataType | dataType () const
| Get the data type of the derived TableExprNode object.
Bool | isReal () const
| Is the data type real (i.e., integer or double)?
ValueType | valueType () const
| Get the value type.
void | setValueType (ValueType vtype)
| Set the value type.
OperType | operType () const
| Get the operator type.
ExprType | exprType () const
| Get the expression type.
Bool | isConstant () const
| Is the expression a constant?
const Unit & | unit () const
| Get the unit.
void | setUnit (const Unit &unit)
| Set the unit.
const Record & | attributes () const
| Get the attributes.
void | setAttributes (const Record &)
| Set the attributes.
Int | ndim () const
| Get the fixed dimensionality (same for all rows).
const IPosition & | shape () const
| Get the fixed shape (same for all rows).
const IPosition & | shape (const TableExprId &id)
| Get the shape for the given row.
virtual Bool | isDefined (const TableExprId &id)
| Is the value in the given row defined?
virtual void | adaptSetUnits (const Unit &)
| Let a set node convert itself to the given unit.

## Static Public Member Functions

static NodeDataType | checkOperands (Block< Int > &dtypeOper, ValueType &resVT, FunctionType ftype, std::vector< TENShPtr > &nodes)
| Check the operands of the aggregate function and return the result's data type.
Static Public Member Functions inherited from casacore::TableExprFuncNode
static NodeDataType | checkOperands (Block< Int > &dtypeOper, ValueType &resVT, Block< Int > &vtypeOper, FunctionType, std::vector< TENShPtr > &)
| Check the data and value types of the operands.
static void | getPrintFormat (String &fmt, Int &width, Int &prec, const std::vector< TENShPtr > &operands, const TableExprId &id)
| Get the possible print format, width, and/or precision.
static String | stringDT (const MVTime &dt, Int prec, MVTime::formatTypes)
| Convert the date and/or time to a string.
static String | stringDateTime (const MVTime &dt, Int prec)
static String | stringDate (const MVTime &dt)
static String | stringTime (const MVTime &dt, Int prec)
static String | stringValue (Bool val, const String &fmt, Int width)
| Convert a value to a string.
static String | stringValue (Int64 val, const String &fmt, Int width)
static String | stringValue (Double val, const String &fmt, Int width, Int prec, const std::pair< int, int > &mvFormat, const Unit &unit)
static String | stringValue (const DComplex &val, const String &fmt, Int width, Int prec)
static String | stringValue (const String &val, const String &fmt, Int width)
static String | stringValue (const MVTime &val, const String &fmt, Int width, const std::pair< int, int > &mvFormat)
static String | stringAngle (double val, Int prec, MVAngle::formatTypes type)
| Convert angle to a string (hms or dms).
static String | stringHMS (double val, Int prec)
static String | stringDMS (double val, Int prec)
static std::pair< int, int > | getMVFormat (const String &fmt)
| Get the MVTime/Angle format and optional precision.
static double | angdist (double ra1, double dec1, double ra2, double dec2)
| Get the angular distance between two positions on a sphere.
static Int64 | string2Int (const String &)
| Read a string as an integer, double, complex or bool.
static Double | string2Real (const String &)
static DComplex | string2Complex (const String &)
static Bool | string2Bool (const String &)
Static Public Member Functions inherited from casacore::TableExprNodeMulti
static uInt | checkNumOfArg (uInt low, uInt high, const std::vector< TENShPtr > &nodes)
| Check number of arguments low <= number_of_args <= high It throws an exception if wrong number of arguments.
static NodeDataType | checkDT (Block< Int > &dtypeOper, NodeDataType dtIn, NodeDataType dtOut, const std::vector< TENShPtr > &nodes, Bool dateConv=True)
| Check datatype of nodes and return output type.
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.
static void | createRange (Block< TableExprRange > &, TableExprNodeColumn *, Double start, Double end)
| Create a range object from a column and an interval.
static void | createRange (Block< TableExprRange > &)
| Create a empty range object.
static String | typeString (NodeDataType)
| Convert a NodeDataType to a string.
static String | typeString (ValueType)
| Convert a ValueType to a string.

## Private Member Functions

TableExprGroupFuncBase * | doMakeGroupAggrFunc ()
| Do the actual creation of the correct aggregate function object.

## Private Attributes

std::shared_ptr< TableExprGroupFuncBase > | itsFunc

## Additional Inherited Members

Public Types inherited from casacore::TableExprFuncNode

enum

FunctionType {
piFUNC ,
eFUNC ,
cFUNC ,
near2FUNC ,
near3FUNC ,
nearabs2FUNC ,
nearabs3FUNC ,
sinFUNC ,
sinhFUNC ,
cosFUNC ,
coshFUNC ,
expFUNC ,
logFUNC ,
log10FUNC ,
sqrtFUNC ,
powFUNC ,
conjFUNC ,
squareFUNC ,
cubeFUNC ,
minFUNC ,
maxFUNC ,
normFUNC ,
absFUNC ,
argFUNC ,
realFUNC ,
imagFUNC ,
intFUNC ,
asinFUNC ,
acosFUNC ,
atanFUNC ,
atan2FUNC ,
tanFUNC ,
tanhFUNC ,
signFUNC ,
roundFUNC ,
floorFUNC ,
ceilFUNC ,
fmodFUNC ,
complexFUNC ,
arrsumFUNC ,
arrsumsFUNC ,
runsumFUNC ,
boxsumFUNC ,
arrproductFUNC ,
arrproductsFUNC ,
runproductFUNC ,
boxproductFUNC ,
arrsumsqrFUNC ,
arrsumsqrsFUNC ,
runsumsqrFUNC ,
boxsumsqrFUNC ,
arrminFUNC ,
arrminsFUNC ,
runminFUNC ,
boxminFUNC ,
arrmaxFUNC ,
arrmaxsFUNC ,
runmaxFUNC ,
boxmaxFUNC ,
arrmeanFUNC ,
arrmeansFUNC ,
runmeanFUNC ,
boxmeanFUNC ,
arrvariance0FUNC ,
arrvariances0FUNC ,
runvariance0FUNC ,
boxvariance0FUNC ,
arrvariance1FUNC ,
arrvariances1FUNC ,
runvariance1FUNC ,
boxvariance1FUNC ,
arrstddev0FUNC ,
arrstddevs0FUNC ,
runstddev0FUNC ,
boxstddev0FUNC ,
arrstddev1FUNC ,
arrstddevs1FUNC ,
runstddev1FUNC ,
boxstddev1FUNC ,
arravdevFUNC ,
arravdevsFUNC ,
runavdevFUNC ,
boxavdevFUNC ,
arrrmsFUNC ,
arrrmssFUNC ,
runrmsFUNC ,
boxrmsFUNC ,
arrmedianFUNC ,
arrmediansFUNC ,
runmedianFUNC ,
boxmedianFUNC ,
arrfractileFUNC ,
arrfractilesFUNC ,
runfractileFUNC ,
boxfractileFUNC ,
arranyFUNC ,
arranysFUNC ,
runanyFUNC ,
boxanyFUNC ,
arrallFUNC ,
arrallsFUNC ,
runallFUNC ,
boxallFUNC ,
arrntrueFUNC ,
arrntruesFUNC ,
runntrueFUNC ,
boxntrueFUNC ,
arrnfalseFUNC ,
arrnfalsesFUNC ,
runnfalseFUNC ,
boxnfalseFUNC ,
arrayFUNC ,
transposeFUNC ,
areverseFUNC ,
resizeFUNC ,
diagonalFUNC ,
isnanFUNC ,
isinfFUNC ,
isfiniteFUNC ,
isdefFUNC ,
isnullFUNC ,
iscolFUNC ,
iskeyFUNC ,
ndimFUNC ,
nelemFUNC ,
shapeFUNC ,
strlengthFUNC ,
upcaseFUNC ,
downcaseFUNC ,
capitalizeFUNC ,
sreverseFUNC ,
trimFUNC ,
ltrimFUNC ,
rtrimFUNC ,
substrFUNC ,
replaceFUNC ,
regexFUNC ,
patternFUNC ,
sqlpatternFUNC ,
datetimeFUNC ,
mjdtodateFUNC ,
mjdFUNC ,
dateFUNC ,
timeFUNC ,
yearFUNC ,
monthFUNC ,
dayFUNC ,
cmonthFUNC ,
weekdayFUNC ,
cdowFUNC ,
weekFUNC ,
ctodFUNC ,
cdateFUNC ,
ctimeFUNC ,
stringFUNC ,
hmsFUNC ,
dmsFUNC ,
hdmsFUNC ,
randFUNC ,
rownrFUNC ,
rowidFUNC ,
iifFUNC ,
angdistFUNC ,
angdistxFUNC ,
conesFUNC ,
cones3FUNC ,
anyconeFUNC ,
anycone3FUNC ,
findconeFUNC ,
findcone3FUNC ,
normangleFUNC ,
boolFUNC ,
nullarrayFUNC ,
marrayFUNC ,
arrdataFUNC ,
arrmaskFUNC ,
negatemaskFUNC ,
replmaskedFUNC ,
replunmaskedFUNC ,
arrflatFUNC ,
FirstAggrFunc ,
countallFUNC ,
gcountFUNC ,
gfirstFUNC ,
glastFUNC ,
gminFUNC ,
gmaxFUNC ,
gsumFUNC ,
gproductFUNC ,
gsumsqrFUNC ,
gmeanFUNC ,
gvariance0FUNC ,
gvariance1FUNC ,
gstddev0FUNC ,
gstddev1FUNC ,
grmsFUNC ,
ganyFUNC ,
gallFUNC ,
gntrueFUNC ,
gnfalseFUNC ,
FirstAggrArrayFunc ,
gminsFUNC ,
gmaxsFUNC ,
gsumsFUNC ,
gproductsFUNC ,
gsumsqrsFUNC ,
gmeansFUNC ,
gvariances0FUNC ,
gvariances1FUNC ,
gstddevs0FUNC ,
gstddevs1FUNC ,
grmssFUNC ,
ganysFUNC ,
gallsFUNC ,
gntruesFUNC ,
gnfalsesFUNC ,
LastAggrArrayFunc ,
ghistFUNC ,
gaggrFUNC ,
growidFUNC ,
gmedianFUNC ,
gfractileFUNC ,
gexpridFUNC ,
NRFUNC
}

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...
Protected Member Functions inherited from casacore::TableExprNodeRep
virtual const IPosition & | getShape (const TableExprId &id)
| Get the shape for the given row.
void | fillExprType (const TableExprNodeRep *node)
| Set expression type to Variable if node is Variable.
Static Protected Member Functions inherited from casacore::TableExprNodeRep
static TENShPtr | convertNode (const TENShPtr &thisNode, Bool convertConstType)
| If the node is constant, it is evaluated and replaced by the appropriate TableExprNodeConst object.
Protected Attributes inherited from casacore::TableExprNodeMulti
std::vector< TENShPtr > | operands_p
Protected Attributes inherited from casacore::TableExprNodeRep
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

TaQL node representing a scalar aggregate function

### Intended use:

Internal

### Review Status

Test programs:
  tTableGram

### Synopsis

A TableExprAggrNode object is a special TableExprFuncNode object. Instead of operating on a single row, it operates on a group of table rows, usually formed by means of the GROUPBY clause. It aggregates the values in the rows in the group by means of an aggregation function derived from TableExprGroupFuncBase. Several standard aggregation functions (e.g., gmean, gmin, gsum) are defined in TaQL and implemented this way.

There are two types of aggregate function implementations:

- Immediate aggregate functions calculate the results while the groups are being formed. In this way they step sequentially through the data. This is only possible for functions that do not have to keep to many data in memory.
- Lazy aggregate functions calculate the results after the groups are formed using the vector of TableExprIds they get per group. In this way only data for a single group might need to be kept in memory. It is used, for instance, to calculate the median.

Note that this class handles operands that are a scalar or array. If array, all values in the array are used as individual values. Class TableExprAggrNodeArray handles aggregate functions giving an array result (e.g., function gaggr).

It is also possible to define an aggregate function in a UDF derived from class UDFBase. Such an aggregate function is instantiated as a TableExprUDFNode(Array) object, not as TabeExprAggrNode(Array). These functions are always lazy.

Definition at line 81 of file ExprAggrNode.h.

## Constructor & Destructor Documentation

## TableExprAggrNode()

casacore::TableExprAggrNode::TableExprAggrNode | ( | FunctionType | ,
|  | NodeDataType | ,
|  | ValueType | ,
|  | const TableExprNodeSet & | source,
|  | const vector< TENShPtr > & | nodes,
|  | const Block< Int > & | dtypeOper )

Constructor.

## Member Function Documentation

## checkOperands()

NodeDataType casacore::TableExprAggrNode::checkOperands | ( | Block< Int > & | dtypeOper,
|  | ValueType & | resVT,
|  | FunctionType | ftype,
|  | std::vector< TENShPtr > & | nodes )

static

Check the operands of the aggregate function and return the result's data type.

## doMakeGroupAggrFunc()

TableExprGroupFuncBase * casacore::TableExprAggrNode::doMakeGroupAggrFunc | ( |  | ) |

private

Do the actual creation of the correct aggregate function object.

## getBool()

virtual Bool casacore::TableExprAggrNode::getBool | ( | const TableExprId & | id | ) |

virtual

Functions to get the result of an aggregate function.

Reimplemented from casacore::TableExprNodeRep.

## getDate()

virtual MVTime casacore::TableExprAggrNode::getDate | ( | const TableExprId & | id | ) |

virtual

Reimplemented from casacore::TableExprNodeRep.

## getDComplex()

virtual DComplex casacore::TableExprAggrNode::getDComplex | ( | const TableExprId & | id | ) |

virtual

Reimplemented from casacore::TableExprNodeRep.

## getDouble()

virtual Double casacore::TableExprAggrNode::getDouble | ( | const TableExprId & | id | ) |

virtual

Reimplemented from casacore::TableExprNodeRep.

## getInt()

virtual Int64 casacore::TableExprAggrNode::getInt | ( | const TableExprId & | id | ) |

virtual

Reimplemented from casacore::TableExprNodeRep.

## getString()

virtual String casacore::TableExprAggrNode::getString | ( | const TableExprId & | id | ) |

virtual

Reimplemented from casacore::TableExprNodeRep.

## isAggregate()

virtual Bool casacore::TableExprAggrNode::isAggregate | ( |  | ) | const

virtual

This node does aggregation.

Reimplemented from casacore::TableExprNodeRep.

## isLazyAggregate()

virtual Bool casacore::TableExprAggrNode::isLazyAggregate | ( |  | ) | const

virtual

Is the aggregate function a lazy or an immediate one?

Reimplemented from casacore::TableExprNodeRep.

## makeGroupAggrFunc()

virtual std::shared_ptr< TableExprGroupFuncBase > casacore::TableExprAggrNode::makeGroupAggrFunc | ( |  | ) |

virtual

Create the correct aggregate function object.

It is also kept in case it is a lazy aggregate function.

Reimplemented from casacore::TableExprNodeRep.

## operand()

TENShPtr casacore::TableExprAggrNode::operand | ( |  | ) |

inline

Get the operand node.

Definition at line 100 of file ExprAggrNode.h.

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

## Member Data Documentation

## itsFunc

std::shared_ptr<TableExprGroupFuncBase> casacore::TableExprAggrNode::itsFunc

private

Definition at line 125 of file ExprAggrNode.h.

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

- tables/TaQL/ExprAggrNode.h