Indirect.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/Indirect.h - Released 2024-01-13T15:47:58Z
// ----------------------------------------------------------------------------
// 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_Indirect_h
#define __PCL_Indirect_h
 
 
#include <pcl/Defs.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
template <class TPtr, class UF>
class PCL_CLASS IndirectUnaryFunction
{
public:
 
   IndirectUnaryFunction( UF f )
      : m_function( f )
   {
   }
 
   IndirectUnaryFunction( IndirectUnaryFunction<TPtr, UF>& ) = default;
 
   void operator()( TPtr ptr ) const
   {
      if ( ptr != nullptr )
         m_function( *ptr );
   }
 
private:
 
   UF m_function;
};
 
// ----------------------------------------------------------------------------
 
template <class T1Ptr, class T2Ptr, class BF>
class PCL_CLASS IndirectBinaryFunction
{
public:
 
   IndirectBinaryFunction( BF f )
      : m_function( f )
   {
   }
 
   IndirectBinaryFunction( const IndirectBinaryFunction<T1Ptr, T2Ptr, BF>& ) = default;
 
   void operator()( T1Ptr ptr1, T2Ptr ptr2 ) const
   {
      if ( ptr1 != nullptr )
         if ( ptr2 != nullptr )
            m_function( *ptr1, *ptr2 );
   }
 
private:
 
   BF m_function;
};
 
// ----------------------------------------------------------------------------
 
template <class TPtr, class UP>
class PCL_CLASS IndirectUnaryPredicate
{
public:
 
   IndirectUnaryPredicate( UP p )
      : m_predicate( p )
   {
   }
 
   IndirectUnaryPredicate( const IndirectUnaryPredicate<TPtr, UP>& ) = default;
 
   bool operator()( TPtr ptr ) const
   {
      return ptr != nullptr && m_predicate( *ptr );
   }
 
private:
 
   UP m_predicate;
};
 
// ----------------------------------------------------------------------------
 
template <class T1Ptr, class T2Ptr, class BP>
class PCL_CLASS IndirectBinaryPredicate
{
public:
 
   IndirectBinaryPredicate( BP p )
      : m_predicate( p )
   {
   }
 
   IndirectBinaryPredicate( const IndirectBinaryPredicate<T1Ptr, T2Ptr, BP>& ) = default;
 
   bool operator()( T1Ptr ptr1, T2Ptr ptr2 ) const
   {
      return ptr1 != nullptr && ptr2 != nullptr && m_predicate( *ptr1, *ptr2 );
   }
 
private:
 
   BP m_predicate;
};
 
// ----------------------------------------------------------------------------
 
template <class TPtr>
struct PCL_CLASS IndirectEqual
{
   bool operator ()( TPtr ptr1, TPtr ptr2 ) const
   {
      return (ptr1 != nullptr && ptr2 != nullptr) ? *ptr1 == *ptr2 : ptr1 == ptr2;
   }
};
 
// ----------------------------------------------------------------------------
 
template <class TPtr>
struct PCL_CLASS IndirectLess
{
   bool operator ()( TPtr ptr1, TPtr ptr2 ) const
   {
      // When sorting a list, make sure all null pointers are packed at the bottom.
      return ptr1 != nullptr && (ptr2 == nullptr || *ptr1 < *ptr2);
   }
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif  // __PCL_Indirect_h
 
// ----------------------------------------------------------------------------
// EOF pcl/Indirect.h - Released 2024-01-13T15:47:58Z