SolverBase.h

// This file is part of Eigen, a lightweight C++ template library
// for linear algebra.
//
// Copyright (C) 2015 Gael Guennebaud <gael.guennebaud@inria.fr>
//
// This Source Code Form is subject to the terms of the Mozilla
// Public License v. 2.0. If a copy of the MPL was not distributed
// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// SPDX-License-Identifier: MPL-2.0
 
#ifndef EIGEN_SOLVERBASE_H
#define EIGEN_SOLVERBASE_H
 
// IWYU pragma: private
#include "./InternalHeaderCheck.h"
 
namespace Eigen {
 
namespace internal {
 
template <typename Derived>
struct solve_assertion {
  template <bool Transpose_, typename Rhs>
  static void run(const Derived& solver, const Rhs& b) {
    solver.template _check_solve_assertion<Transpose_>(b);
  }
};
 
template <typename Derived>
struct solve_assertion<Transpose<Derived>> {
  using type = Transpose<Derived>;
 
  template <bool Transpose_, typename Rhs>
  static void run(const type& transpose, const Rhs& b) {
    internal::solve_assertion<internal::remove_all_t<Derived>>::template run<true>(transpose.nestedExpression(), b);
  }
};
 
template <typename Scalar, typename Derived>
struct solve_assertion<CwiseUnaryOp<Eigen::internal::scalar_conjugate_op<Scalar>, const Transpose<Derived>>> {
  using type = CwiseUnaryOp<Eigen::internal::scalar_conjugate_op<Scalar>, const Transpose<Derived>>;
 
  template <bool Transpose_, typename Rhs>
  static void run(const type& adjoint, const Rhs& b) {
    internal::solve_assertion<internal::remove_all_t<Transpose<Derived>>>::template run<true>(
        adjoint.nestedExpression(), b);
  }
};
}  // end namespace internal

template <typename Derived>
class SolverBase : public EigenBase<Derived> {
 public:
  using Base = EigenBase<Derived>;
  using Scalar = typename internal::traits<Derived>::Scalar;
  using CoeffReturnType = Scalar;
 
  template <typename Derived_>
  friend struct internal::solve_assertion;
 
  ComputationInfo info() const {
    // CRTP static dispatch: Calls the 'info()' method on the derived class.
    // Derived must implement 'ComputationInfo info() const'.
    // If not implemented, name lookup falls back to this base method, causing
    // infinite recursion (detectable by -Winfinite-recursion).
    return derived().info();
  }
 
  enum {
    RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime,
    ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime,
    SizeAtCompileTime = (internal::size_of_xpr_at_compile_time<Derived>::value),
    MaxRowsAtCompileTime = internal::traits<Derived>::MaxRowsAtCompileTime,
    MaxColsAtCompileTime = internal::traits<Derived>::MaxColsAtCompileTime,
    MaxSizeAtCompileTime = internal::size_at_compile_time(internal::traits<Derived>::MaxRowsAtCompileTime,
                                                          internal::traits<Derived>::MaxColsAtCompileTime),
    IsVectorAtCompileTime =
        internal::traits<Derived>::MaxRowsAtCompileTime == 1 || internal::traits<Derived>::MaxColsAtCompileTime == 1,
    NumDimensions = int(MaxSizeAtCompileTime) == 1 ? 0
                    : bool(IsVectorAtCompileTime)  ? 1
                                                   : 2
  };

  SolverBase() = default;
 
  using Base::derived;

  template <typename Rhs>
  inline Solve<Derived, Rhs> solve(const MatrixBase<Rhs>& b) const {
    internal::solve_assertion<internal::remove_all_t<Derived>>::template run<false>(derived(), b);
    return Solve<Derived, Rhs>(derived(), b.derived());
  }

  using ConstTransposeReturnType = Transpose<const Derived>;
  inline const ConstTransposeReturnType transpose() const { return ConstTransposeReturnType(derived()); }

  using AdjointReturnType =
      std::conditional_t<NumTraits<Scalar>::IsComplex,
                         CwiseUnaryOp<internal::scalar_conjugate_op<Scalar>, const ConstTransposeReturnType>,
                         const ConstTransposeReturnType>;
  inline const AdjointReturnType adjoint() const { return AdjointReturnType(derived().transpose()); }
 
 protected:
  template <bool Transpose_, typename Rhs>
  void _check_solve_assertion(const Rhs& b) const {
    EIGEN_ONLY_USED_FOR_DEBUG(b);
    eigen_assert(derived().m_isInitialized && "Solver is not initialized.");
    eigen_assert((Transpose_ ? derived().cols() : derived().rows()) == b.rows() &&
                 "SolverBase::solve(): invalid number of rows of the right hand side matrix b");
  }
};
 
namespace internal {
 
template <typename Derived>
struct generic_xpr_base<Derived, MatrixXpr, SolverStorage> {
  using type = SolverBase<Derived>;
};
 
}  // end namespace internal
 
}  // end namespace Eigen
 
#endif  // EIGEN_SOLVERBASE_H