/usr/include/ITK-4.9/itkMath.h is in libinsighttoolkit4-dev 4.9.0-4ubuntu1.
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 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 | /*=========================================================================
*
* Copyright Insight Software Consortium
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
/*=========================================================================
*
* Portions of this file are subject to the VTK Toolkit Version 3 copyright.
*
* Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
*
* For complete copyright, license and disclaimer of warranty information
* please refer to the NOTICE file at the top of the ITK source tree.
*
*=========================================================================*/
#ifndef itkMath_h
#define itkMath_h
#include "itkIntTypes.h"
#include "itkMathDetail.h"
#include "itkConceptChecking.h"
#include "itkNumericTraits.h"
namespace itk
{
namespace Math
{
// These constants originate from VXL's vnl_math.h. They have been
// moved here to improve visibility, and to ensure that the constants
// are available during compile time ( as opposed to static const
// member vaiables ).
/** \brief \f[e\f] The base of the natural logarithm or Euler's number */
static const double e = 2.7182818284590452354;
/** \brief \f[ \log_2 e \f] */
static const double log2e = 1.4426950408889634074;
/** \brief \f[ \log_{10} e \f] */
static const double log10e = 0.43429448190325182765;
/** \brief \f[ \log_e 2 \f] */
static const double ln2 = 0.69314718055994530942;
/** \brief \f[ \log_e 10 \f] */
static const double ln10 = 2.30258509299404568402;
/** \brief \f[ \pi \f] */
static const double pi = 3.14159265358979323846;
/** \brief \f[ \frac{\pi}{2} \f] */
static const double pi_over_2 = 1.57079632679489661923;
/** \brief \f[ \frac{\pi}{4} \f] */
static const double pi_over_4 = 0.78539816339744830962;
/** \brief \f[ \frac{1}{\pi} \f] */
static const double one_over_pi = 0.31830988618379067154;
/** \brief \f[ \frac{2}{\pi} \f] */
static const double two_over_pi = 0.63661977236758134308;
/** \brief \f[ \frac{2}{\sqrt{\pi}} \f] */
static const double two_over_sqrtpi = 1.12837916709551257390;
/** \brief \f[ \frac{2}{\sqrt{2\pi}} \f] */
static const double one_over_sqrt2pi = 0.39894228040143267794;
/** \brief \f[ \sqrt{2} \f] */
static const double sqrt2 = 1.41421356237309504880;
/** \brief \f[ \sqrt{ \frac{1}{2}} \f] */
static const double sqrt1_2 = 0.70710678118654752440;
/** A useful macro to generate a template floating point to integer
* conversion templated on the return type and using either the 32
* bit, the 64 bit or the vanilla version */
#define itkTemplateFloatingToIntegerMacro(name) \
template< typename TReturn, typename TInput > \
inline TReturn name(TInput x) \
{ \
\
if ( sizeof( TReturn ) <= 4 ) \
{ \
return static_cast< TReturn >( Detail::name##_32(x) ); \
} \
else if ( sizeof( TReturn ) <= 8 ) \
{ \
return static_cast< TReturn >( Detail::name##_64(x) ); \
} \
else \
{ \
return static_cast< TReturn >( Detail::name##_base< TReturn, TInput >(x) ); \
} \
}
/** \brief Round towards nearest integer
*
* \tparam TReturn must be an integer type
* \tparam TInput must be float or double
*
* halfway cases are rounded towards the nearest even
* integer, e.g.
* \code
* RoundHalfIntegerToEven( 1.5) == 2
* RoundHalfIntegerToEven(-1.5) == -2
* RoundHalfIntegerToEven( 2.5) == 2
* RoundHalfIntegerToEven( 3.5) == 4
* \endcode
*
* The behavior of overflow is undefined due to numerous implementations.
*
* \warning We assume that the rounding mode is not changed from the default
* one (or at least that it is always restored to the default one).
*/
itkTemplateFloatingToIntegerMacro(RoundHalfIntegerToEven);
/** \brief Round towards nearest integer
*
* \tparam TReturn must be an integer type
* \tparam TInput must be float or double
*
* halfway cases are rounded upward, e.g.
* \code
* RoundHalfIntegerUp( 1.5) == 2
* RoundHalfIntegerUp(-1.5) == -1
* RoundHalfIntegerUp( 2.5) == 3
* \endcode
*
* The behavior of overflow is undefined due to numerous implementations.
*
* \warning The argument absolute value must be less than
* NumbericTraits<TReturn>::max()/2 for RoundHalfIntegerUp to be
* guaranteed to work.
*
* \warning We also assume that the rounding mode is not changed from
* the default one (or at least that it is always restored to the
* default one).
*/
itkTemplateFloatingToIntegerMacro(RoundHalfIntegerUp);
/** \brief Round towards nearest integer (This is a synonym for RoundHalfIntegerUp)
*
* \tparam TReturn must be an integer type
* \tparam TInput must be float or double
*
* \sa RoundHalfIntegerUp<TReturn, TInput>()
*/
template< typename TReturn, typename TInput >
inline TReturn Round(TInput x) { return RoundHalfIntegerUp< TReturn, TInput >(x); }
/** \brief Round towards minus infinity
*
* The behavior of overflow is undefined due to numerous implementations.
*
* \warning argument absolute value must be less than
* NumbericTraits<TReturn>::max()/2 for vnl_math_floor to be
* guaranteed to work.
*
* \warning We also assume that the rounding mode is not changed from
* the default one (or at least that it is always restored to the
* default one).
*/
itkTemplateFloatingToIntegerMacro(Floor);
/** \brief Round towards plus infinity
*
* The behavior of overflow is undefined due to numerous implementations.
*
* \warning argument absolute value must be less than INT_MAX/2
* for vnl_math_ceil to be guaranteed to work.
* \warning We also assume that the rounding mode is not changed from
* the default one (or at least that it is always restored to the
* default one).
*/
itkTemplateFloatingToIntegerMacro(Ceil);
#undef itkTemplateFloatingToIntegerMacro
template< typename TReturn, typename TInput >
inline TReturn CastWithRangeCheck(TInput x)
{
#ifdef ITK_USE_CONCEPT_CHECKING
itkConceptMacro( OnlyDefinedForIntegerTypes1, ( itk::Concept::IsInteger< TReturn > ) );
itkConceptMacro( OnlyDefinedForIntegerTypes2, ( itk::Concept::IsInteger< TInput > ) );
#endif // ITK_USE_CONCEPT_CHECKING
TReturn ret = static_cast< TReturn >( x );
if ( sizeof( TReturn ) > sizeof( TInput )
&& !( !itk::NumericTraits< TReturn >::is_signed && itk::NumericTraits< TInput >::is_signed ) )
{
// if the output type is bigger and we are not converting a signed
// integer to an unsigned integer then we have no problems
return ret;
}
else if ( sizeof( TReturn ) >= sizeof( TInput ) )
{
if ( itk::NumericTraits< TInput >::IsPositive(x) != itk::NumericTraits< TReturn >::IsPositive(ret) )
{
itk::RangeError _e(__FILE__, __LINE__);
throw _e;
}
}
else if ( static_cast< TInput >( ret ) != x
|| ( itk::NumericTraits< TInput >::IsPositive(x) != itk::NumericTraits< TReturn >::IsPositive(ret) ) )
{
itk::RangeError _e(__FILE__, __LINE__);
throw _e;
}
return ret;
}
/** \brief Return the signed distance in ULPs (units in the last place) between two floats.
*
* This is the signed distance, i.e., if x1 > x2, then the result is positive.
*
* \sa FloatAlmostEqual
*/
template <typename T>
inline typename Detail::FloatIEEE<T>::IntType
FloatDifferenceULP( T x1, T x2 )
{
Detail::FloatIEEE<T> x1f(x1);
Detail::FloatIEEE<T> x2f(x2);
return x1f.AsULP() - x2f.AsULP();
}
/** \brief Compare two floats and return if they are effectively equal.
*
* Determining when floats are almost equal is difficult because of their
* IEEE bit representation. This function uses the integer representation of
* the float to determine if they are almost equal.
*
* The implementation is based off the explanation in the white papers:
*
* - http://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/
* - http://www.cygnus-software.com/papers/comparingfloats/comparingfloats.htm
*
* This function is not a cure-all, and reading those articles is important
* to understand its appropriate use in the context of ULPs, zeros, subnormals,
* infinities, and NANs. For example, it is preferable to use this function on
* two floats directly instead of subtracting them and comparing them to zero.
*
* The tolerance is specified in ULPs (units in the last place), i.e. how many
* floats there are in between the numbers. Therefore, the tolerance depends on
* the magnitude of the values that are being compared. A second tolerance is
* a maximum difference allowed, which is important when comparing numbers close to
* zero.
*
* A NAN compares as not equal to a number, but two NAN's may compare as equal
* to each other.
*
* \param x1 first floating value to compare
* \param x2 second floating values to compare
* \param maxUlps maximum units in the last place to be considered equal
* \param maxAbsoluteDifference maximum absolute difference to be considered equal
*/
template <typename T>
inline bool
FloatAlmostEqual( T x1, T x2,
typename Detail::FloatIEEE<T>::IntType maxUlps = 4,
typename Detail::FloatIEEE<T>::FloatType maxAbsoluteDifference = 0.1*itk::NumericTraits<T>::epsilon() )
{
// Check if the numbers are really close -- needed
// when comparing numbers near zero.
const T absDifference = std::abs(x1 - x2);
if ( absDifference <= maxAbsoluteDifference )
{
return true;
}
#if defined(__APPLE__) && (__clang_major__ == 3) && (__clang_minor__ == 0) && defined(NDEBUG) && defined(__x86_64__)
Detail::FloatIEEE<T> x1f(x1);
Detail::FloatIEEE<T> x2f(x2);
double x1fAsULP = static_cast<double>(x1f.AsULP());
double x2fAsULP = static_cast<double>(x2f.AsULP());
double ulps = x1fAsULP - x2fAsULP;
if(ulps < 0)
{
ulps = -ulps;
}
return ulps <= static_cast<double>(maxUlps);
#else
typename Detail::FloatIEEE<T>::IntType
ulps = FloatDifferenceULP(x1, x2);
if(ulps < 0)
{
ulps = -ulps;
}
return ulps <= maxUlps;
#endif
}
// The following code cannot be moved to the itkMathDetail.h file without introducing circular dependencies
namespace Detail // The Detail namespace holds the templates used by AlmostEquals
{
// The following structs and templates are used to choose
// which version of the AlmostEquals function
// should be implemented base on input parameter types
// Structs for choosing AlmostEquals function
struct AlmostEqualsFloatVsFloat
{
template <typename TFloatType1, typename TFloatType2>
static bool AlmostEqualsFunction(TFloatType1 x1, TFloatType2 x2)
{
return FloatAlmostEqual<double>(x1, x2);
}
template <typename TFloatType1, typename TFloatType2>
static bool
AlmostEqualsFunction(double x1, double x2)
{
return FloatAlmostEqual<double>(x1, x2);
}
template <typename TFloatType1, typename TFloatType2>
static bool
AlmostEqualsFunction(double x1, float x2)
{
return FloatAlmostEqual<float>(x1, x2);
}
template <typename TFloatType1, typename TFloatType2>
static bool
AlmostEqualsFunction(float x1, double x2)
{
return FloatAlmostEqual<float>(x1, x2);
}
template <typename TFloatType1, typename TFloatType2>
static bool
AlmostEqualsFunction(float x1, float x2)
{
return FloatAlmostEqual<float>(x1, x2);
}
};
struct AlmostEqualsFloatVsInteger
{
template <typename TFloatType, typename TIntType>
static bool AlmostEqualsFunction(TFloatType floatingVariable, TIntType integerVariable)
{
return FloatAlmostEqual<TFloatType> (floatingVariable, integerVariable);
}
};
struct AlmostEqualsIntegerVsFloat
{
template <typename TIntType, typename TFloatType>
static bool AlmostEqualsFunction(TIntType integerVariable, TFloatType floatingVariable)
{
return AlmostEqualsFloatVsInteger::AlmostEqualsFunction(floatingVariable, integerVariable);
}
};
struct AlmostEqualsSignedVsUnsigned
{
template <typename TSignedInt, typename TUnsignedInt>
static bool AlmostEqualsFunction(TSignedInt signedVariable, TUnsignedInt unsignedVariable)
{
if(signedVariable < 0) return false;
if( unsignedVariable > static_cast< size_t >(itk::NumericTraits<TSignedInt>::max()) ) return false;
return signedVariable == static_cast< TSignedInt >(unsignedVariable);
}
};
struct AlmostEqualsUnsignedVsSigned
{
template <typename TUnsignedInt, typename TSignedInt>
static bool AlmostEqualsFunction(TUnsignedInt unsignedVariable, TSignedInt signedVariable)
{
return AlmostEqualsSignedVsUnsigned::AlmostEqualsFunction(signedVariable, unsignedVariable);
}
};
struct AlmostEqualsPlainOldEquals
{
template <typename TIntegerType1, typename TIntegerType2>
static bool AlmostEqualsFunction(TIntegerType1 x1, TIntegerType2 x2)
{
return x1 == x2;
}
};
// end of structs that choose the specific AlmostEquals function
// Selector structs, these select the correct case based on its types
// input1 is int? input 1 is signed? input2 is int? input 2 is signed?
template<bool TInput1IsIntger, bool TInput1IsSigned, bool TInput2IsInteger, bool TInput2IsSigned>
struct AlmostEqualsFunctionSelector
{ // default case
typedef AlmostEqualsPlainOldEquals SelectedVersion;
};
/// \cond HIDE_SPECIALIZATION_DOCUMENTATION
template<>
struct AlmostEqualsFunctionSelector < false, true, false, true>
// floating type v floating type
{
typedef AlmostEqualsFloatVsFloat SelectedVersion;
};
template<>
struct AlmostEqualsFunctionSelector <false, true, true, true>
// float vs signed int
{
typedef AlmostEqualsFloatVsInteger SelectedVersion;
};
template<>
struct AlmostEqualsFunctionSelector <false, true, true,false>
// float vs unsigned int
{
typedef AlmostEqualsFloatVsInteger SelectedVersion;
};
template<>
struct AlmostEqualsFunctionSelector <true, false, false, true>
// unsigned int vs float
{
typedef AlmostEqualsIntegerVsFloat SelectedVersion;
};
template<>
struct AlmostEqualsFunctionSelector <true, true, false, true>
// signed int vs float
{
typedef AlmostEqualsIntegerVsFloat SelectedVersion;
};
template<>
struct AlmostEqualsFunctionSelector<true, true, true, false>
// signed vs unsigned
{
typedef AlmostEqualsSignedVsUnsigned SelectedVersion;
};
template<>
struct AlmostEqualsFunctionSelector<true, false, true, true>
// unsigned vs signed
{
typedef AlmostEqualsUnsignedVsSigned SelectedVersion;
};
template<>
struct AlmostEqualsFunctionSelector<true, true, true, true>
// signed vs signed
{
typedef AlmostEqualsPlainOldEquals SelectedVersion;
};
template<>
struct AlmostEqualsFunctionSelector<true, false, true, false>
// unsigned vs unsigned
{
typedef AlmostEqualsPlainOldEquals SelectedVersion;
};
// end of AlmostEqualsFunctionSelector structs
// The implementor tells the selector what to do
template<typename TInputType1, typename TInputType2>
struct AlmostEqualsScalarImplementer
{
static const bool TInputType1IsInteger = itk::NumericTraits<TInputType1>::IsInteger;
static const bool TInputType1IsSigned = itk::NumericTraits<TInputType1>::IsSigned;
static const bool TInputType2IsInteger = itk::NumericTraits<TInputType2>::IsInteger;
static const bool TInputType2IsSigned = itk::NumericTraits<TInputType2>::IsSigned;
typedef typename AlmostEqualsFunctionSelector< TInputType1IsInteger, TInputType1IsSigned,
TInputType2IsInteger, TInputType2IsSigned >::SelectedVersion SelectedVersion;
};
// The AlmostEqualsScalarComparer returns the result of an
// approximate comparison between two scalar values of
// potentially different data types.
template <typename TScalarType1, typename TScalarType2>
static bool
AlmostEqualsScalarComparer( TScalarType1 x1, TScalarType2 x2 )
{
return AlmostEqualsScalarImplementer<TScalarType1, TScalarType2>::SelectedVersion:: template AlmostEqualsFunction<TScalarType1, TScalarType2>(x1, x2);
}
// The following structs are used to evaluate approximate comparisons between
// complex and scalar values of potentially different types.
// Comparisons between scalar types use the AlmostEqualsScalarComparer function.
struct AlmostEqualsScalarVsScalar
{
template <typename TScalarType1, typename TScalarType2>
static bool
AlmostEqualsFunction(TScalarType1 x1, TScalarType2 x2)
{
return AlmostEqualsScalarComparer(x1, x2);
}
};
// Comparisons between two complex values compare the real and imaginary components
// separately with the AlmostEqualsScalarComparer function.
struct AlmostEqualsComplexVsComplex
{
template <typename TComplexType1, typename TComplexType2>
static bool
AlmostEqualsFunction(TComplexType1 x1, TComplexType2 x2)
{
return AlmostEqualsScalarComparer(x1.real(), x2.real()) && AlmostEqualsScalarComparer( x1.imag(), x2.imag() );
}
};
// Comparisons between complex and scalar values first check to see if the imaginary component
// of the complex value is approximately 0. Then a ScalarComparison is done between the real
// part of the complex number and the scalar value.
struct AlmostEqualsScalarVsComplex
{
template <typename TScalarType, typename TComplexType>
static bool
AlmostEqualsFunction(TScalarType scalarVariable, TComplexType complexVariable)
{
if( !AlmostEqualsScalarComparer( complexVariable.imag(), itk::NumericTraits< typename itk::NumericTraits< TComplexType >::ValueType >::ZeroValue() ) )
{
return false;
}
return AlmostEqualsScalarComparer(scalarVariable, complexVariable.real());
}
};
struct AlmostEqualsComplexVsScalar
{
template <typename TComplexType, typename TScalarType>
static bool
AlmostEqualsFunction(TComplexType complexVariable, TScalarType scalarVariable)
{
return AlmostEqualsScalarVsComplex::AlmostEqualsFunction(scalarVariable, complexVariable);
}
};
// The AlmostEqualsComplexChooser structs choose the correct case
// from the input parameter types' IsComplex property
// The default case is scalar vs scalar
template < bool T1IsComplex, bool T2IsComplex > //Default is false, false
struct AlmostEqualsComplexChooser
{
typedef AlmostEqualsScalarVsScalar ChosenVersion;
};
template <>
struct AlmostEqualsComplexChooser< true, true >
{
typedef AlmostEqualsComplexVsComplex ChosenVersion;
};
template <>
struct AlmostEqualsComplexChooser< false, true >
{
typedef AlmostEqualsScalarVsComplex ChosenVersion;
};
template <>
struct AlmostEqualsComplexChooser< true, false>
{
typedef AlmostEqualsComplexVsScalar ChosenVersion;
};
// End of AlmostEqualsComplexChooser structs.
// The AlmostEqualsComplexImplementer determines which of the input
// parameters are complex and which are real, and sends that information
// to the AlmostEqualsComplexChooser structs to determine the proper
// type of evaluation.
template <typename T1, typename T2>
struct AlmostEqualsComplexImplementer
{
static const bool T1IsComplex = NumericTraits< T1 >::IsComplex;
static const bool T2IsComplex = NumericTraits< T2 >::IsComplex;
typedef typename AlmostEqualsComplexChooser< T1IsComplex, T2IsComplex >::ChosenVersion ChosenVersion;
};
/// \endcond
} // end namespace Detail
/** \brief Provide consistent equality checks between values of potentially different scalar or complex types
*
* template< typename T1, typename T2 >
* AlmostEquals( T1 x1, T2 x2 )
*
* template< typename T1, typename T2 >
* NotAlmostEquals( T1 x1, T2 x2 )
*
* This function compares two scalar or complex values of potentially different types.
* For maximum extensibility the function is implemented through a series of templated
* structs which direct the AlmostEquals() call to the correct function by evaluating
* the parameter's types.
*
* Overall algorithm:
* If both values are complex...
* separate values into real and imaginary components and compare them separately
*
* If one of the values is complex..
* see if the imaginary part of the complex value is approximately 0 ...
* compare real part of complex value with scalar value
*
* If both values are scalars...
*
* To compare two floating point types...
* use FloatAlmostEqual.
*
* To compare a floating point and an integer type...
* Use static_cast<FloatingPointType>(integerValue) and call FloatAlmostEqual
*
* To compare signed and unsigned integers...
* Check for negative value or overflow, then cast and use ==
*
* To compare two signed or two unsigned integers ...
* Use ==
*
* To compare anything else ...
* Use ==
*
* \param x1 first scalar value to compare
* \param x2 second scalar value to compare
*/
// The AlmostEquals function
template <typename T1, typename T2>
inline bool
AlmostEquals( T1 x1, T2 x2 )
{
return Detail::AlmostEqualsComplexImplementer<T1,T2>::ChosenVersion::AlmostEqualsFunction(x1, x2);
}
// The NotAlmostEquals function
template <typename T1, typename T2>
inline bool
NotAlmostEquals( T1 x1, T2 x2 )
{
return ! AlmostEquals( x1, x2 );
}
/** \brief Return the result of an exact comparison between two scalar values of potetially different types.
*
* template <typename TInput1, typename TInput2>
* inline bool
* ExactlyEquals( const TInput & x1, const TInput & x2 )
*
* template <typename TInput1, typename TInput2>
* inline bool
* NotExactlyEquals( const TInput & x1, const TInput & x2 )
*
* These functions complement the EqualsComparison functions and determine if two scalar
* values are exactly equal using the compilers casting rules when comparing two different types.
* While this is also easily accomplished by using the equality operators,
* use of this function demonstrates the intent of an exact equality check and thus improves
* readability and clarity of code. In addition, this function suppresses float-equal warnings
* produced when using Clang.
*
* \param x1 first floating point value to compare
* \param x2 second floating point value to compare
*/
// The ExactlyEquals function
template <typename TInput1, typename TInput2>
inline bool
ExactlyEquals( const TInput1 & x1, const TInput2 & x2 )
{
CLANG_PRAGMA_PUSH
CLANG_SUPPRESS_Wfloat_equal
return x1 == x2;
CLANG_PRAGMA_POP
}
//The NotExactlyEquals function
template <typename TInput1, typename TInput2>
inline bool
NotExactlyEquals( const TInput1 & x1, const TInput2 & x2 )
{
return !ExactlyEquals(x1, x2);
}
/** Return whether the number in a prime number or not.
*
* \note Negative numbers can not be prime.
*/
ITKCommon_EXPORT bool IsPrime( unsigned short n );
ITKCommon_EXPORT bool IsPrime( unsigned int n );
ITKCommon_EXPORT bool IsPrime( unsigned long n );
ITKCommon_EXPORT bool IsPrime( unsigned long long n );
/** Return the greatest factor of the decomposition in prime numbers */
ITKCommon_EXPORT unsigned short GreatestPrimeFactor( unsigned short n );
ITKCommon_EXPORT unsigned int GreatestPrimeFactor( unsigned int n );
ITKCommon_EXPORT unsigned long GreatestPrimeFactor( unsigned long n );
ITKCommon_EXPORT unsigned long long GreatestPrimeFactor( unsigned long long n );
} // end namespace Math
} // end namespace itk
#endif // end of itkMath.h
|