Spec-Zone.ru › Eigen3

Eigen::IterativeSolverBase

шаблон<typename Derived>
класс Eigen::IterativeSolverBase< Derived >

Базовый класс для линейных итеративных решателей.

См. также
класс SimplicialCholesky, DiagonalPreconditioner, IdentityPreconditioner
Inheritance graph
шаблон<typename MatrixDerived >
Derived & analyzePattern (const EigenBase< MatrixDerived > &A)
шаблон<typename MatrixDerived >
Derived & compute (const EigenBase< MatrixDerived > &A)
RealScalar error () const
шаблон<typename MatrixDerived >
Derived & factorize (const EigenBase< MatrixDerived > &A)
ComputationInfo info () const
Index iterations () const
IterativeSolverBase ()
шаблон<typename MatrixDerived >
IterativeSolverBase (const EigenBase< MatrixDerived > &A)
Index maxIterations () const
Preconditioner & preconditioner ()
const Preconditioner & preconditioner () const
Derived & setMaxIterations (Index maxIters)
Derived & setTolerance (const RealScalar &tolerance)
шаблон<typename Rhs , typename Guess >
const SolveWithGuess< Derived, Rhs, Guess > solveWithGuess (const MatrixBase< Rhs > &b, const Guess &x0) const
RealScalar tolerance () const
- Публичные члены-функции, унаследованные от Eigen::SparseSolverBase< Derived >
шаблон<typename Rhs >
const Solve< Derived, Rhs > solve (const MatrixBase< Rhs > &b) const
шаблон<typename Rhs >
const Solve< Derived, Rhs > solve (const SparseMatrixBase< Rhs > &b) const
SparseSolverBase ()

IterativeSolverBase() [1/2]

шаблон<typename Derived >
Eigen::IterativeSolverBase< Derived >::IterativeSolverBase ( )
inline

Конструктор по умолчанию.

IterativeSolverBase() [2/2]

шаблон<typename Derived >
шаблон<typename MatrixDerived >
Eigen::IterativeSolverBase< Derived >::IterativeSolverBase ( const EigenBase< MatrixDerived > & A )
inlineexplicit

Инициализирует решатель матрицей A для дальнейшего Ax=b решения.

Этот конструктор — сокращение для конструктора по умолчанию, за которым следует вызов compute().

Предупреждение
этот класс хранит ссылку на матрицу A, а также некоторые предварительно вычисленные значения, зависящие от неё. Поэтому, если A изменится, этот класс станет недействительным. Вызовите compute(), чтобы обновить его новой матрицей A, или измените копию A.

analyzePattern()

шаблон<typename Derived >
шаблон<typename MatrixDerived >
Derived& Eigen::IterativeSolverBase< Derived >::analyzePattern ( const EigenBase< MatrixDerived > & A )
inline

Инициализирует итеративный решатель для шаблона разреженности матрицы A для дальнейшего решения Ax=b задач.

В настоящее время эта функция в основном вызывает analyzePattern в предварительном решателе. В будущем мы можем, например, реализовать переупорядочение столбцов для более быстрого произведения матрицы на вектор.

compute()

шаблон<typename Derived >
шаблон<typename MatrixDerived >
Derived& Eigen::IterativeSolverBase< Derived >::compute ( const EigenBase< MatrixDerived > & A )
inline

Инициализирует итеративный решатель матрицей A для дальнейшего решения Ax=b задач.

В настоящее время эта функция в основном инициализирует/вычисляет предварительный решатель. В будущем мы можем, например, реализовать переупорядочение столбцов для более быстрого произведения матрицы на вектор.

Предупреждение
этот класс хранит ссылку на матрицу A, а также некоторые предварительно вычисленные значения, зависящие от неё. Поэтому, если A изменится, этот класс станет недействительным. Вызовите compute(), чтобы обновить его новой матрицей A, или измените копию A.

error()

шаблон<typename Derived >
RealScalar Eigen::IterativeSolverBase< Derived >::error ( ) const
inline
Возвращает
достигнутую погрешность толерантности во время последнего решения. Это приближенная величина истинной относительной погрешности остатка |Ax-b|/|b|.

factorize()

шаблон<typename Derived >
шаблон<typename MatrixDerived >
Derived& Eigen::IterativeSolverBase< Derived >::factorize ( const EigenBase< MatrixDerived > & A )
inline

Инициализирует итерационный решатель значениями матрицы A для дальнейшего решения Ax=b задач.

В настоящее время эта функция в основном вызывает factorize для предварительного условия.

Предупреждение
Этот класс хранит ссылку на матрицу A, а также некоторые предварительно вычисленные значения, которые зависят от неё. Поэтому, если A изменится, этот класс станет недопустимым. Вызовите compute(), чтобы обновить его с новой матрицей A, или измените копию A.

info()

шаблон<typename Derived >
ComputationInfo Eigen::IterativeSolverBase< Derived >::info ( ) const
inline
Возвращает
Успех, если итерации сошлись, и NoConvergence в противном случае.

iterations()

шаблон<typename Derived >
Index Eigen::IterativeSolverBase< Derived >::iterations ( ) const
inline
Возвращает
количество итераций, выполненных во время последнего решения

maxIterations()

шаблон<typename Derived >
Index Eigen::IterativeSolverBase< Derived >::maxIterations ( ) const
inline
Возвращает
максимальное количество итераций. Это либо значение, заданное setMaxIterations, либо по умолчанию, вдвое больше числа столбцов матрицы.

preconditioner() [1/2]

шаблон<typename Derived >
Preconditioner& Eigen::IterativeSolverBase< Derived >::preconditioner ( )
inline
Возвращает
чтение-запись ссылки на предварительное условие для настройки.

preconditioner() [2/2]

шаблон<typename Derived >
const Preconditioner& Eigen::IterativeSolverBase< Derived >::preconditioner ( ) const
inline
Возвращает
только для чтения ссылку на предварительное условие.

setMaxIterations()

шаблон<typename Derived >
Derived& Eigen::IterativeSolverBase< Derived >::setMaxIterations ( Index maxIters )
inline

Устанавливает максимальное число итераций. По умолчанию - вдвое больше числа столбцов матрицы.

setTolerance()

шаблон<typename Derived >
Derived& Eigen::IterativeSolverBase< Derived >::setTolerance ( const RealScalar & tolerance )
inline

Устанавливает порог толерантности, используемый критериями остановки.

Это значение используется как верхняя граница относительной ошибки остатка: |Ax-b|/|b|. Значение по умолчанию равно точности машины, заданной NumTraits<Scalar>::epsilon()

solveWithGuess()

шаблон<typename Derived >
шаблон<typename Rhs , typename Guess >
const SolveWithGuess<Derived, Rhs, Guess> Eigen::IterativeSolverBase< Derived >::solveWithGuess ( const MatrixBase< Rhs > & b,
const Guess & x0
) const
inline
Возвращает
решение x от \( A x = b \) с использованием текущего разложения A и x0 в качестве начального решения.
См. также
solve(), compute()

tolerance()

шаблон<typename Derived >
RealScalar Eigen::IterativeSolverBase< Derived >::tolerance ( ) const
inline
Возвращает
порог толерантности, используемый критериями остановки.
См. также
setTolerance()

Документация по этому классу была сгенерирована из следующего файла:
  • IterativeSolverBase.h

© Eigen.
Licensed under the MPL2 License.
https://eigen.tuxfamily.org/dox/classEigen_1_1IterativeSolverBase.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API