qgsmatrixsolver.h

Go to the documentation of this file.

/***************************************************************************
    qgsmatrixsolver.h
    ----------------------
    begin                : August 2026
    copyright            : (C) 2026 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QObject>
 
#ifndef QGSMATRIXSOLVER_H
#define QGSMATRIXSOLVER_H

class CORE_EXPORT QgsMatrixSolver
{
  public:
    static bool isAvailable();

    explicit QgsMatrixSolver( int maximumDimension );
 
    ~QgsMatrixSolver();
 
#ifndef SIP_RUN
    QgsMatrixSolver( const QgsMatrixSolver & ) = delete;
    QgsMatrixSolver &operator=( const QgsMatrixSolver & ) = delete;
#endif

    int maximumDimension() const;
 
#ifndef SIP_RUN
    void setValue( int row, int column, double value );
#else
    // clang-format off

    void setValue( int row, int column, double value );
  % MethodCode
    const int maximumDimension = sipCpp->maximumDimension();
    if ( !QgsMatrixSolver::isAvailable() )
    {
      PyErr_SetString( sipException_QgsNotSupportedException, "QgsMatrixSolver requires a QGIS build with GSL support enabled" );
      sipIsErr = 1;
    }
    else if ( a0 < 0 || a0 >= maximumDimension  )
    {
      PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
      sipIsErr = 1;
    }
    else if ( a1 < 0 || a1 >= maximumDimension )
    {
      PyErr_SetString( PyExc_IndexError, QByteArray::number( a1 ) );
      sipIsErr = 1;
    }
    else
    {
      sipCpp->setValue( a0, a1, a2 );
    }
    % End
// clang-format on
#endif
 
#ifndef SIP_RUN
    void setRightHandSide( int row, double value );
#else
      // clang-format off

      void setRightHandSide( int row, double value ) SIP_THROW( QgsNotSupportedException );
      % MethodCode
      const int maximumDimension = sipCpp->maximumDimension();
      if ( !QgsMatrixSolver::isAvailable() )
      {
        PyErr_SetString( sipException_QgsNotSupportedException, "QgsMatrixSolver requires a QGIS build with GSL support enabled" );
        sipIsErr = 1;
      }
      else if ( a0 < 0 || a0 >= maximumDimension )
      {
        PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
        sipIsErr = 1;
      }
      else
      {
        sipCpp->setRightHandSide( a0, a1 );
      }
      % End
    // clang-format on
#endif

    bool solve( int dimension, QVector<double> &result SIP_OUT, Qgis::LinearMatrixMethod method = Qgis::LinearMatrixMethod::Lu ) SIP_THROW( QgsNotSupportedException, QgsInvalidArgumentException );
 
  private:
#ifdef SIP_RUN
    QgsMatrixSolver( const QgsMatrixSolver & );
#endif
 
    bool solveLu( int dimension, QVector<double> &result, bool retainOriginalMatrices );
    bool solveSvd( int dimension, QVector<double> &result, bool retainOriginalMatrices );
 
    struct GslData;
    std::unique_ptr<GslData> mData;
};
 
#endif // QGSMATRIXSOLVER_H