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

Class defining a set element containing a discrete range. More...

`#include <ExprNodeSetElem.h>`

## Public Member Functions

| TableExprNodeSetElemDiscrete (const TableExprNode &start, const TableExprNode &end, const TableExprNode &incr, Bool isEndExcl=False)
| Create the object for a discrete range.
| ~TableExprNodeSetElemDiscrete () override=default
Bool | isDiscrete () const override
| It is a discrete set element.
void | fillVector (Vector< Int64 > &vec, Int64 &cnt, const TableExprId &id) const override
| 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.
void | fillVector (Vector< Double > &vec, Int64 &cnt, const TableExprId &id) const override
void | fillVector (Vector< MVTime > &vec, Int64 &cnt, const TableExprId &id) const override
void | matchInt (Bool *match, const Int64 *value, size_t nval, const TableExprId &id) const override
| Set a flag in the match output array if the corresponding element in the value array is included in this set element.
void | matchDouble (Bool *match, const Double *value, size_t nval, const TableExprId &id) const override
void | matchDate (Bool *match, const MVTime *value, size_t nval, const TableExprId &id) const override
TENSEBShPtr | evaluate (const TableExprId &id) const override
| Evaluate the element for the given row and construct a new (constant) element from it.
Public Member Functions inherited from casacore::TableExprNodeSetElemBase
| TableExprNodeSetElemBase (NodeDataType=NTDouble)
| Constructor to initialize the parent.
virtual | ~TableExprNodeSetElemBase ()=default
TableExprNodeSetElemBase & | operator= (const TableExprNodeSetElemBase &)=delete
| A copy of a TableExprNodeSetElem cannot be made.
void | show (ostream &os, uInt indent) const override
| Show the node.
virtual void | flattenTree (std::vector< TableExprNodeRep * > &) override
| Flatten the node tree by adding the node and its children to the vector.
virtual Bool | isSingle () const
| Is a single value given?
virtual Bool | isLeftClosed () const
| Is the interval left or right closed?
virtual Bool | isRightClosed () const
virtual Bool | isMidWidth () const
| Is the interval given as mid-width?
const TENShPtr & | start () const
| Get the start, end or increment expression.
const TENShPtr & | end () const
const TENShPtr & | increment () const
virtual void | matchBool (Bool *match, const Bool *value, size_t 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.
virtual void | matchDComplex (Bool *match, const DComplex *value, size_t nval, const TableExprId &id) const
virtual void | matchString (Bool *match, const String *value, size_t nval, const TableExprId &id) const
void | setExprType ()
| Set the expression type (Variable or Constant) depending on the children.
void | adaptSetUnits (const Unit &) override
| Let a set node convert itself to the given unit.
void | getStart (const TableExprId &id, Double &) const
| Get the start or end value of a Double or DateTime interval.
void | getEnd (const TableExprId &id, Double &) const
void | getStart (const TableExprId &id, String &) const
| Get the start or end value of a String interval.
void | getEnd (const TableExprId &id, String &) const
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 Bool | isAggregate () const
| Is the node an aggegation node.
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 std::shared_ptr< TableExprGroupFuncBase > | makeGroupAggrFunc ()
| Create the correct immediate aggregate function object.
virtual Bool | isLazyAggregate () const
| Is the aggregate function a lazy or an immediate one?
virtual Bool | getBool (const TableExprId &id)
| Get a scalar value for this node in the given row.
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< 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?

## Private Member Functions

| TableExprNodeSetElemDiscrete (const TableExprNodeSetElemDiscrete &that, const TENShPtr &start, const TENShPtr &end, const TENShPtr &incr)
| Construct an element from the given parts and take over their pointers.
virtual void | fillVector (Vector< Bool > &vec, Int64 &cnt, const TableExprId &id) const
| Explicitly hide base function to prevent warning.
virtual void | fillVector (Vector< DComplex > &vec, Int64 &cnt, const TableExprId &id) const
| Explicitly hide base function to prevent warning.
virtual void | fillVector (Vector< String > &vec, Int64 &cnt, const TableExprId &id) const
| Explicitly hide base function to prevent warning.

## Private Attributes

Bool | itsEndExcl

## 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.
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.
Protected Member Functions inherited from casacore::TableExprNodeSetElemBase
TENShPtr | evalExpr (const TENShPtr &expr, const TableExprId &id) const
| Evaluate the expression for the given row id.
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::TableExprNodeSetElemBase
TENShPtr | itsStart
TENShPtr | itsEnd
TENShPtr | itsIncr
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

Class defining a set element containing a discrete range.

### Intended use:

Public interface

### Review Status

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

### Prerequisite

- TableExprNodeSet
- TableExprNodeRep

### Synopsis

Class defining a set element containing a discrete range (start:end:incr) which can be of data type Int, Double and Datetime. They have to be scalars. A range consists of a start, end and increment value, each of them optional. Increment defaults to 1. The end value can be inclusive or exclusive (as in Python). It can be used for 2 purposes:
- A slice in an array indexing operation which requires data type Int. In that case start default to the beginning of the dimension and end defaults to the end.
- A discrete range in a set. Start has to be given. If end is not given, the result is an unbounded discrete range.
For a discrete range, the type of start and end can also be a datetime scalar.
A bounded discrete range is automatically converted to a vector, which makes it possible to apply array functions to it (e.g., date() + [0:31]).

Definition at line 318 of file ExprNodeSetElem.h.

## Constructor & Destructor Documentation

## TableExprNodeSetElemDiscrete() [1/2]

casacore::TableExprNodeSetElemDiscrete::TableExprNodeSetElemDiscrete | ( | const TableExprNode & | start,
|  | const TableExprNode & | end,
|  | const TableExprNode & | incr,
|  | Bool | isEndExcl = False )

Create the object for a discrete range.

Each of the start, end, and incr pointers can be null 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).

References casacore::TableExprNodeSetElemBase::end(), casacore::False, and casacore::TableExprNodeSetElemBase::start().

Referenced by TableExprNodeSetElemDiscrete().

## ~TableExprNodeSetElemDiscrete()

casacore::TableExprNodeSetElemDiscrete::~TableExprNodeSetElemDiscrete | ( |  | ) |

override default

## TableExprNodeSetElemDiscrete() [2/2]

casacore::TableExprNodeSetElemDiscrete::TableExprNodeSetElemDiscrete | ( | const TableExprNodeSetElemDiscrete & | 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.

References casacore::TableExprNodeSetElemBase::end(), casacore::TableExprNodeSetElemBase::start(), and TableExprNodeSetElemDiscrete().

## Member Function Documentation

## evaluate()

TENSEBShPtr casacore::TableExprNodeSetElemDiscrete::evaluate | ( | const TableExprId & | id | ) | const

override virtual

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.

Implements casacore::TableExprNodeSetElemBase.

## fillVector() [1/6]

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

private virtual

Explicitly hide base function to prevent warning.

Reimplemented from casacore::TableExprNodeSetElemBase.

## fillVector() [2/6]

virtual void casacore::TableExprNodeSetElemBase::fillVector | ( | Vector< DComplex > & | vec,
|  | Int64 & | cnt,
|  | const TableExprId & | id ) const

private virtual

Explicitly hide base function to prevent warning.

Reimplemented from casacore::TableExprNodeSetElemBase.

## fillVector() [3/6]

void casacore::TableExprNodeSetElemDiscrete::fillVector | ( | Vector< Double > & | vec,
|  | Int64 & | cnt,
|  | const TableExprId & | id ) const

override virtual

Reimplemented from casacore::TableExprNodeSetElemBase.

## fillVector() [4/6]

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

override virtual

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.

Reimplemented from casacore::TableExprNodeSetElemBase.

## fillVector() [5/6]

void casacore::TableExprNodeSetElemDiscrete::fillVector | ( | Vector< MVTime > & | vec,
|  | Int64 & | cnt,
|  | const TableExprId & | id ) const

override virtual

Reimplemented from casacore::TableExprNodeSetElemBase.

## fillVector() [6/6]

virtual void casacore::TableExprNodeSetElemBase::fillVector | ( | Vector< String > & | vec,
|  | Int64 & | cnt,
|  | const TableExprId & | id ) const

private virtual

Explicitly hide base function to prevent warning.

Reimplemented from casacore::TableExprNodeSetElemBase.

## isDiscrete()

Bool casacore::TableExprNodeSetElemDiscrete::isDiscrete | ( |  | ) | const

override virtual

It is a discrete set element.

Reimplemented from casacore::TableExprNodeSetElemBase.

## matchDate()

void casacore::TableExprNodeSetElemDiscrete::matchDate | ( | Bool * | match,
|  | const MVTime * | value,
|  | size_t | nval,
|  | const TableExprId & | id ) const

override virtual

Reimplemented from casacore::TableExprNodeSetElemBase.

References casacore::NewDelAllocator< T >::value.

## matchDouble()

void casacore::TableExprNodeSetElemDiscrete::matchDouble | ( | Bool * | match,
|  | const Double * | value,
|  | size_t | nval,
|  | const TableExprId & | id ) const

override virtual

Reimplemented from casacore::TableExprNodeSetElemBase.

References casacore::NewDelAllocator< T >::value.

## matchInt()

void casacore::TableExprNodeSetElemDiscrete::matchInt | ( | Bool * | match,
|  | const Int64 * | value,
|  | size_t | nval,
|  | const TableExprId & | id ) const

override virtual

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.

Reimplemented from casacore::TableExprNodeSetElemBase.

References casacore::NewDelAllocator< T >::value.

## Member Data Documentation

## itsEndExcl

Bool casacore::TableExprNodeSetElemDiscrete::itsEndExcl

private

Definition at line 376 of file ExprNodeSetElem.h.

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

- tables/TaQL/ExprNodeSetElem.h