Loading...
Searching...
No Matches
LELFunctionEnums.h
Go to the documentation of this file.
//# LELFunctionEnums.h: Enums of function names
//# Copyright (C) 1997,1998,1999,2001,2003
//# 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 LATTICES_LELFUNCTIONENUMS_H
#define LATTICES_LELFUNCTIONENUMS_H
#include <casacore/casa/aips.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <summary> Each LEL function is described in this enum </summary>
//
// <use visibility=local>
//
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
//
// <prerequisite>
// <li> <linkto class="Lattice"> Lattice</linkto>
// <li> <linkto class="LatticeExpr"> LatticeExpr</linkto>
// <li> <linkto class="LatticeExprNode"> LatticeExprNode</linkto>
// <li> <linkto class="LELInterface"> LELInterface</linkto>
// </prerequisite>
//
// <etymology>
// This enum provides a value for each function accepted
// by the Lattice Expression Language classes.
// </etymology>
//
// <synopsis>
// Each function name accepted by the bridging class LatticeExprNode
// and passed on to the
// <linkto class="LELFunction1D">LELFunction</linkto>
// letter classes is labelled internally
// with a value from this enum.
// </synopsis>
//
// <todo asof="1998/01/21">
// </todo>
class LELFunctionEnums
{
public:
enum Function {
// sin
SIN,
// sinh
SINH,
// asin
ASIN,
// cos
COS,
// cosh
COSH,
// acos
ACOS,
// tan
TAN,
// tanh
TANH,
// atan; atan(x) returns the arc tangent of x in the range -pi/2 to pi/2.
ATAN,
// atan2; atan2(y,x) computes an arc tangent of y/x in the range -pi to pi
ATAN2,
// exp
EXP,
// log
LOG,
// log10
LOG10,
// power pow(x,y) == x**y or x^y
POW,
// sqrt
SQRT,
// round
ROUND,
// sign (-1 if <0; 0 if 0; 1 if >0)
SIGN,
// ceil; returns the least integral value greater than or equal to x.
CEIL,
// floor; returns the greatest integral value less than or equal to x.
FLOOR,
// abs
ABS,
// phase (of complex number)
ARG,
// real (part of number)
REAL,
// imag (inary part of complex number)
IMAG,
// conj (ugate complex number)
CONJ,
// complex (form complex from 2 reals)
COMPLEX,
// fmod; fmod(x,y) returns the remainder of x with respect to y; that is,
// the result r is one of the numbers that differ from x by an integral multiple of y.
FMOD,
// min; min(x,y)
MIN,
// max; max(x,y)
MAX,
// min; min(x) (is a scalar)
MIN1D,
// max; max(x) (is a scalar)
MAX1D,
// mean; mean(x) (is a scalar)
MEAN1D,
// median; median(x) (is a scalar)
MEDIAN1D,
// fractile; fractile(x,fraction) (is a scalar)
FRACTILE1D,
// fractilerange; fractilerange(x,fraction1[,fraction2]) (is a scalar)
FRACTILERANGE1D,
// sum; sum(x) (is a scalar)
SUM,
// nelements; nelements(x) (is a scalar)
NELEM,
// all (true) (is a scalar)
ALL,
// any (true) (is a scalar)
ANY,
// ntrue
NTRUE,
// nfalse
NFALSE,
// mask
MASK,
// value
VALUE,
// iif (similar to ?: in C++)
IIF,
// replace
REPLACE,
// dimensionality
NDIM,
// length (of an axis)
LENGTH,
// is the value a NaN?
ISNAN,
// a bool array telling which indices of an axis are to be used
INDEXIN,
// number of functions
NFUNCTIONS
};
};
} //# NAMESPACE CASACORE - END
#endif
casacore::LELFunctionEnums
Definition LELFunctionEnums.h:64
casacore::LELFunctionEnums::Function
Function
Definition LELFunctionEnums.h:66
casacore::LELFunctionEnums::COSH
@ COSH
cosh
Definition LELFunctionEnums.h:81
casacore::LELFunctionEnums::SIGN
@ SIGN
sign (-1 if <0; 0 if 0; 1 if >0)
Definition LELFunctionEnums.h:117
casacore::LELFunctionEnums::TAN
@ TAN
tan
Definition LELFunctionEnums.h:87
casacore::LELFunctionEnums::SUM
@ SUM
sum; sum(x) (is a scalar)
Definition LELFunctionEnums.h:172
casacore::LELFunctionEnums::REAL
@ REAL
real (part of number)
Definition LELFunctionEnums.h:132
casacore::LELFunctionEnums::COMPLEX
@ COMPLEX
complex (form complex from 2 reals)
Definition LELFunctionEnums.h:141
casacore::LELFunctionEnums::ACOS
@ ACOS
acos
Definition LELFunctionEnums.h:84
casacore::LELFunctionEnums::TANH
@ TANH
tanh
Definition LELFunctionEnums.h:90
casacore::LELFunctionEnums::MEAN1D
@ MEAN1D
mean; mean(x) (is a scalar)
Definition LELFunctionEnums.h:160
casacore::LELFunctionEnums::IIF
@ IIF
iif (similar to ?
Definition LELFunctionEnums.h:196
casacore::LELFunctionEnums::SIN
@ SIN
sin
Definition LELFunctionEnums.h:69
casacore::LELFunctionEnums::FMOD
@ FMOD
fmod; fmod(x,y) returns the remainder of x with respect to y; that is, the result r is one of the num...
Definition LELFunctionEnums.h:145
casacore::LELFunctionEnums::IMAG
@ IMAG
imag (inary part of complex number)
Definition LELFunctionEnums.h:135
casacore::LELFunctionEnums::EXP
@ EXP
exp
Definition LELFunctionEnums.h:99
casacore::LELFunctionEnums::ATAN2
@ ATAN2
atan2; atan2(y,x) computes an arc tangent of y/x in the range -pi to pi
Definition LELFunctionEnums.h:96
casacore::LELFunctionEnums::MEDIAN1D
@ MEDIAN1D
median; median(x) (is a scalar)
Definition LELFunctionEnums.h:163
casacore::LELFunctionEnums::REPLACE
@ REPLACE
replace
Definition LELFunctionEnums.h:199
casacore::LELFunctionEnums::ARG
@ ARG
phase (of complex number)
Definition LELFunctionEnums.h:129
casacore::LELFunctionEnums::ISNAN
@ ISNAN
is the value a NaN?
Definition LELFunctionEnums.h:208
casacore::LELFunctionEnums::VALUE
@ VALUE
value
Definition LELFunctionEnums.h:193
casacore::LELFunctionEnums::NFALSE
@ NFALSE
nfalse
Definition LELFunctionEnums.h:187
casacore::LELFunctionEnums::NDIM
@ NDIM
dimensionality
Definition LELFunctionEnums.h:202
casacore::LELFunctionEnums::ASIN
@ ASIN
asin
Definition LELFunctionEnums.h:75
casacore::LELFunctionEnums::MIN
@ MIN
min; min(x,y)
Definition LELFunctionEnums.h:148
casacore::LELFunctionEnums::ALL
@ ALL
all (true) (is a scalar)
Definition LELFunctionEnums.h:178
casacore::LELFunctionEnums::ABS
@ ABS
abs
Definition LELFunctionEnums.h:126
casacore::LELFunctionEnums::INDEXIN
@ INDEXIN
a bool array telling which indices of an axis are to be used
Definition LELFunctionEnums.h:211
casacore::LELFunctionEnums::MAX
@ MAX
max; max(x,y)
Definition LELFunctionEnums.h:151
casacore::LELFunctionEnums::LOG
@ LOG
log
Definition LELFunctionEnums.h:102
casacore::LELFunctionEnums::COS
@ COS
cos
Definition LELFunctionEnums.h:78
casacore::LELFunctionEnums::NTRUE
@ NTRUE
ntrue
Definition LELFunctionEnums.h:184
casacore::LELFunctionEnums::FLOOR
@ FLOOR
floor; returns the greatest integral value less than or equal to x.
Definition LELFunctionEnums.h:123
casacore::LELFunctionEnums::LOG10
@ LOG10
log10
Definition LELFunctionEnums.h:105
casacore::LELFunctionEnums::NFUNCTIONS
@ NFUNCTIONS
number of functions
Definition LELFunctionEnums.h:214
casacore::LELFunctionEnums::FRACTILERANGE1D
@ FRACTILERANGE1D
fractilerange; fractilerange(x,fraction1[,fraction2]) (is a scalar)
Definition LELFunctionEnums.h:169
casacore::LELFunctionEnums::CEIL
@ CEIL
ceil; returns the least integral value greater than or equal to x.
Definition LELFunctionEnums.h:120
casacore::LELFunctionEnums::ROUND
@ ROUND
round
Definition LELFunctionEnums.h:114
casacore::LELFunctionEnums::POW
@ POW
power pow(x,y) == x**y or x^y
Definition LELFunctionEnums.h:108
casacore::LELFunctionEnums::ATAN
@ ATAN
atan; atan(x) returns the arc tangent of x in the range -pi/2 to pi/2.
Definition LELFunctionEnums.h:93
casacore::LELFunctionEnums::NELEM
@ NELEM
nelements; nelements(x) (is a scalar)
Definition LELFunctionEnums.h:175
casacore::LELFunctionEnums::FRACTILE1D
@ FRACTILE1D
fractile; fractile(x,fraction) (is a scalar)
Definition LELFunctionEnums.h:166
casacore::LELFunctionEnums::MIN1D
@ MIN1D
min; min(x) (is a scalar)
Definition LELFunctionEnums.h:154
casacore::LELFunctionEnums::LENGTH
@ LENGTH
length (of an axis)
Definition LELFunctionEnums.h:205
casacore::LELFunctionEnums::ANY
@ ANY
any (true) (is a scalar)
Definition LELFunctionEnums.h:181
casacore::LELFunctionEnums::MASK
@ MASK
mask
Definition LELFunctionEnums.h:190
casacore::LELFunctionEnums::SINH
@ SINH
sinh
Definition LELFunctionEnums.h:72
casacore::LELFunctionEnums::MAX1D
@ MAX1D
max; max(x) (is a scalar)
Definition LELFunctionEnums.h:157
casacore::LELFunctionEnums::CONJ
@ CONJ
conj (ugate complex number)
Definition LELFunctionEnums.h:138
casacore::LELFunctionEnums::SQRT
@ SQRT
sqrt
Definition LELFunctionEnums.h:111
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28