TaQL node representing an array aggregate function. More...

#include <ExprAggrNodeArray.h>

Inheritance diagram for casacore::TableExprAggrNodeArray:

Public Member Functions
	TableExprAggrNodeArray (TableExprFuncNode::FunctionType, NodeDataType, ValueType, const TableExprNodeSet &source, const vector< TENShPtr > &nodes, const Block< Int > &dtypeOper, const TaQLStyle &style)
	Constructor. More...

virtual void	getAggrNodes (std::vector< TableExprNodeRep * > &aggr)
	Get the nodes representing an aggregate function. More...

TENShPtr	operand ()
	Get the operand node. More...

virtual CountedPtr < TableExprGroupFuncBase >	makeGroupAggrFunc ()
	Create the correct aggregate function object. More...

virtual Bool	isLazyAggregate () const
	Is the array aggregate function lazy? More...

virtual MArray< Bool >	getArrayBool (const TableExprId &id)
	Functions to get the result of an aggregate function. More...

virtual MArray< Int64 >	getArrayInt (const TableExprId &id)

virtual MArray< Double >	getArrayDouble (const TableExprId &id)
	The default implementation of getArrayDouble does getArrayInt and converts the result. More...

virtual MArray< DComplex >	getArrayDComplex (const TableExprId &id)
	The default implementation of getArrayDComplex does getArrayDouble and converts the result. More...

virtual MArray< String >	getArrayString (const TableExprId &id)

virtual MArray< MVTime >	getArrayDate (const TableExprId &id)

Public Member Functions inherited from casacore::TableExprFuncNodeArray
	TableExprFuncNodeArray (TableExprFuncNode::FunctionType, NodeDataType, ValueType, const TableExprNodeSet &source, const vector< TENShPtr > &nodes, const Block< Int > &dtypeOper, const TaQLStyle &)
	Constructor. More...

	~TableExprFuncNodeArray ()
	Destructor. More...

virtual void	getColumnNodes (std::vector< TableExprNodeRep * > &cols)
	Get the nodes representing a table column. More...

TableExprFuncNode *	getChild ()
	Get the function node. More...

const TableExprFuncNode *	getChild () const

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 TENShPtr	makeConstantScalar ()
	Turn a constant array with one element into a scalar. More...

IPosition	validateIndex (const IPosition &index, const ArrayBase &arr) const
	Validate the given index against the array's shape. More...

virtual const IPosition &	getShape (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 MArray< Bool >	hasArrayBool (const TableExprId &id, const MArray< Bool > &value)

virtual MArray< Bool >	hasArrayInt (const TableExprId &id, const MArray< Int64 > &value)

virtual MArray< Bool >	hasArrayDouble (const TableExprId &id, const MArray< Double > &value)

virtual MArray< Bool >	hasArrayDComplex (const TableExprId &id, const MArray< DComplex > &value)

virtual MArray< Bool >	hasArrayString (const TableExprId &id, const MArray< String > &value)

virtual MArray< Bool >	hasArrayDate (const TableExprId &id, const MArray< 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 MArray< Bool >	getSliceBool (const TableExprId &id, const Slicer &)
	Get a slice of the array in the given row. More...

virtual MArray< Int64 >	getSliceInt (const TableExprId &id, const Slicer &)

virtual MArray< Double >	getSliceDouble (const TableExprId &id, const Slicer &)

virtual MArray< DComplex >	getSliceDComplex (const TableExprId &id, const Slicer &)

virtual MArray< String >	getSliceString (const TableExprId &id, const Slicer &)

virtual MArray< MVTime >	getSliceDate (const TableExprId &id, const Slicer &)

virtual Array< Bool >	getElemColumnBool (const Vector< uInt > &rownrs, const Slicer &)
	Get a single element for the entire column (used by sort). More...

virtual Array< uChar >	getElemColumnuChar (const Vector< uInt > &rownrs, const Slicer &)

virtual Array< Short >	getElemColumnShort (const Vector< uInt > &rownrs, const Slicer &)

virtual Array< uShort >	getElemColumnuShort (const Vector< uInt > &rownrs, const Slicer &)

virtual Array< Int >	getElemColumnInt (const Vector< uInt > &rownrs, const Slicer &)

virtual Array< uInt >	getElemColumnuInt (const Vector< uInt > &rownrs, const Slicer &)

virtual Array< Int64 >	getElemColumnInt64 (const Vector< uInt > &rownrs, const Slicer &)

virtual Array< Float >	getElemColumnFloat (const Vector< uInt > &rownrs, const Slicer &)

virtual Array< Double >	getElemColumnDouble (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< String >	getElemColumnString (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...

void	setChildren (const TENShPtr &left, const TENShPtr &right, Bool adapt=True)
	Set the children. More...

virtual void	handleUnits ()
	Handle the units of the children and possibly set the parent's unit. More...

void	adaptDataTypes ()
	If one of the children is a constant, convert its data type to that of the other operand. More...

const TENShPtr &	getLeftChild () const
	Get the child nodes. More...

const TENShPtr &	getRightChild () 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...

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 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, 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. More...

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)

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< Bool >	getColumnBool (const Vector< uInt > &rownrs)
	Get the value of the expression evaluated for the entire column. More...

virtual Array< uChar >	getColumnuChar (const Vector< uInt > &rownrs)

virtual Array< Short >	getColumnShort (const Vector< uInt > &rownrs)

virtual Array< uShort >	getColumnuShort (const Vector< uInt > &rownrs)

virtual Array< Int >	getColumnInt (const Vector< uInt > &rownrs)

virtual Array< uInt >	getColumnuInt (const Vector< uInt > &rownrs)

virtual Array< Int64 >	getColumnInt64 (const Vector< uInt > &rownrs)

virtual Array< Float >	getColumnFloat (const Vector< uInt > &rownrs)

virtual Array< Double >	getColumnDouble (const Vector< uInt > &rownrs)

virtual Array< Complex >	getColumnComplex (const Vector< uInt > &rownrs)

virtual Array< DComplex >	getColumnDComplex (const Vector< uInt > &rownrs)

virtual Array< String >	getColumnString (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 Unit &	unit () const
	Get the unit. More...

void	setUnit (const Unit &unit)
	Set the unit. More...

const Record &	attributes () 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 IPosition &	shape () const
	Get the fixed shape (same for all rows). More...

const IPosition &	shape (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...

Table &	table ()
	Get table. More...

const Table &	table () const

virtual void	adaptSetUnits (const Unit &)
	Let a set node convert itself to the given unit. More...

Private Member Functions
CountedPtr < TableExprGroupFuncBase >	doMakeGroupAggrFunc ()
	Create the correct aggregate function object. More...

Private Attributes
CountedPtr < TableExprGroupFuncBase >	itsFunc

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::TableExprNodeArray
static MArray< Int64 >	makeArray (const IPosition &shape, Int64 value)
	Make an array with the given shape and fill it with the value. More...

static MArray< Double >	makeArray (const IPosition &shape, Double value)

static MArray< 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	getCommonTypes (const TENShPtr &left, const TENShPtr &right, OperType operType)
	Check the data and value types and get the common one. 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::TableExprFuncNodeArray
void	tryToConst ()
	Try if the function gives a constant result. More...

const std::vector< TENShPtr > &	operands () const
	Some functions to be used by TableExprNodeFuncArray. More...

std::vector< TENShPtr > &	rwOperands ()

TableExprFuncNode::FunctionType	funcType () const

NodeDataType	argDataType () const

Protected Member Functions inherited from casacore::TableExprNodeRep
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::TableExprNodeBinary
static const Unit &	makeEqualUnits (const TENShPtr &left, TENShPtr &right)
	Make the units equal. 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::TableExprNodeArray
IPosition	varShape_p

Protected Attributes inherited from casacore::TableExprNodeBinary
TENShPtr	lnode_p

TENShPtr	rnode_p

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

TaQL node representing an array aggregate function.

Intended use:

Internal

Review Status

Test programs:: tTaQLNode

Synopsis

This class is similar to TableExprAggrNode, but its result is an array instead of a scalar value. There are few aggregate functions resulting in an array. An example is gaggr, which aggregates the non-empty arrays in a group into a single array. Other functions (like medians, runningmean, etc.) can be applied to its result making it quite versatile.

Most array aggregate functions are lazy to avoid using too much memory.

Definition at line 62 of file ExprAggrNodeArray.h.

Constructor & Destructor Documentation

casacore::TableExprAggrNodeArray::TableExprAggrNodeArray	(	TableExprFuncNode::FunctionType	,
		NodeDataType	,
		ValueType	,
		const TableExprNodeSet &	source,
		const vector< TENShPtr > &	nodes,
		const Block< Int > &	dtypeOper,
		const TaQLStyle &	style
	)

Constructor.

Member Function Documentation

CountedPtr<TableExprGroupFuncBase> casacore::TableExprAggrNodeArray::doMakeGroupAggrFunc ( )

private

Create the correct aggregate function object.

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

virtual

Get the nodes representing an aggregate function.

Reimplemented from casacore::TableExprFuncNodeArray.

virtual MArray<Bool> casacore::TableExprAggrNodeArray::getArrayBool ( const TableExprId & id )

virtual

Functions to get the result of an aggregate function.

Reimplemented from casacore::TableExprFuncNodeArray.

virtual MArray<MVTime> casacore::TableExprAggrNodeArray::getArrayDate ( const TableExprId & id )

virtual

Reimplemented from casacore::TableExprFuncNodeArray.

virtual MArray<DComplex> casacore::TableExprAggrNodeArray::getArrayDComplex ( const TableExprId & id )

virtual

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

Reimplemented from casacore::TableExprFuncNodeArray.

virtual MArray<Double> casacore::TableExprAggrNodeArray::getArrayDouble ( const TableExprId & id )

virtual

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

Reimplemented from casacore::TableExprFuncNodeArray.

virtual MArray<Int64> casacore::TableExprAggrNodeArray::getArrayInt ( const TableExprId & id )

virtual

Reimplemented from casacore::TableExprFuncNodeArray.

virtual MArray<String> casacore::TableExprAggrNodeArray::getArrayString ( const TableExprId & id )

virtual

Reimplemented from casacore::TableExprFuncNodeArray.

virtual Bool casacore::TableExprAggrNodeArray::isLazyAggregate ( ) const

virtual

Is the array aggregate function lazy?

Reimplemented from casacore::TableExprNodeRep.

virtual CountedPtr<TableExprGroupFuncBase> casacore::TableExprAggrNodeArray::makeGroupAggrFunc ( )

virtual

Create the correct aggregate function object.

Reimplemented from casacore::TableExprNodeRep.

TENShPtr casacore::TableExprAggrNodeArray::operand ( )

inline

Get the operand node.

Definition at line 77 of file ExprAggrNodeArray.h.

References casa::vi::empty(), and casacore::TableExprFuncNodeArray::operands().

Member Data Documentation

CountedPtr<TableExprGroupFuncBase> casacore::TableExprAggrNodeArray::itsFunc

private

Definition at line 101 of file ExprAggrNodeArray.h.

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

casa/casacore/tables/TaQL/ExprAggrNodeArray.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Intended use:

Review Status

Synopsis

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation