/usr/include/casacore/casa/BasicMath/Functors.h is in casacore-dev 2.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 | //# Functors.h: Define STL functors for basic math functions.
//# Copyright (C) 2008
//# 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: aips2-request@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
//#
//# $Id$
#ifndef CASA_FUNCTORS_H
#define CASA_FUNCTORS_H
#include <casacore/casa/aips.h>
#include <casacore/casa/BasicMath/Math.h>
#include <casacore/casa/BasicSL/Complex.h>
#include <casacore/casa/BasicSL/String.h>
#include <functional>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// Define a function to do a binary transform in place.
// It is functionally equivalent to std::transform where the first and result
// iterator are the same, but it is faster for non-trivial iterators.
template<typename InputIterator1, typename InputIterator2, typename BinaryOperator>
inline void transformInPlace (InputIterator1 first1, InputIterator1 last1,
InputIterator2 first2, BinaryOperator op)
{
for (; first1!=last1; ++first1, ++first2) {
*first1 = op(*first1, *first2);
}
}
// Define a function to do a unary transform in place.
// It is functionally equivalent to std::transform where the first and result
// iterator are the same, but it is faster for non-trivial iterators.
template<typename InputIterator1, typename UnaryOperator>
inline void transformInPlace (InputIterator1 first1, InputIterator1 last1,
UnaryOperator op)
{
for (; first1!=last1; ++first1) {
*first1 = op(*first1);
}
}
// Define a function (similar to std::accumulate) to do accumulation of
// elements for which the corresponding mask value is true.
// The default accumulation is addition.
template<typename InputIterator, typename MaskIterator, typename Accum, typename BinaryOperator>
inline Accum accumulateTrue (InputIterator first, InputIterator last,
MaskIterator mask, Accum acc,
BinaryOperator op = std::plus<Accum>())
{
for (; first!=last; ++first, ++mask) {
if (*mask) acc = op(acc, *first);
}
return acc;
}
// Define a function (similar to std::accumulate) to do accumulation of
// elements for which the corresponding mask value is false.
// The default accumulation is addition.
template<typename InputIterator, typename MaskIterator, typename Accum, typename BinaryOperator>
inline Accum accumulateFalse (InputIterator first, InputIterator last,
MaskIterator mask, Accum acc,
BinaryOperator op = std::plus<Accum>())
{
for (; first!=last; ++first, ++mask) {
if (!*mask) acc = op(acc, *first);
}
return acc;
}
// Define a function to compare all elements of two sequences.
// It returns true if all elements compare true.
// An example compare operator is <src>std::equal_to</src>.
// <group>
template<typename InputIterator1, typename InputIterator2, typename CompareOperator>
inline bool compareAll (InputIterator1 first1, InputIterator1 last1,
InputIterator2 first2, CompareOperator op)
{
for (; first1!=last1; ++first1, ++first2) {
if (!op(*first1, *first2)) return false;
}
return true;
}
// For use with a constant left value.
// This avoids use of bind1st or bind2nd which can fail for gcc-4.3.
// (see ArrayMath.h).
template<typename InputIterator1, typename T, typename CompareOperator>
inline bool compareAllLeft (InputIterator1 first1, InputIterator1 last1,
T left, CompareOperator op)
{
for (; first1!=last1; ++first1) {
if (!op(left, *first1)) return false;
}
return true;
}
// For use with a constant right value.
// This avoids use of bind1st or bind2nd which can fail for gcc-4.3.
// (see ArrayMath.h).
template<typename InputIterator1, typename T, typename CompareOperator>
inline bool compareAllRight (InputIterator1 first1, InputIterator1 last1,
T right, CompareOperator op)
{
for (; first1!=last1; ++first1) {
if (!op(*first1, right)) return false;
}
return true;
}
// </group>
// Define a function to compare all elements of two sequences.
// It returns true if any element compares true.
// An example compare operator is <src>std::equal_to</src>.
// <group>
template<typename InputIterator1, typename InputIterator2, typename CompareOperator>
inline bool compareAny (InputIterator1 first1, InputIterator1 last1,
InputIterator2 first2, CompareOperator op)
{
for (; first1!=last1; ++first1, ++first2) {
if (op(*first1, *first2)) return true;
}
return false;
}
// For use with a constant left value.
// This avoids use of bind1st or bind2nd which can fail for gcc-4.3.
// (see ArrayMath.h).
template<typename InputIterator1, typename T, typename CompareOperator>
inline bool compareAnyLeft (InputIterator1 first1, InputIterator1 last1,
T left, CompareOperator op)
{
for (; first1!=last1; ++first1) {
if (op(left, *first1)) return true;
}
return false;
}
// For use with a constant right value.
// This avoids use of bind1st or bind2nd which can fail for gcc-4.3.
// (see ArrayMath.h).
template<typename InputIterator1, typename T, typename CompareOperator>
inline bool compareAnyRight (InputIterator1 first1, InputIterator1 last1,
T right, CompareOperator op)
{
for (; first1!=last1; ++first1) {
if (op(*first1, right)) return true;
}
return false;
}
// </group>
// Functor to add variables of possibly different types.
// This is unlike std::plus which requires equal types.
template <typename L, typename R=L, typename RES=L>
struct Plus : public std::binary_function<L,R,RES>
{
RES operator() (const L& x, const R& y) const
{ return RES(x)+y; }
};
// Functor to subtract variables of possibly different types.
// This is unlike std::minus which requires equal types.
template <typename L, typename R=L, typename RES=L>
struct Minus : public std::binary_function<L,R,RES>
{
RES operator() (const L& x, const R& y) const
{ return RES(x)-y; }
};
// Functor to multiply variables of possibly different types.
// This is unlike std::multiplies which requires equal types.
template <typename L, typename R=L, typename RES=L>
struct Multiplies : public std::binary_function<L,R,RES>
{
RES operator() (const L& x, const R& y) const
{ return RES(x)*y; }
};
// Functor to divide variables of possibly different types.
// This is unlike std::divides which requires equal types.
template <typename L, typename R=L, typename RES=L>
struct Divides : public std::binary_function<L,R,RES>
{
RES operator() (const L& x, const R& y) const
{ return RES(x)/y; }
};
// Functor to take modulo of (integer) variables of possibly different types
// in the C way.
// This is unlike std::modulo which requires equal types.
template <typename L, typename R=L, typename RES=L>
struct Modulo : public std::binary_function<L,R,RES>
{
RES operator() (const L& x, const R& y) const
{ return RES(x)%y; }
};
// Functor to take modulo of variables of possibly different types
// using the floor modulo (% as used in Python).
template <typename L, typename R=L, typename RES=L>
struct FloorMod : public std::binary_function<L,R,RES>
{
RES operator() (const L& x, const R& y) const
{ return floormod (RES(x), RES(y)); }
};
// Functor for bitwise and of (integer) values.
template <typename T>
struct BitAnd : public std::binary_function<T,T,T>
{
T operator() (const T& x, const T& y) const
{ return x&y; }
};
// Functor for bitwise or of (integer) values.
template <typename T>
struct BitOr : public std::binary_function<T,T,T>
{
T operator() (const T& x, const T& y) const
{ return x|y; }
};
// Functor for bitwise xor of (integer) values.
template <typename T>
struct BitXor : public std::binary_function<T,T,T>
{
T operator() (const T& x, const T& y) const
{ return x^y; }
};
// Functor for bitwise negate of (integer) values.
template <typename T>
struct BitNegate : public std::unary_function<T,T>
{
T operator() (const T& x) const
{ return ~x; }
};
// Functor to test for NaN.
// It can be used in something like:
// <srcblock>
// std::transform (array.begin(), array.end(),
// result.begin(), IsNaN<T>());
// </srcblock>
template<typename T>
struct IsNaN : public std::unary_function<T,bool>
{
bool operator() (T value) const
{ return isNaN (value); }
};
// Functor to test for infinity.
template<typename T>
struct IsInf : public std::unary_function<T,bool>
{
bool operator() (T value) const
{ return isInf (value); }
};
// Functor to test for finiteness.
template<typename T>
struct IsFinite : public std::unary_function<T,bool>
{
bool operator() (T value) const
{ return isFinite (value); }
};
// Functor to test if two values are relatively near each other.
// It can be used in something like:
// <srcblock>
// std::transform (left.begin(), left.cend(), right.begin(),
// result.cbegin(), Near<T>(tolerance));
// </srcblock>
template<typename L, typename R=L>
struct Near : public std::binary_function<L,R,bool>
{
explicit Near (double tolerance=1e-5)
: itsTolerance (tolerance)
{}
bool operator() (L left, R right) const
{ return near (left, L(right), itsTolerance); }
private:
double itsTolerance;
};
// Functor to test for if two values are absolutely near each other.
template<typename L, typename R=L>
struct NearAbs : public std::binary_function<L,R,bool>
{
explicit NearAbs (double tolerance=1e-13)
: itsTolerance (tolerance)
{}
bool operator() (L left, R right) const
{ return nearAbs (left, L(right), itsTolerance); }
private:
double itsTolerance;
};
// Functor to apply sin.
template<typename T, typename RES=T>
struct Sin : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(sin (value)); }
};
// Functor to apply sinh.
template<typename T, typename RES=T>
struct Sinh : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(sinh (value)); }
};
// Functor to apply asin.
template<typename T, typename RES=T>
struct Asin : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(asin (value)); }
};
// Functor to apply cos.
template<typename T, typename RES=T>
struct Cos : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(cos (value)); }
};
// Functor to apply cosh.
template<typename T, typename RES=T>
struct Cosh : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(cosh (value)); }
};
// Functor to apply acos.
template<typename T, typename RES=T>
struct Acos : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(acos (value)); }
};
// Functor to apply tan.
template<typename T, typename RES=T>
struct Tan : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(tan (value)); }
};
// Functor to apply tanh.
template<typename T, typename RES=T>
struct Tanh : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(tanh (value)); }
};
// Functor to apply atan.
template<typename T, typename RES=T>
struct Atan : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(atan (value)); }
};
// Functor to apply atan2.
template<typename L, typename R=L, typename RES=L>
struct Atan2 : public std::binary_function<L,R,RES>
{
RES operator() (L left, R right) const
{ return RES(atan2 (left, L(right))); }
};
// Functor to apply sqr (power of 2).
template<typename T, typename RES=T>
struct Sqr : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(value*value); }
};
// Functor to apply a power of 3.
template<typename T, typename RES=T>
struct Pow3 : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(value*value*value); }
};
// Functor to apply sqrt.
template<typename T, typename RES=T>
struct Sqrt : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(sqrt (value)); }
};
// Functor to apply exp.
template<typename T, typename RES=T>
struct Exp : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(exp (value)); }
};
// Functor to apply log.
template<typename T, typename RES=T>
struct Log : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(log (value)); }
};
// Functor to apply log10.
template<typename T, typename RES=T>
struct Log10 : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(log10 (value)); }
};
// Functor to apply abs.
template<typename T, typename RES=T>
struct Abs : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(abs (value)); }
};
// Functor to apply floor.
template<typename T, typename RES=T>
struct Floor : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(floor (value)); }
};
// Functor to apply ceil.
template<typename T, typename RES=T>
struct Ceil : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(ceil (value)); }
};
// Functor to apply round (e.g. -3.7 gets -4).
template<typename T, typename RES=T>
struct Round : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(value<0 ? ceil(value-0.5) : floor(value+0.5)); }
};
// Functor to apply sign (result is -1, 0, or 1).
template<typename T, typename RES=T>
struct Sign : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return (value<0 ? -1 : (value>0 ? 1:0)); }
};
// Functor to form a complex number from the left and right value.
template<typename L, typename R, typename RES>
struct MakeComplex : public std::binary_function<L,R,RES>
{
RES operator() (L l, R r) const
{ return RES(l, r); }
};
// Functor to form a complex number from the real part of the
// left value and the right value.
template<typename L, typename R, typename RES>
struct MakeComplexReal : public std::binary_function<L,R,RES>
{
RES operator() (L l, R r) const
{ return RES(real(l), r); }
};
// Functor to form a complex number from the left value and the
// imaginary part of the right value.
template<typename L, typename R, typename RES>
struct MakeComplexImag : public std::binary_function<L,R,RES>
{
RES operator() (L l, R r) const
{ return RES(l, imag(r)); }
};
// Functor to form a complex number from the real part of the
// left value and the imaginary part of the right value.
template<typename L, typename R, typename RES>
struct MakeComplexRealImag : public std::binary_function<L,R,RES>
{
RES operator() (L l, R r) const
{ return RES(real(l), imag(r)); }
};
// Functor to apply complex function conj.
template<typename T, typename RES=T>
struct Conj : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(conj (value)); }
};
// Functor to apply complex function real.
template<typename T, typename RES>
struct Real : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(real (value)); }
};
// Functor to apply complex function imag.
template<typename T, typename RES>
struct Imag : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(imag (value)); }
};
// Functor to apply complex function arg.
template<typename T, typename RES>
struct CArg : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(arg (value)); }
};
// Functor to apply complex function fabs.
template<typename T, typename RES>
struct CAbs : public std::unary_function<T,RES>
{
RES operator() (T value) const
{ return RES(fabs (value)); }
};
// Functor to apply pow.
template<typename T, typename E=T, typename RES=T>
struct Pow : public std::binary_function<T,E,RES>
{
RES operator() (T left, E exponent) const
{ return RES(pow (left, exponent)); }
};
// Functor to apply fmod.
template<typename L, typename R=L, typename RES=L>
struct Fmod : public std::binary_function<L,R,RES>
{
RES operator() (R left, L right) const
{ return RES(fmod (left, L(right))); }
};
// Functor to get minimum of two values.
template<typename L, typename R=L, typename RES=L>
struct Min : public std::binary_function<L,R,RES>
{
RES operator() (L left, R right) const
{ return RES(left<right ? left : right); }
};
// Functor to get maximum of two values.
template<typename L, typename R=L, typename RES=L>
struct Max : public std::binary_function<L,R,RES>
{
RES operator() (L left, R right) const
{ return RES(left<right ? right : left); }
};
// Functor to add square of right to left.
template<typename T, typename Accum=T>
struct SumSqr : public std::binary_function<Accum,T,Accum>
{
Accum operator() (Accum left, T right) const
{ return left + Accum(right)*Accum(right); }
};
// Functor to add squared diff of right and base value to left.
// It can be used to calculate the standard deviation.
template<typename T, typename Accum=T>
struct SumSqrDiff : public std::binary_function<Accum,T,Accum>
{
explicit SumSqrDiff(T base) : itsBase(base) {}
Accum operator() (Accum left, T right) const
{ return left + (right-itsBase)*(right-itsBase); }
private:
Accum itsBase; // store as Accum, so subtraction results in Accum
};
// Functor to add absolute diff of right and base value to left.
// It can be used to calculate the average deviation.
template<typename T, typename Accum=T>
struct SumAbsDiff : public std::binary_function<Accum,T,Accum>
{
explicit SumAbsDiff(T base) : itsBase(base) {}
Accum operator() (Accum left, T right) const
{ return left + abs((right-itsBase)); }
private:
Accum itsBase; // store as Accum, so subtracttion results in Accum
};
// Functor to downcase a std::string. The result is a casacore::String.
struct Downcase : public std::unary_function<std::string,String>
{
String operator() (const std::string& value) const
{ return downcase(value); }
};
// Functor to upcase a std::string. The result is a casacore::String.
struct Upcase : public std::unary_function<std::string,String>
{
String operator() (const std::string& value) const
{ return upcase(value); }
};
// Functor to capitalize a std::string. The result is a casacore::String.
struct Capitalize : public std::unary_function<std::string,String>
{
String operator() (const std::string& value) const
{ return capitalize(value); }
};
// Functor to trim a std::string. The result is a casacore::String.
// Leading and trailing whitespace is removed.
struct Trim : public std::unary_function<std::string,String>
{
String operator() (const std::string& value) const
{ return trim(value); }
};
} //# NAMESPACE CASACORE - END
#endif
|