HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME::math::pcg::JacobiPreconditioner< MatrixType > Class Template Reference

Diagonal preconditioner. More...

#include <ConjGradient.h>

+ Inheritance diagram for openvdb::OPENVDB_VERSION_NAME::math::pcg::JacobiPreconditioner< MatrixType >:

Public Types

using ValueType = typename MatrixType::ValueType
 
using BaseType = Preconditioner< ValueType >
 
using VectorType = Vector< ValueType >
 
using Ptr = SharedPtr< JacobiPreconditioner >
 
- Public Types inherited from openvdb::OPENVDB_VERSION_NAME::math::pcg::Preconditioner< MatrixType::ValueType >
using ValueType = T
 
using Ptr = SharedPtr< Preconditioner >
 

Public Member Functions

 JacobiPreconditioner (const MatrixType &A)
 
 ~JacobiPreconditioner () override=default
 
void apply (const Vector< ValueType > &r, Vector< ValueType > &z) override
 
bool isFinite () const
 Return true if all values along the diagonal are finite. More...
 
- Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::math::pcg::Preconditioner< MatrixType::ValueType >
 Preconditioner (const SparseStencilMatrix< T, STENCIL_SIZE > &)
 
virtual ~Preconditioner ()=default
 
virtual bool isValid () const
 
virtual void apply (const Vector< T > &r, Vector< T > &z)=0
 Apply this preconditioner to a residue vector: z = M−1r More...
 

Detailed Description

template<typename MatrixType>
class openvdb::OPENVDB_VERSION_NAME::math::pcg::JacobiPreconditioner< MatrixType >

Diagonal preconditioner.

Definition at line 69 of file ConjGradient.h.

Member Typedef Documentation

Definition at line 1315 of file ConjGradient.h.

Definition at line 1317 of file ConjGradient.h.

template<typename MatrixType >
using openvdb::OPENVDB_VERSION_NAME::math::pcg::JacobiPreconditioner< MatrixType >::ValueType = typename MatrixType::ValueType

Definition at line 1314 of file ConjGradient.h.

template<typename MatrixType >
using openvdb::OPENVDB_VERSION_NAME::math::pcg::JacobiPreconditioner< MatrixType >::VectorType = Vector<ValueType>

Definition at line 1316 of file ConjGradient.h.

Constructor & Destructor Documentation

template<typename MatrixType >
openvdb::OPENVDB_VERSION_NAME::math::pcg::JacobiPreconditioner< MatrixType >::JacobiPreconditioner ( const MatrixType &  A)
inline

Definition at line 1319 of file ConjGradient.h.

template<typename MatrixType >
openvdb::OPENVDB_VERSION_NAME::math::pcg::JacobiPreconditioner< MatrixType >::~JacobiPreconditioner ( )
overridedefault

Member Function Documentation

template<typename MatrixType >
void openvdb::OPENVDB_VERSION_NAME::math::pcg::JacobiPreconditioner< MatrixType >::apply ( const Vector< ValueType > &  r,
Vector< ValueType > &  z 
)
inlineoverride

Definition at line 1327 of file ConjGradient.h.

template<typename MatrixType >
bool openvdb::OPENVDB_VERSION_NAME::math::pcg::JacobiPreconditioner< MatrixType >::isFinite ( ) const
inline

Return true if all values along the diagonal are finite.

Definition at line 1338 of file ConjGradient.h.


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