FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ > Class Template Reference

Composite Adjactor implementation. More...

#include <adjactor.hpp>

Classes
class	ImageIterator
	Image Node Iterator implementation for CompositeAdjactor. More...

Public Types
typedef Adj1_	Adjactor1
	typedef for first adjactor More...
typedef Adj2_	Adjactor2
	typedef for second adjactor More...

Public Member Functions
	CompositeAdjactor (const Adj1_ &adjactor1, const Adj2_ &adjactor2)
	Constructor. More...
const Adjactor1 &	get_adjactor1 () const
	Returns the first adjactor. More...
const Adjactor2 &	get_adjactor2 () const
	Returns the second adjactor. More...
Index	get_num_nodes_domain () const
	Returns the number of domain nodes. More...
Index	get_num_nodes_image () const
	Returns the number of image nodes. More...
ImageIterator	image_begin (Index domain_node) const
	Returns an iterator for the first adjacent image node. More...
ImageIterator	image_end (Index domain_node) const
	Returns an iterator for the first position past the last adjacent image node. More...

Private Attributes
const Adj1_ &	_adj1
	first adjactor More...
const Adj2_ &	_adj2
	second adjactor More...

Detailed Description

template<typename Adj1_, typename Adj2_>
class FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >

Composite Adjactor implementation.

Todo:

detailed description

Author

Peter Zajac

Definition at line 273 of file adjactor.hpp.

Member Typedef Documentation

Adjactor1

template<typename Adj1_ , typename Adj2_ >

typedef Adj1_ FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::Adjactor1

typedef for first adjactor

Definition at line 283 of file adjactor.hpp.

Adjactor2

template<typename Adj1_ , typename Adj2_ >

typedef Adj2_ FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::Adjactor2

typedef for second adjactor

Definition at line 285 of file adjactor.hpp.

Constructor & Destructor Documentation

CompositeAdjactor()

template<typename Adj1_ , typename Adj2_ >

FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::CompositeAdjactor ( const Adj1_ &  adjactor1, const Adj2_ &  adjactor2  )

inline

Constructor.

Parameters

[in]	adjactor1	The first adjactor for the composition.
[in]	adjactor2	The second adjactor for the composition.

Definition at line 428 of file adjactor.hpp.

References FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::_adj1, FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::_adj2, and XASSERTM.

Member Function Documentation

get_adjactor1()

template<typename Adj1_ , typename Adj2_ >

const Adjactor1 & FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::get_adjactor1 ( ) const

inline

Returns the first adjactor.

Returns

A reference to the first adjactor in the composition.

Definition at line 475 of file adjactor.hpp.

References FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::_adj1.

get_adjactor2()

template<typename Adj1_ , typename Adj2_ >

const Adjactor2 & FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::get_adjactor2 ( ) const

inline

Returns the second adjactor.

Returns

A reference to the second adjactor in the composition.

Definition at line 485 of file adjactor.hpp.

References FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::_adj2.

get_num_nodes_domain()

template<typename Adj1_ , typename Adj2_ >

Index FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::get_num_nodes_domain ( ) const

inline

Returns the number of domain nodes.

Returns

The total number of domain nodes in the adjactor.

Definition at line 441 of file adjactor.hpp.

References FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::_adj1.

Referenced by FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::image_begin(), and FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::image_end().

get_num_nodes_image()

template<typename Adj1_ , typename Adj2_ >

Index FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::get_num_nodes_image ( ) const

inline

Returns the number of image nodes.

Returns

The total number of image nodes in the adjactor.

Definition at line 449 of file adjactor.hpp.

References FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::_adj2.

image_begin()

template<typename Adj1_ , typename Adj2_ >

ImageIterator FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::image_begin ( Index  domain_node ) const

inline

Returns an iterator for the first adjacent image node.

Parameters

[in]

domain_node

The index of the domain node whose image node iterator is to be returned.

Returns

An iterator representing the first image node adjacent to domain_node, or image_end(domain_node) if no adjacent image nodes exist.

Definition at line 457 of file adjactor.hpp.

References FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::_adj1, FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::_adj2, ASSERTM, and FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::get_num_nodes_domain().

image_end()

template<typename Adj1_ , typename Adj2_ >

ImageIterator FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::image_end ( Index  domain_node ) const

inline

Returns an iterator for the first position past the last adjacent image node.

Parameters

[in]

domain_node

The index of the domain node whose image node iterator is to be returned.

Returns

An iterator representing the first position past the last image node adjacent to domain_node.

Definition at line 464 of file adjactor.hpp.

References FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::_adj1, ASSERTM, and FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::get_num_nodes_domain().

Member Data Documentation

_adj1

template<typename Adj1_ , typename Adj2_ >

const Adj1_& FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::_adj1

private

first adjactor

Definition at line 277 of file adjactor.hpp.

Referenced by FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::CompositeAdjactor(), FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::get_adjactor1(), FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::get_num_nodes_domain(), FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::image_begin(), and FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::image_end().

_adj2

template<typename Adj1_ , typename Adj2_ >

const Adj2_& FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::_adj2

private

second adjactor

Definition at line 279 of file adjactor.hpp.

Referenced by FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::CompositeAdjactor(), FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::get_adjactor2(), FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::get_num_nodes_image(), and FEAT::Adjacency::CompositeAdjactor< Adj1_, Adj2_ >::image_begin().

---

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

• kernel/adjacency/adjactor.hpp