Algebra.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/Algebra.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_Algebra_h
#define __PCL_Algebra_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/Matrix.h>
#include <pcl/Vector.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
void PCL_FUNC InPlaceGaussJordan( Matrix& A, Matrix& B );
 
void PCL_FUNC InPlaceGaussJordan( FMatrix& A, FMatrix& B );
 
template <typename T>
class PCL_CLASS GenericGaussJordan
{
public:
 
   using matrix = GenericMatrix<T>;
 
   using matrix_element = typename matrix::element;
 
   matrix Ai;  // Inverse matrix
 
   matrix X;   // Solution vectors
 
   GenericGaussJordan( const matrix& A, const matrix& B )
   {
      Ai = A;
      X = B;
      InPlaceGaussJordan( Ai, X );
   }
};
 
class PCL_CLASS GaussJordan : public GenericGaussJordan<double>
{
public:
 
   using algorithm_implementation = GenericGaussJordan<double>;
 
   using matrix = algorithm_implementation::matrix;
 
   using matrix_element = matrix::element;
 
   GaussJordan( const Matrix& A, const Matrix& B )
      : algorithm_implementation( A, B )
   {
   }
};
 
class PCL_CLASS FGaussJordan : public GenericGaussJordan<float>
{
public:
 
   using algorithm_implementation = GenericGaussJordan<float>;
 
   using matrix = algorithm_implementation::matrix;
 
   using matrix_element = matrix::element;
 
   FGaussJordan( const FMatrix& A, const FMatrix& B )
      : algorithm_implementation( A, B )
   {
   }
};
 
// ----------------------------------------------------------------------------
 
void PCL_FUNC InPlaceSVDImplementation( Matrix&, Vector&, Matrix& );
void PCL_FUNC InPlaceSVDImplementation( FMatrix&, FVector&, FMatrix& );
 
template <typename T>
class PCL_CLASS GenericInPlaceSVD
{
public:
 
   using vector = GenericVector<T>;
 
   using matrix = GenericMatrix<T>;
 
   using vector_component = typename vector::component;
 
   using matrix_element = typename matrix::element;
 
   vector W;
 
   matrix V;
 
   GenericInPlaceSVD( matrix& A )
      : W( A.Columns() )
      , V( A.Columns(), A.Columns() )
   {
      InPlaceSVDImplementation( A, W, V );
   }
 
   int IndexOfLargestSingularValue() const
   {
      return W.IndexOfLargestComponent();
   }
 
   int IndexOfSmallestSingularValue() const
   {
      return W.IndexOfSmallestNonzeroComponent();
   }
};
 
class PCL_CLASS InPlaceSVD : public GenericInPlaceSVD<double>
{
public:
 
   using algorithm_implementation = GenericInPlaceSVD<double>;
 
   using vector = algorithm_implementation::vector;
 
   using matrix = algorithm_implementation::matrix;
 
   using vector_component = vector::component;
 
   using matrix_element = matrix::element;
 
   InPlaceSVD( matrix& A )
      : algorithm_implementation( A )
   {
   }
};
 
class PCL_CLASS FInPlaceSVD : public GenericInPlaceSVD<float>
{
public:
 
   using algorithm_implementation = GenericInPlaceSVD<float>;
 
   using vector = algorithm_implementation::vector;
 
   using matrix = algorithm_implementation::matrix;
 
   using vector_component = vector::component;
 
   using matrix_element = matrix::element;
 
   FInPlaceSVD( matrix& A )
      : algorithm_implementation( A )
   {
   }
};
 
template <typename T>
class PCL_CLASS GenericSVD
{
public:
 
   using algorithm_implementation = GenericInPlaceSVD<T>;
 
   using vector = typename algorithm_implementation::vector;
 
   using matrix = typename algorithm_implementation::matrix;
 
   using vector_component = typename vector::component;
 
   using matrix_element = typename matrix::element;
 
   matrix U;
 
   vector W;
 
   matrix V;
 
   GenericSVD( const matrix& A )
   {
      U = A;
      algorithm_implementation svd( U );
      W = svd.W;
      V = svd.V;
   }
 
   int IndexOfLargestSingularValue() const
   {
      return W.IndexOfLargestComponent();
   }
 
   int IndexOfSmallestSingularValue() const
   {
      return W.IndexOfSmallestNonzeroComponent();
   }
};
 
class PCL_CLASS SVD : public GenericSVD<double>
{
public:
 
   using algorithm_implementation = GenericSVD<double>;
 
   using vector = algorithm_implementation::vector;
 
   using matrix = algorithm_implementation::matrix;
 
   using vector_component = vector::component;
 
   using matrix_element = matrix::element;
 
   SVD( const matrix& A )
      : algorithm_implementation( A )
   {
   }
};
 
class PCL_CLASS FSVD : public GenericSVD<float>
{
public:
 
   using algorithm_implementation = GenericSVD<float>;
 
   using vector = algorithm_implementation::vector;
 
   using matrix = algorithm_implementation::matrix;
 
   using vector_component = vector::component;
 
   using matrix_element = matrix::element;
 
   FSVD( const matrix& A )
      : algorithm_implementation( A )
   {
   }
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_Algebra_h
 
// ----------------------------------------------------------------------------
// EOF pcl/Algebra.h - Released 2024-06-18T15:48:54Z