Utility.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/Utility.h - Released 2024-06-18T15:48:54Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_Utility_h
#define __PCL_Utility_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/Association.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
// ----------------------------------------------------------------------------
 
template <typename T> inline constexpr
const T& Min( const T& a, const T& b ) noexcept
{
   return (b < a) ? b : a;
}
 
// ----------------------------------------------------------------------------
 
template <typename T, class BP> inline
const T& Min( const T& a, const T& b, BP p ) noexcept( noexcept( p ) )
{
   return p( b, a ) ? b : a;
}
 
// ----------------------------------------------------------------------------
 
template <typename T> inline constexpr
const T& Max( const T& a, const T& b ) noexcept
{
   return (a < b) ? b : a;
}
 
// ----------------------------------------------------------------------------
 
template <typename T, class BP> inline
const T& Max( const T& a, const T& b, BP p ) noexcept( noexcept( p ) )
{
   return p( a, b ) ? b : a;
}
 
// ----------------------------------------------------------------------------
 
template <typename T> inline constexpr
const T& Median( const T& a, const T& b, const T& c ) noexcept
{
   return (a < b) ? ((b < c) ? b : ((a < c) ? c : a)) :
                    ((a < c) ? a : ((b < c) ? c : b));
}
 
// ----------------------------------------------------------------------------
 
template <typename T, class BP> inline
const T& Median( const T& a, const T& b, const T& c, BP p ) noexcept( noexcept( p ) )
{
   return p( a, b ) ? (p( b, c ) ? b : (p( a, c ) ? c : a)) :
                      (p( a, c ) ? a : (p( b, c ) ? c : b));
}
 
// ----------------------------------------------------------------------------
 
template <typename T> inline constexpr
const T& Range( const T& x, const T& a, const T& b ) noexcept
{
   PCL_PRECONDITION( a < b )
   return (x < a) ? a : ((b < x) ? b : x);
}
 
// ----------------------------------------------------------------------------
 
template <typename T, class BP> inline
const T& Range( const T& x, const T& a, const T& b, BP p ) noexcept( noexcept( p ) )
{
   PCL_PRECONDITION( p( a, b ) )
   return p( x, a ) ? a : (p( b, x ) ? b : x);
}
 
// ----------------------------------------------------------------------------
 
#define ItemsInArray( a )  (sizeof( a )/sizeof( *a ))
 
// ----------------------------------------------------------------------------
 
template <typename T> inline
void Swap( T& a, T& b ) noexcept( std::is_nothrow_copy_constructible<T>::value
                               && std::is_nothrow_copy_assignable<T>::value
                               && std::is_nothrow_move_assignable<T>::value )
{
   T c( a ); a = b; b = std::move( c );
}
 
// ----------------------------------------------------------------------------
 
template <class FI, class F> inline
void Apply( FI i, FI j, F f ) noexcept( noexcept( f ) )
{
   for( ; i != j; ++i )
      f( *i );
}
 
// ----------------------------------------------------------------------------
 
template <class FI, class F, typename T1> inline
void Apply( FI i, FI j, F f, T1 x ) noexcept( noexcept( f ) )
{
   for( ; i != j; ++i )
      f( *i, x );
}
 
// ----------------------------------------------------------------------------
 
template <class FI, class F, class UP> inline
void ApplyIf( FI i, FI j, F f, UP p ) noexcept( noexcept( f ) && noexcept( p ) )
{
   for( ; i != j; ++i )
      if ( p( *i ) )
         f( *i );
}
 
// ----------------------------------------------------------------------------
 
template <class FI, class F, class UP, typename T1> inline
void ApplyIf( FI i, FI j, F f, UP p, T1 x ) noexcept( noexcept( f ) && noexcept( p ) )
{
   for( ; i != j; ++i )
      if ( p( *i ) )
         f( *i, x );
}
 
// ----------------------------------------------------------------------------
 
template <class FI, class UP> inline
FI FirstThat( FI i, FI j, UP p ) noexcept( noexcept( p ) )
{
   for ( ; i != j; ++i )
      if ( p( *i ) )
         break;
   return i;
}
 
// ----------------------------------------------------------------------------
 
template <class FI, class UP, typename T1> inline
FI FirstThat( FI i, FI j, UP p, T1 x ) noexcept( noexcept( p ) )
{
   for ( ; i != j; ++i )
      if ( p( *i, x ) )
         break;
   return i;
}
 
// ----------------------------------------------------------------------------
 
template <class BI, class UP> inline
BI LastThat( BI i, BI j, UP p ) noexcept( noexcept( p ) )
{
   for ( BI k = j; i != k; )
      if ( p( *--k ) )
         return k;
   return j;
}
 
// ----------------------------------------------------------------------------
 
template <class BI, class UP, typename T1> inline
BI LastThat( BI i, BI j, UP p, T1 x ) noexcept( noexcept( p ) )
{
   for ( BI k = j; i != k; )
      if ( p( *--k, x ) )
         return k;
   return j;
}
 
// ----------------------------------------------------------------------------
 
template <class FI, typename T> inline
size_type Count( FI i, FI j, const T& v ) noexcept
{
   size_type N = 0;
   for( ; i != j; ++i )
      if ( *i == v )
         ++N;
   return N;
}
 
// ----------------------------------------------------------------------------
 
template <class FI, typename T, class BP> inline
size_type Count( FI i, FI j, const T& v, BP p ) noexcept( noexcept( p ) )
{
   size_type N = 0;
   for( ; i != j; ++i )
      if ( p( *i, v ) )
         ++N;
   return N;
}
 
// ----------------------------------------------------------------------------
 
template <class FI, class UP> inline
size_type CountIf( FI i, FI j, UP p ) noexcept( noexcept( p ) )
{
   size_type N = 0;
   for( ; i != j; ++i )
      if ( p( *i ) )
         ++N;
   return N;
}
 
// ----------------------------------------------------------------------------
 
template <class FI> inline
FI MinItem( FI i, FI j ) noexcept
{
   FI k = i;
   if ( i != j )
      while ( ++i != j )
         if ( *i < *k )
            k = i;
   return k;
}
 
// ----------------------------------------------------------------------------
 
template <class FI, class BP> inline
FI MinItem( FI i, FI j, BP p ) noexcept( noexcept( p ) )
{
   FI k = i;
   if ( i != j )
      while ( ++i != j )
         if ( p( *i, *k ) )
            k = i;
   return k;
}
 
// ----------------------------------------------------------------------------
 
template <class FI> inline
FI MaxItem( FI i, FI j ) noexcept
{
   FI k = i;
   if ( i != j )
      while ( ++i != j )
         if ( *k < *i )
            k = i;
   return k;
}
 
// ----------------------------------------------------------------------------
 
template <class FI, class BP> inline
FI MaxItem( FI i, FI j, BP p ) noexcept( noexcept( p ) )
{
   FI k = i;
   if ( i != j )
      while ( ++i != j )
         if ( p( *k, *i ) )
            k = i;
   return k;
}
 
// ----------------------------------------------------------------------------
 
template <class FI> inline
void FindExtremeItems( FI& kmin, FI& kmax, FI i, FI j ) noexcept
{
   kmin = kmax = i;
   if ( i != j )
      while ( ++i != j )
      {
         if ( *i < *kmin )
            kmin = i;
         if ( *kmax < *i )
            kmax = i;
      }
}
 
// ----------------------------------------------------------------------------
 
template <class FI, class BP> inline
void FindExtremeItems( FI& kmin, FI& kmax, FI i, FI j, BP p ) noexcept( noexcept( p ) )
{
   kmin = kmax = i;
   if ( i != j )
      while ( ++i != j )
      {
         if ( p( *i, *kmin ) )
            kmin = i;
         if ( p( *kmax, *i ) )
            kmax = i;
      }
}
 
// ----------------------------------------------------------------------------
 
template <class FI1, class FI2> inline
Association<FI1, FI2> FindNotEqual( FI1 i1, FI2 i2, FI2 j2 ) noexcept
{
   for ( ; i2 != j2 && *i1 == *i2; ++i1, ++i2 ) {}
   return Associate( i1, i2 );
}
 
// ----------------------------------------------------------------------------
 
template <class FI1, class FI2, class BP> inline
Association<FI1, FI2> FindNotEqual( FI1 i1, FI2 i2, FI2 j2, BP p ) noexcept
{
   for ( ; i2 != j2 && p( *i1, *i2 ); ++i1, ++i2 ) {}
   return Associate( i1, i2 );
}
 
// ----------------------------------------------------------------------------
 
template <class FI1, class FI2> inline
bool Equal( FI1 i1, FI2 i2, FI2 j2 ) noexcept
{
   return FindNotEqual( i1, i2, j2 ).second == j2;
}
 
// ----------------------------------------------------------------------------
 
template <class FI1, class FI2, class BP> inline
bool Equal( FI1 i1, FI2 i2, FI2 j2, BP p ) noexcept( noexcept( p ) )
{
   return FindNotEqual( i1, i2, j2, p ).second == j2;
}
 
// ----------------------------------------------------------------------------
 
template <class FI1, class FI2> inline
int Compare( FI1 i1, FI1 j1, FI2 i2, FI2 j2 ) noexcept
{
   for ( ; ; ++i1, ++i2 )
   {
      if ( i1 == j1 )
         return (i2 == j2) ? 0 : -1;
      if ( i2 == j2 )
         return +1;
      if ( *i1 < *i2 )
         return -1;
      if ( *i2 < *i1 )
         return +1;
   }
}
 
// ----------------------------------------------------------------------------
 
template <class FI1, class FI2, class BP> inline
int Compare( FI1 i1, FI1 j1, FI2 i2, FI2 j2, BP p ) noexcept( noexcept( p ) )
{
   for ( ; ; ++i1, ++i2 )
   {
      if ( i1 == j1 )
         return (i2 == j2) ? 0 : -1;
      if ( i2 == j2 )
         return +1;
      if ( p( *i1, *i2 ) )
         return -1;
      if ( p( *i2, *i1 ) )
         return +1;
   }
}
 
// ----------------------------------------------------------------------------
 
}  // pcl
 
#endif  // __PCL_Utility_h
 
// ----------------------------------------------------------------------------
// EOF pcl/Utility.h - Released 2024-06-18T15:48:54Z