WPILibC++ 2023.4.3
Eigen::internal::matrix_sqrt_compute< MatrixType, IsComplex > Struct Template Reference

Helper struct for computing matrix square roots of general matrices. More...

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/unsupported/Eigen/src/MatrixFunctions/MatrixSquareRoot.h>

Static Public Member Functions

template<typename ResultType >
static void run (const MatrixType &arg, ResultType &result)
 Compute the matrix square root. More...
 

Detailed Description

template<typename MatrixType, int IsComplex = NumTraits<typename internal::traits<MatrixType>::Scalar>::IsComplex>
struct Eigen::internal::matrix_sqrt_compute< MatrixType, IsComplex >

Helper struct for computing matrix square roots of general matrices.

Template Parameters
MatrixTypetype of the argument of the matrix square root, expected to be an instantiation of the Matrix class template.
See also
MatrixSquareRootTriangular, MatrixSquareRootQuasiTriangular, MatrixBase::sqrt()

Member Function Documentation

◆ run()

template<typename MatrixType , int IsComplex = NumTraits<typename internal::traits<MatrixType>::Scalar>::IsComplex>
template<typename ResultType >
static void Eigen::internal::matrix_sqrt_compute< MatrixType, IsComplex >::run ( const MatrixType &  arg,
ResultType &  result 
)
static

Compute the matrix square root.

Parameters
[in]argmatrix whose square root is to be computed.
[out]resultsquare root of arg.

See MatrixBase::sqrt() for details on how this computation is implemented.


The documentation for this struct was generated from the following file: