matrix_inverse.h

/* Copyright (c) 2022 PaddlePaddle Authors. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. */

#pragma once

#include <string>
#include "Eigen/Core"
#include "Eigen/LU"

#include "paddle/phi/backends/all_context.h"
#include "paddle/phi/core/dense_tensor.h"
#include "paddle/phi/core/enforce.h"

namespace phi {
namespace funcs {

template <typename Context, typename T>
void ComputeInverseEigen(const Context& dev_ctx,
                         const DenseTensor& a,
                         DenseTensor* a_inv) {
  using Matrix =
      Eigen::Matrix<T, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>;
  using EigenMatrixMap = Eigen::Map<Matrix>;
  using ConstEigenMatrixMap = Eigen::Map<const Matrix>;
  const auto& mat_dims = a.dims();
  const int rank = mat_dims.size();
  int n = mat_dims[rank - 1];
  int batch_size = rank > 2 ? a.numel() / (n * n) : 1;

  const T* a_ptr = a.data<T>();
  T* a_inv_ptr = dev_ctx.template Alloc<T>(a_inv);

  for (int i = 0; i < batch_size; ++i) {
    ConstEigenMatrixMap mat(a_ptr + i * n * n, n, n);
    EigenMatrixMap mat_inv(a_inv_ptr + i * n * n, n, n);
    Eigen::PartialPivLU<Matrix> lu;
    lu.compute(mat);

    const T min_abs_pivot = lu.matrixLU().diagonal().cwiseAbs().minCoeff();
    PADDLE_ENFORCE_GT(min_abs_pivot,
                      static_cast<T>(0),
                      errors::InvalidArgument("Input is not invertible."));
    mat_inv.noalias() = lu.inverse();
  }
}

template <typename Context, typename T>
class MatrixInverseFunctor {
 public:
  void operator()(const Context& dev_ctx,
                  const DenseTensor& a,
                  DenseTensor* a_inv);
};

}  // namespace funcs
}  // namespace phi