Pred< IterType, PredType > Struct Template Reference

The actual predicate is held as a template parameter here. More...

#include <variant_filter_iterator.h>

Inheritance diagram for Pred< IterType, PredType >:

Public Member Functions
	Pred (const PredType &v)
	Constructor. More...
virtual	~Pred ()
	Destructor. More...
virtual PredBase *	clone () const override
virtual PredBase::const_PredBase *	const_clone () const override
	The redefinition of the const_clone function for the Pred class. More...
virtual bool	operator() (const IterBase *in) const override
	Re-implementation of op() More...

Public Attributes
PredType	pred_data
	This is the predicate passed in by the user. More...

Detailed Description

template<typename IterType, typename PredType>
struct Pred< IterType, PredType >

The actual predicate is held as a template parameter here.

There are two template arguments here, one for the actual type of the predicate and one for the iterator type.

Definition at line 248 of file variant_filter_iterator.h.

Constructor & Destructor Documentation

Pred()

template<typename IterType, typename PredType>

Pred< IterType, PredType >::Pred

(

const PredType &

v

)

Constructor.

Definition at line 253 of file variant_filter_iterator.h.

                              :
      pred_data (v) {}

~Pred()

template<typename IterType, typename PredType>

virtual Pred< IterType, PredType >::~Pred ( )

virtual

Destructor.

Definition at line 259 of file variant_filter_iterator.h.

{}

Member Function Documentation

clone()

template<typename IterType, typename PredType>

virtual PredBase* Pred< IterType, PredType >::clone ( ) const

overridevirtual

Returns

A copy of this object as a pointer to the base class.

Definition at line 264 of file variant_filter_iterator.h.

    {
#ifdef __SUNPRO_CC
      variant_filter_iterator::Pred<IterType,PredType> * copy =
        new variant_filter_iterator::Pred<IterType,PredType>(pred_data);
#else
      Pred<IterType,PredType> * copy =
        new Pred<IterType,PredType>(pred_data);
#endif

      return copy;
    }

const_clone()

template<typename IterType, typename PredType>

virtual PredBase::const_PredBase* Pred< IterType, PredType >::const_clone ( ) const

overridevirtual

The redefinition of the const_clone function for the Pred class.

Important typedef for const_iterators.

Definition at line 281 of file variant_filter_iterator.h.

    {
      //      typedef typename variant_filter_iterator<Predicate, Type, const Type &, const Type *>::template Pred<IterType, PredType> const_Pred;
      typedef typename variant_filter_iterator<Predicate, Type const, Type const &,  Type const *>::template Pred<IterType, PredType> const_Pred;


      typename PredBase::const_PredBase * copy =
        new const_Pred(pred_data);

      return copy;
    }

operator()()

template<typename IterType, typename PredType>

virtual bool Pred< IterType, PredType >::operator() ( const IterBase *  in ) const

overridevirtual

Re-implementation of op()

Definition at line 302 of file variant_filter_iterator.h.

    {
      libmesh_assert(in);

      // Attempt downcast
#if defined(__SUNPRO_CC) || (defined(__GNUC__) && (__GNUC__ < 3)  && !defined(__INTEL_COMPILER))
      const variant_filter_iterator::Iter<IterType> * p =
        libMesh::cast_ptr<const variant_filter_iterator::Iter<IterType> * >(in);
#else
      const Iter<IterType> * p =
        libMesh::cast_ptr<const Iter<IterType> *>(in);
#endif

      // Return result of op() for the user's predicate.
      return pred_data(p->iter_data);
    }

Member Data Documentation

pred_data

template<typename IterType, typename PredType>

PredType Pred< IterType, PredType >::pred_data

This is the predicate passed in by the user.

Definition at line 322 of file variant_filter_iterator.h.

---

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

• include/base/variant_filter_iterator.h