casacore
LELFunctionEnums.h
Go to the documentation of this file.
1//# LELFunctionEnums.h: Enums of function names
2//# Copyright (C) 1997,1998,1999,2001,2003
3//# Associated Universities, Inc. Washington DC, USA.
4//#
5//# This library is free software; you can redistribute it and/or modify it
6//# under the terms of the GNU Library General Public License as published by
7//# the Free Software Foundation; either version 2 of the License, or (at your
8//# option) any later version.
9//#
10//# This library is distributed in the hope that it will be useful, but WITHOUT//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12//# License for more details.
13//#
14//# You should have received a copy of the GNU Library General Public License
15//# along with this library; if not, write to the Free Software Foundation,
16//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
17//#
18//# Correspondence concerning AIPS++ should be addressed as follows:
19//# Internet email: aips2-request@nrao.edu.
20//# Postal address: AIPS++ Project Office
21//# National Radio Astronomy Observatory
22//# 520 Edgemont Road
23//# Charlottesville, VA 22903-2475 USA
24//#
25//# $Id$
26
27#ifndef LATTICES_LELFUNCTIONENUMS_H
28#define LATTICES_LELFUNCTIONENUMS_H
29
30#include <casacore/casa/aips.h>
31
32namespace casacore { //# NAMESPACE CASACORE - BEGIN
33
34// <summary> Each LEL function is described in this enum </summary>
35//
36// <use visibility=local>
37//
38// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
39// </reviewed>
40//
41// <prerequisite>
42// <li> <linkto class="Lattice"> Lattice</linkto>
43// <li> <linkto class="LatticeExpr"> LatticeExpr</linkto>
44// <li> <linkto class="LatticeExprNode"> LatticeExprNode</linkto>
45// <li> <linkto class="LELInterface"> LELInterface</linkto>
46// </prerequisite>
47//
48// <etymology>
49// This enum provides a value for each function accepted
50// by the Lattice Expression Language classes.
51// </etymology>
52//
53// <synopsis>
54// Each function name accepted by the bridging class LatticeExprNode
55// and passed on to the
56// <linkto class="LELFunction1D">LELFunction</linkto>
57// letter classes is labelled internally
58// with a value from this enum.
59// </synopsis>
60//
61// <todo asof="1998/01/21">
62// </todo>
63
64
66{
67public:
68 enum Function {
69
70// sin
72
73// sinh
75
76// asin
78
79// cos
81
82// cosh
84
85// acos
87
88// tan
90
91// tanh
93
94// atan; atan(x) returns the arc tangent of x in the range -pi/2 to pi/2.
96
97// atan2; atan2(y,x) computes an arc tangent of y/x in the range -pi to pi
99
100// exp
102
103// log
105
106// log10
108
109// power pow(x,y) == x**y or x^y
111
112// sqrt
114
115// round
117
118// sign (-1 if <0; 0 if 0; 1 if >0)
120
121// ceil; returns the least integral value greater than or equal to x.
123
124// floor; returns the greatest integral value less than or equal to x.
126
127// abs
129
130// phase (of complex number)
132
133// real (part of number)
135
136// imag (inary part of complex number)
138
139// conj (ugate complex number)
141
142// complex (form complex from 2 reals)
144
145// fmod; fmod(x,y) returns the remainder of x with respect to y; that is,
146// the result r is one of the numbers that differ from x by an integral multiple of y.
148
149// min; min(x,y)
151
152// max; max(x,y)
154
155// min; min(x) (is a scalar)
157
158// max; max(x) (is a scalar)
160
161// mean; mean(x) (is a scalar)
163
164// median; median(x) (is a scalar)
166
167// fractile; fractile(x,fraction) (is a scalar)
169
170// fractilerange; fractilerange(x,fraction1[,fraction2]) (is a scalar)
172
173// sum; sum(x) (is a scalar)
175
176// nelements; nelements(x) (is a scalar)
178
179// all (true) (is a scalar)
181
182// any (true) (is a scalar)
184
185// ntrue
187
188// nfalse
190
191// mask
193
194// value
196
197// iif (similar to ?: in C++)
199
200// replace
202
203// dimensionality
205
206// length (of an axis)
208
209// is the value a NaN?
211
212// a bool array telling which indices of an axis are to be used
214
215// number of functions
217
219
220};
221
222
223} //# NAMESPACE CASACORE - END
224
225#endif
@ SIGN
sign (-1 if <0; 0 if 0; 1 if >0)
@ SUM
sum; sum(x) (is a scalar)
@ REAL
real (part of number)
@ COMPLEX
complex (form complex from 2 reals)
@ MEAN1D
mean; mean(x) (is a scalar)
@ IIF
iif (similar to ?: in C++)
@ FMOD
fmod; fmod(x,y) returns the remainder of x with respect to y; that is, the result r is one of the num...
@ IMAG
imag (inary part of complex number)
@ ATAN2
atan2; atan2(y,x) computes an arc tangent of y/x in the range -pi to pi
@ MEDIAN1D
median; median(x) (is a scalar)
@ ARG
phase (of complex number)
@ ISNAN
is the value a NaN?
@ ALL
all (true) (is a scalar)
@ INDEXIN
a bool array telling which indices of an axis are to be used
@ FLOOR
floor; returns the greatest integral value less than or equal to x.
@ NFUNCTIONS
number of functions
@ FRACTILERANGE1D
fractilerange; fractilerange(x,fraction1[,fraction2]) (is a scalar)
@ CEIL
ceil; returns the least integral value greater than or equal to x.
@ POW
power pow(x,y) == x**y or x^y
@ ATAN
atan; atan(x) returns the arc tangent of x in the range -pi/2 to pi/2.
@ NELEM
nelements; nelements(x) (is a scalar)
@ FRACTILE1D
fractile; fractile(x,fraction) (is a scalar)
@ MIN1D
min; min(x) (is a scalar)
@ LENGTH
length (of an axis)
@ ANY
any (true) (is a scalar)
@ MAX1D
max; max(x) (is a scalar)
@ CONJ
conj (ugate complex number)
this file contains all the compiler specific defines
Definition: mainpage.dox:28