/*-------------------------------------------------------------------- * * $Id: gmtmath_explain.h.in 12822 2014-01-31 23:39:56Z remko $ * * Copyright (c) 1991-2014 by P. Wessel, W. H. F. Smith, R. Scharroo, * F. Wobbe, and J. Luis * See LICENSE.TXT file for copying and redistribution conditions. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation; version 3 or any later version. * * This program 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 Lesser General Public License for more details. * * Contact info: gmt.soest.hawaii.edu *-------------------------------------------------------------------- * * gmtmath_explain.h is automatically generated by CMake. Do NOT edit manually! */ GMT_Message (API, GMT_TIME_NONE, " ABS 1 1 abs (A)\n" " ACOS 1 1 acos (A)\n" " ACOSH 1 1 acosh (A)\n" " ACSC 1 1 acsc (A)\n" " ACOT 1 1 acot (A)\n" " ADD 2 1 A + B\n" " AND 2 1 B if A == NaN, else A\n" " ASEC 1 1 asec (A)\n" " ASIN 1 1 asin (A)\n" " ASINH 1 1 asinh (A)\n" " ATAN 1 1 atan (A)\n" " ATAN2 2 1 atan2 (A, B)\n" " ATANH 1 1 atanh (A)\n" " BEI 1 1 bei (A)\n" " BER 1 1 ber (A)\n" " BITAND 2 1 A & B (bitwise AND operator)\n" " BITLEFT 2 1 A << B (bitwise left-shift operator)\n" " BITNOT 1 1 ~A (bitwise NOT operator, i.e., return two's complement)\n" " BITOR 2 1 A | B (bitwise OR operator)\n" " BITRIGHT 2 1 A >> B (bitwise right-shift operator)\n" " BITTEST 2 1 1 if bit B of A is set, else 0 (bitwise TEST operator)\n" " BITXOR 2 1 A ^ B (bitwise XOR operator)\n" " CEIL 1 1 ceil (A) (smallest integer >= A)\n" " CHICRIT 2 1 Critical value for chi-squared-distribution, with alpha = A and n = B\n" " CHIDIST 2 1 chi-squared-distribution P(chi2,n), with chi2 = A and n = B\n" " COL 1 1 Places column A on the stack\n" " CORRCOEFF 2 1 Correlation coefficient r(A, B)\n" " COS 1 1 cos (A) (A in radians)\n" " COSD 1 1 cos (A) (A in degrees)\n" " COSH 1 1 cosh (A)\n" " COT 1 1 cot (A) (A in radians)\n" " COTD 1 1 cot (A) (A in degrees)\n" " CSC 1 1 csc (A) (A in radians)\n" " CSCD 1 1 csc (A) (A in degrees)\n" " CPOISS 2 1 Cumulative Poisson distribution F(x,lambda), with x = A and lambda = B\n" " DDT 1 1 d(A)/dt Central 1st derivative\n" " D2DT2 1 1 d^2(A)/dt^2 2nd derivative\n" " D2R 1 1 Converts Degrees to Radians\n" " DILOG 1 1 dilog (A)\n" " DIFF 1 1 Difference between adjacent elements of A (A[1]-A[0], A[2]-A[1], ..., 0)\n" " DIV 2 1 A / B\n" " DUP 1 2 Places duplicate of A on the stack\n" " ERF 1 1 Error function erf (A)\n" " ERFC 1 1 Complementary Error function erfc (A)\n" " ERFINV 1 1 Inverse error function of A\n" " EQ 2 1 1 if A == B, else 0\n" " EXCH 2 2 Exchanges A and B on the stack\n" " EXP 1 1 exp (A)\n" " FACT 1 1 A! (A factorial)\n" " FCRIT 3 1 Critical value for F-distribution, with alpha = A, n1 = B, and n2 = C\n" " FDIST 3 1 F-distribution Q(F,n1,n2), with F = A, n1 = B, and n2 = C\n" " FLIPUD 1 1 Reverse order of each column\n" " FLOOR 1 1 floor (A) (greatest integer <= A)\n" " FMOD 2 1 A % B (remainder after truncated division)\n" " GE 2 1 1 if A >= B, else 0\n" " GT 2 1 1 if A > B, else 0\n" " HYPOT 2 1 hypot (A, B) = sqrt (A*A + B*B)\n" " I0 1 1 Modified Bessel function of A (1st kind, order 0)\n" " I1 1 1 Modified Bessel function of A (1st kind, order 1)\n" " IFELSE 3 1 B if A != 0, else C\n" " IN 2 1 Modified Bessel function of A (1st kind, order B)\n" " INRANGE 3 1 1 if B <= A <= C, else 0\n" " INT 1 1 Numerically integrate A\n" " INV 1 1 1 / A\n" " ISFINITE 1 1 1 if A is finite, else 0\n" " ISNAN 1 1 1 if A == NaN, else 0\n" " J0 1 1 Bessel function of A (1st kind, order 0)\n" " J1 1 1 Bessel function of A (1st kind, order 1)\n" " JN 2 1 Bessel function of A (1st kind, order B)\n" " K0 1 1 Modified Kelvin function of A (2nd kind, order 0)\n" " K1 1 1 Modified Bessel function of A (2nd kind, order 1)\n" " KN 2 1 Modified Bessel function of A (2nd kind, order B)\n" " KEI 1 1 kei (A)\n" " KER 1 1 ker (A)\n" " KURT 1 1 Kurtosis of A\n" " LE 2 1 1 if A <= B, else 0\n" " LMSSCL 1 1 LMS scale estimate (LMS STD) of A\n" " LOG 1 1 log (A) (natural log)\n" " LOG10 1 1 log10 (A) (base 10)\n" " LOG1P 1 1 log (1+A) (accurate for small A)\n" " LOG2 1 1 log2 (A) (base 2)\n" " LOWER 1 1 The lowest (minimum) value of A\n" " LRAND 2 1 Laplace random noise with mean A and std. deviation B\n" " LSQFIT 1 0 Current table is [A | b]; return LS solution to A * x = b via Cholesky decomposition\n" " LT 2 1 1 if A < B, else 0\n" " MAD 1 1 Median Absolute Deviation (L1 STD) of A\n" " MAX 2 1 Maximum of A and B\n" " MEAN 1 1 Mean value of A\n" " MED 1 1 Median value of A\n" " MIN 2 1 Minimum of A and B\n" " MOD 2 1 A mod B (remainder after floored division)\n" " MODE 1 1 Mode value (Least Median of Squares) of A\n" " MUL 2 1 A * B\n" " NAN 2 1 NaN if A == B, else A\n" " NEG 1 1 -A\n" " NEQ 2 1 1 if A != B, else 0\n" " NORM 1 1 Normalize (A) so max(A)-min(A) = 1\n" " NOT 1 1 NaN if A == NaN, 1 if A == 0, else 0\n" " NRAND 2 1 Normal, random values with mean A and std. deviation B\n" " OR 2 1 NaN if B == NaN, else A\n" " PLM 3 1 Associated Legendre polynomial P(A) degree B order C\n" " PLMg 3 1 Normalized associated Legendre polynomial P(A) degree B order C (geophysical convention)\n" " POP 1 0 Delete top element from the stack\n" " POW 2 1 A ^ B\n" " PQUANT 2 1 The B'th Quantile (0-100%) of A\n" " PSI 1 1 Psi (or Digamma) of A\n" " PV 3 1 Legendre function Pv(A) of degree v = real(B) + imag(C)\n" " QV 3 1 Legendre function Qv(A) of degree v = real(B) + imag(C)\n" " R2 2 1 R2 = A^2 + B^2\n" " R2D 1 1 Convert Radians to Degrees\n" " RAND 2 1 Uniform random values between A and B\n" " RINT 1 1 rint (A) (round to integral value nearest to A)\n" " ROTT 2 1 Rotate A by the (constant) shift B in the t-direction\n" " SEC 1 1 sec (A) (A in radians)\n" " SECD 1 1 sec (A) (A in degrees)\n" " SIGN 1 1 sign (+1 or -1) of A\n" " SIN 1 1 sin (A) (A in radians)\n" " SINC 1 1 sinc (A) (sin (pi*A)/(pi*A))\n" " SIND 1 1 sin (A) (A in degrees)\n" " SINH 1 1 sinh (A)\n" " SKEW 1 1 Skewness of A\n" " SQR 1 1 A^2\n" " SQRT 1 1 sqrt (A)\n" " STD 1 1 Standard deviation of A\n" " STEP 1 1 Heaviside step function H(A)\n" " STEPT 1 1 Heaviside step function H(t-A)\n" " SUB 2 1 A - B\n" " SUM 1 1 Cumulative sum of A\n" " SVDFIT 1 0 Current table is [A | b]; return LS solution to A * x = B via SVD decomposition (see -E)\n" " TAN 1 1 tan (A) (A in radians)\n" " TAND 1 1 tan (A) (A in degrees)\n" " TANH 1 1 tanh (A)\n" " TAPER 1 1 Unit weights cosine-tapered to zero within A of end margins\n" " TN 2 1 Chebyshev polynomial Tn(-1