HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME::tools::CheckFinite< GridT, TreeIterT > Struct Template Reference

Checks for both NaN and inf values, i.e. any value that is not finite. More...

#include <Diagnostics.h>

Public Types

using ElementType = typename VecTraits< typename GridT::ValueType >::ElementType
 
using TileIterT = TreeIterT
 
using VoxelIterT = typename tree::IterTraits< typename TreeIterT::NodeT, typename TreeIterT::ValueIterT >::template NodeConverter< typename GridT::TreeType::LeafNodeType >::Type
 

Public Member Functions

 CheckFinite ()
 Default constructor. More...
 
bool operator() (const ElementType &v) const
 Return true if the value is NOT finite, i.e. it's NaN or infinite. More...
 
template<typename T >
std::enable_if< VecTraits< T >
::IsVec, bool >::type 
operator() (const T &v) const
 Return true if any of the vector components are NaN or infinite. More...
 
bool operator() (const TreeIterT &iter) const
 Return true if the tile at the iterator location is NaN or infinite. More...
 
bool operator() (const VoxelIterT &iter) const
 Return true if the tile at the iterator location is NaN or infinite. More...
 
std::string str () const
 Return a string describing a failed check. More...
 

Detailed Description

template<typename GridT, typename TreeIterT = typename GridT::ValueOnCIter>
struct openvdb::OPENVDB_VERSION_NAME::tools::CheckFinite< GridT, TreeIterT >

Checks for both NaN and inf values, i.e. any value that is not finite.

Definition at line 212 of file Diagnostics.h.

Member Typedef Documentation

template<typename GridT, typename TreeIterT = typename GridT::ValueOnCIter>
using openvdb::OPENVDB_VERSION_NAME::tools::CheckFinite< GridT, TreeIterT >::ElementType = typename VecTraits<typename GridT::ValueType>::ElementType

Definition at line 214 of file Diagnostics.h.

template<typename GridT, typename TreeIterT = typename GridT::ValueOnCIter>
using openvdb::OPENVDB_VERSION_NAME::tools::CheckFinite< GridT, TreeIterT >::TileIterT = TreeIterT

Definition at line 215 of file Diagnostics.h.

template<typename GridT, typename TreeIterT = typename GridT::ValueOnCIter>
using openvdb::OPENVDB_VERSION_NAME::tools::CheckFinite< GridT, TreeIterT >::VoxelIterT = typename tree::IterTraits<typename TreeIterT::NodeT, typename TreeIterT::ValueIterT> ::template NodeConverter< typename GridT::TreeType::LeafNodeType>::Type

Definition at line 218 of file Diagnostics.h.

Constructor & Destructor Documentation

template<typename GridT, typename TreeIterT = typename GridT::ValueOnCIter>
openvdb::OPENVDB_VERSION_NAME::tools::CheckFinite< GridT, TreeIterT >::CheckFinite ( )
inline

Default constructor.

Definition at line 221 of file Diagnostics.h.

Member Function Documentation

template<typename GridT, typename TreeIterT = typename GridT::ValueOnCIter>
bool openvdb::OPENVDB_VERSION_NAME::tools::CheckFinite< GridT, TreeIterT >::operator() ( const ElementType v) const
inline

Return true if the value is NOT finite, i.e. it's NaN or infinite.

Definition at line 224 of file Diagnostics.h.

template<typename GridT, typename TreeIterT = typename GridT::ValueOnCIter>
template<typename T >
std::enable_if<VecTraits<T>::IsVec, bool>::type openvdb::OPENVDB_VERSION_NAME::tools::CheckFinite< GridT, TreeIterT >::operator() ( const T &  v) const
inline

Return true if any of the vector components are NaN or infinite.

Definition at line 229 of file Diagnostics.h.

template<typename GridT, typename TreeIterT = typename GridT::ValueOnCIter>
bool openvdb::OPENVDB_VERSION_NAME::tools::CheckFinite< GridT, TreeIterT >::operator() ( const TreeIterT &  iter) const
inline

Return true if the tile at the iterator location is NaN or infinite.

Definition at line 235 of file Diagnostics.h.

template<typename GridT, typename TreeIterT = typename GridT::ValueOnCIter>
bool openvdb::OPENVDB_VERSION_NAME::tools::CheckFinite< GridT, TreeIterT >::operator() ( const VoxelIterT iter) const
inline

Return true if the tile at the iterator location is NaN or infinite.

Definition at line 238 of file Diagnostics.h.

template<typename GridT, typename TreeIterT = typename GridT::ValueOnCIter>
std::string openvdb::OPENVDB_VERSION_NAME::tools::CheckFinite< GridT, TreeIterT >::str ( ) const
inline

Return a string describing a failed check.

Definition at line 241 of file Diagnostics.h.


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