dust3d/thirdparty/cgal/CGAL-4.13/include/CGAL/Lapack_svd.h

// Copyright (c) 2007  INRIA Sophia-Antipolis (France), INRIA Lorraine LORIA.
// All rights reserved.
//
// This file is part of CGAL (www.cgal.org); you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 3 of the License,
// or (at your option) any later version.
//
// Licensees holding a valid commercial license may use this file in
// accordance with the commercial license agreement provided with the software.
//
// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
//
// $URL$
// $Id$
// SPDX-License-Identifier: LGPL-3.0+
//
// Author(s)     : Marc Pouget and Frédéric Cazals

#ifndef CGAL_LAPACK_H
#define CGAL_LAPACK_H

#include <cstdlib>
#include <CGAL/auto_link/LAPACK.h>
#include <CGAL/assertions.h>

extern "C"
{
// taken from acml.h
void dgelss(int m, int n, int nrhs, 
            double *a, int lda, double *b, int ldb, double *sing,
            double rcond, int *irank, int *info);

void dgelss_(int *m, int *n, int *nrhs,
             double *a, int *lda, double *b, int *ldb, double *
             s, double *rcond, int *rank, double *work, int *lwork,
             int *info);
}

namespace CGAL {
namespace LAPACK {

inline
void dgelss(int *m, int *n, int *nrhs,
            double *a, int *lda, double *b, int *ldb, double *s,
            double *rcond, int *rank, double *work, int *lwork, int *info)
{
#ifdef CGAL_USE_F2C
  ::dgelss_(m, n, nrhs, a, lda, b, ldb, s, rcond, rank, work, lwork, info);
#else
  ::dgelss(*m, *n, *nrhs, a, *lda, b, *ldb, s, *rcond, rank,  info);
#endif
}

} // namespace LAPACK
} // namespace CGAL

namespace CGAL {

/// \ingroup PkgSolver
///
/// A matrix class to be used in the class `Lapack_svd`.
///
/// \cgalModels `SvdTraits::Matrix`
class Lapack_vector
{
  typedef double FT;

protected:
  FT* m_vector;
  size_t nb_elts;

public:
  /// Initializes all the elements of the vector to zero.
  Lapack_vector(size_t n)
  {
    m_vector = (FT*) std::calloc(n, sizeof(FT));
    nb_elts = n;
  }

  ~Lapack_vector() { free(m_vector); }

  /// Return the size of the vector.
  size_t size() { return nb_elts; }

  /// Return the vector as an array.
  const FT* vector() const { return m_vector;}

  /// Return the vector as an array.
  FT* vector() { return m_vector; }

  /// Return the `i`th entry, `i` from `0` to `size()-1`.
  FT operator()(size_t i) {return m_vector[i];}

  /// Set the `i`'th entry to `value`.
  void set(size_t i, const FT value) { m_vector[i] = value; }

private:
  /// Copy constructor and operator =() are not implemented.
  Lapack_vector(const Lapack_vector& toCopy);
  Lapack_vector& operator =(const Lapack_vector& toCopy);
};

/// \ingroup PkgSolver
///
/// In CLAPACK, matrices are one-dimensional arrays and elements are
/// column-major ordered. This class is a wrapper defining set and get
/// in the usual way with line and column indices.
///
/// \cgalModels `SvdTraits::Matrix`
class Lapack_matrix
{
  typedef double FT;

protected:
  FT* m_matrix;
  size_t nb_rows;
  size_t nb_columns;

public:
  /// Initializes all the elements of the matrix to zero.
  Lapack_matrix(size_t n1, size_t n2)
  {
    m_matrix = (FT*) std::calloc (n1*n2, sizeof(FT));
    nb_rows = n1;
    nb_columns = n2;
  }

  ~Lapack_matrix() { free(m_matrix); }

  /// Return the number of rows of the matrix.
  size_t number_of_rows() { return nb_rows; }
  /// Return the number of columns of the matrix.
  size_t number_of_columns() { return nb_columns; }

  /// Return the matrix as an array.
  const FT* matrix() const { return m_matrix; }
  /// Return the matrix as an array.
  FT* matrix() { return m_matrix; }

  /// Return the entry at row `i` and column `j`, `i` from `0` to `number_of_rows - 1`,
  /// `j` from `0` to `number_of_columns - 1`.
  FT operator()(size_t i, size_t j) { return m_matrix[j*nb_rows+i]; }

  /// Set the entry at row `i` and column `j` to `value`.
  void set(size_t i, size_t j, const FT value) { m_matrix[j*nb_rows+i] = value; }

private:
  /// Copy constructor and operator =() are not implemented.
  Lapack_matrix(const Lapack_matrix& toCopy);
  Lapack_matrix& operator =(const Lapack_matrix& toCopy);
}; 

/// \ingroup PkgSolver
///
/// This class is a wrapper to the singular value decomposition algorithm of LAPACK.
///
/// \cgalModels `SvdTraits`
class Lapack_svd
{
public:
  typedef double                                      FT;
  typedef Lapack_vector                               Vector;
  typedef Lapack_matrix                               Matrix;

  /// Solves the system \f$ MX=B\f$ (in the least square sense if \f$ M\f$ is not
  /// square) using a singular value decomposition. The solution is stored in \f$ B\f$.
  /// \return the condition number of \f$ M\f$
  static FT solve(Matrix& M, Vector& B);
};

inline
Lapack_svd::FT Lapack_svd::solve(Matrix& M, Vector& B)
{
  int m = static_cast<int>(M.number_of_rows()),
      n = static_cast<int>(M.number_of_columns()),
      nrhs = 1,
      lda = m,
      ldb = m,
      rank,
      lwork = 5*m,
      info;

  // c style
  FT* sing_values = (FT*) std::malloc(n*sizeof(FT));
  FT* work = (FT*) std::malloc(lwork*sizeof(FT));

  FT rcond = -1;

  LAPACK::dgelss(&m, &n, &nrhs, M.matrix(), &lda, B.vector(), &ldb, sing_values,
                 &rcond, &rank, work, &lwork, &info);
  CGAL_assertion(info==0);

  FT cond_nb = sing_values[0]/sing_values[n-1];

  // clean up
  free(sing_values);
  free(work);

  return cond_nb;
}

} // namespace CGAL

#endif // CGAL_LAPACK_H