Loading...
Searching...
No Matches
ExprAggrNodeArray.h
Go to the documentation of this file.
//# ExprAggrNodeArray.h: TaQL node representing an array aggregate function
//# Copyright (C) 2013
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef TABLES_EXPRAGGRNODEARRAY_H
#define TABLES_EXPRAGGRNODEARRAY_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/tables/TaQL/ExprFuncNodeArray.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations.
class TableExprGroupFuncBase;
class TableExprGroupFuncSet;
// <summary>
// TaQL node representing an array aggregate function
// </summary>
// <use visibility=local>
// <reviewed reviewer="" date="" tests="tTaQLNode">
// </reviewed>
// <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 <src>gaggr</src>, 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.
// </synopsis>
class TableExprAggrNodeArray: public TableExprFuncNodeArray
{
public:
// Constructor.
TableExprAggrNodeArray (TableExprFuncNode::FunctionType,
NodeDataType, ValueType,
const TableExprNodeSet& source,
const vector<TENShPtr>& nodes,
const Block<Int>& dtypeOper,
const TaQLStyle& style);
// This node does aggregation.
virtual Bool isAggregate() const;
// Get the operand node.
TENShPtr operand()
{ return (operands().empty() ? TENShPtr() : operands()[0]); }
// Create the correct aggregate function object.
virtual std::shared_ptr<TableExprGroupFuncBase> makeGroupAggrFunc();
// Is the array aggregate function lazy?
virtual Bool isLazyAggregate() const;
// Functions to get the result of an aggregate function.
// <group>
virtual MArray<Bool> getArrayBool (const TableExprId& id);
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);
// </group>
private:
// Create the correct aggregate function object.
std::shared_ptr<TableExprGroupFuncBase> doMakeGroupAggrFunc();
//# Data members.
std::shared_ptr<TableExprGroupFuncBase> itsFunc;
};
} //# NAMESPACE CASACORE - END
#endif
casacore::Block
Definition Block.h:140
casacore::MArray
Definition MArray.h:68
casacore::TaQLStyle
Definition TaQLStyle.h:63
casacore::TableExprAggrNodeArray::getArrayDate
virtual MArray< MVTime > getArrayDate(const TableExprId &id)
casacore::TableExprAggrNodeArray::isLazyAggregate
virtual Bool isLazyAggregate() const
Is the array aggregate function lazy?
casacore::TableExprAggrNodeArray::doMakeGroupAggrFunc
std::shared_ptr< TableExprGroupFuncBase > doMakeGroupAggrFunc()
Create the correct aggregate function object.
casacore::TableExprAggrNodeArray::getArrayString
virtual MArray< String > getArrayString(const TableExprId &id)
casacore::TableExprAggrNodeArray::itsFunc
std::shared_ptr< TableExprGroupFuncBase > itsFunc
Definition ExprAggrNodeArray.h:99
casacore::TableExprAggrNodeArray::getArrayDouble
virtual MArray< Double > getArrayDouble(const TableExprId &id)
casacore::TableExprAggrNodeArray::isAggregate
virtual Bool isAggregate() const
This node does aggregation.
casacore::TableExprAggrNodeArray::operand
TENShPtr operand()
Get the operand node.
Definition ExprAggrNodeArray.h:75
casacore::TableExprAggrNodeArray::getArrayDComplex
virtual MArray< DComplex > getArrayDComplex(const TableExprId &id)
casacore::TableExprAggrNodeArray::getArrayBool
virtual MArray< Bool > getArrayBool(const TableExprId &id)
Functions to get the result of an aggregate function.
casacore::TableExprAggrNodeArray::makeGroupAggrFunc
virtual std::shared_ptr< TableExprGroupFuncBase > makeGroupAggrFunc()
Create the correct aggregate function object.
casacore::TableExprAggrNodeArray::getArrayInt
virtual MArray< Int64 > getArrayInt(const TableExprId &id)
casacore::TableExprAggrNodeArray::TableExprAggrNodeArray
TableExprAggrNodeArray(TableExprFuncNode::FunctionType, NodeDataType, ValueType, const TableExprNodeSet &source, const vector< TENShPtr > &nodes, const Block< Int > &dtypeOper, const TaQLStyle &style)
Constructor.
casacore::TableExprFuncNodeArray::TableExprFuncNodeArray
TableExprFuncNodeArray(TableExprFuncNode::FunctionType, NodeDataType, ValueType, const TableExprNodeSet &source, const vector< TENShPtr > &nodes, const Block< Int > &dtypeOper, const TaQLStyle &)
Constructor.
casacore::TableExprFuncNodeArray::operands
const std::vector< TENShPtr > & operands() const
Some functions to be used by TableExprNodeFuncArray.
Definition ExprFuncNodeArray.h:109
casacore::TableExprFuncNode::FunctionType
FunctionType
Definition ExprFuncNode.h:79
casacore::TableExprGroupFuncBase
Abstract base class for classes calculating an aggregated group result.
Definition ExprGroup.h:200
casacore::TableExprGroupFuncSet
Class containing the results of aggregated values in a group.
Definition ExprGroup.h:799
casacore::TableExprId
Definition TableExprId.h:95
casacore::TableExprNodeRep::NodeDataType
NodeDataType
Define the data types of a node.
Definition ExprNodeRep.h:205
casacore::TableExprNodeRep::ValueType
ValueType
Define the value types.
Definition ExprNodeRep.h:220
casacore::TableExprNodeSet
Definition ExprNodeSet.h:87
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::empty
Bool empty() const
Is the block empty (i.e.
Definition Block.h:565
casacore::TENShPtr
std::shared_ptr< TableExprNodeRep > TENShPtr
Definition ExprNodeRep.h:55
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40