MultiVector.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/MultiVector.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_MultiVector_h
#define __PCL_MultiVector_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/Array.h>
#include <pcl/Vector.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
template <typename T>
class PCL_CLASS GenericMultiVector : public Array<GenericVector<T> >
{
public:
 
   using multivector_implementation = Array<GenericVector<T> >;
 
   using vector = GenericVector<T>;
 
   using scalar = typename vector::scalar;
 
   using component = typename vector::component;
 
   using iterator = typename multivector_implementation::iterator;
 
   using const_iterator = typename multivector_implementation::const_iterator;
 
   using vector_iterator = typename vector::iterator;
 
   using const_vector_iterator = typename vector::const_iterator;
 
   GenericMultiVector() = default;
 
   GenericMultiVector( size_type length )
      : multivector_implementation( length )
   {
   }
 
   GenericMultiVector( size_type length, int vectorLength )
      : multivector_implementation( length )
   {
      for ( iterator i = this->Begin(), j = this->End(); i < j; ++i )
         *i = vector( vectorLength );
   }
 
   GenericMultiVector( const scalar& value, size_type length, int vectorLength )
      : multivector_implementation( length )
   {
      for ( iterator i = this->Begin(), j = this->End(); i < j; ++i )
         *i = vector( value, vectorLength );
   }
 
   GenericMultiVector( const vector& v0, const vector& v1 )
      : GenericMultiVector( size_type( 2 ) )
   {
      iterator i = this->Begin();
      *i = v0; *++i = v1;
   }
 
   GenericMultiVector( const vector& v0, const vector& v1, const vector& v2 )
      : GenericMultiVector( size_type( 3 ) )
   {
      iterator i = this->Begin();
      *i = v0; *++i = v1; *++i = v2;
   }
 
   GenericMultiVector( const vector& v0, const vector& v1, const vector& v2, const vector& v3 )
      : GenericMultiVector( size_type( 4 ) )
   {
      iterator i = this->Begin();
      *i = v0; *++i = v1; *++i = v2; *++i = v3;
   }
 
   GenericMultiVector( const GenericMultiVector& ) = default;
 
   GenericMultiVector( GenericMultiVector&& ) = default;
 
   ~GenericMultiVector()
   {
   }
 
   GenericMultiVector& operator =( const GenericMultiVector& ) = default;
 
   GenericMultiVector& operator =( GenericMultiVector&& ) = default;
 
   GenericMultiVector& operator =( const scalar& x )
   {
      for ( iterator i = this->Begin(), j = this->End(); i < j; ++i )
         *i = x;
      return *this;
   }
 
   GenericMultiVector& operator +=( const scalar& x )
   {
      for ( iterator i = this->Begin(), j = this->End(); i < j; ++i )
         *i += x;
      return *this;
   }
 
   GenericMultiVector& operator -=( const scalar& x )
   {
      for ( iterator i = this->Begin(), j = this->End(); i < j; ++i )
         *i -= x;
      return *this;
   }
 
   GenericMultiVector& operator *=( const scalar& x )
   {
      for ( iterator i = this->Begin(), j = this->End(); i < j; ++i )
         *i *= x;
      return *this;
   }
 
   GenericMultiVector& operator /=( const scalar& x )
   {
      for ( iterator i = this->Begin(), j = this->End(); i < j; ++i )
         *i /= x;
      return *this;
   }
 
   double Sum() const
   {
      double s = 0;
      for ( const_iterator i = this->Begin(), j = this->End(); i < j; ++i )
         s += i->Sum();
      return s;
   }
 
   double StableSum() const
   {
      DVector s( this->Length() );
      size_type n = 0;
      for ( const_iterator i = this->Begin(), j = this->End(); i < j; ++i )
         s[n++] = i->StableSum();
      return s.StableSum();
   }
 
#ifndef __PCL_NO_VECTOR_STATISTICS
 
   component MinComponent() const
   {
      if ( !this->IsEmpty() )
      {
         component min = this->Begin()->MinComponent();
         for ( const_iterator i = this->Begin(), j = this->End(); ++i < j; )
            min = pcl::Min( min, i->MinComponent() );
         return min;
      }
      return component( 0 );
   }
 
   component MaxComponent() const
   {
      if ( !this->IsEmpty() )
      {
         component max = this->Begin()->MaxComponent();
         for ( const_iterator i = this->Begin(), j = this->End(); ++i < j; )
            max = pcl::Max( max, i->MaxComponent() );
         return max;
      }
      return component( 0 );
   }
 
#endif   // !__PCL_NO_VECTOR_STATISTICS
};
 
// ----------------------------------------------------------------------------
 
#ifndef __PCL_NO_MULTIVECTOR_INSTANTIATE
 
using DMultiVector = GenericMultiVector<double>;
 
using FMultiVector = GenericMultiVector<float>;
 
using IMultiVector = GenericMultiVector<int>;
 
using MultiVector = DMultiVector;
 
#endif   // !__PCL_NO_MULTIVECTOR_INSTANTIATE
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_MultiVector_h
 
// ----------------------------------------------------------------------------
// EOF pcl/MultiVector.h - Released 2024-01-13T15:47:58Z