ecl::formatters::StencilFormatter< ValueType, Container, Enable > Class Template Reference

Pseudo formatter for stencils. More...

#include <formatters.hpp>

List of all members.

Public Member Functions
const ecl::Stencil< Container > &	operator() (const ecl::Stencil< Container > &stencil)
virtual	~StencilFormatter ()

---

Detailed Description

template<typename ValueType, typename Container, typename Enable = void>
class ecl::formatters::StencilFormatter< ValueType, Container, Enable >

Pseudo formatter for stencils.

These do nothing but pass the stencil back for streaming which should have its own << operator.

Do not use this class directly, rather call it via either the Array or Format classes explicitly. This makes the code more readable. e.g.

 Stencil< Array<int, 5> >::Formatter format_1;
 Format< Stencil< Array<int,4> > >   format_2;    // same thing

Template Parameters:

ValueType	: the underlying container's element type.
Container	: the underlying container storage.
Enable	: dummy template parameter used for mpl.

Definition at line 72 of file stencil/formatters.hpp.

---

Constructor & Destructor Documentation

template<typename ValueType , typename Container , typename Enable = void>

virtual ecl::formatters::StencilFormatter< ValueType, Container, Enable >::~StencilFormatter

(

)

[inline, virtual]

Definition at line 75 of file stencil/formatters.hpp.

---

Member Function Documentation

template<typename ValueType , typename Container , typename Enable = void>

const ecl::Stencil< Container >& ecl::formatters::StencilFormatter< ValueType, Container, Enable >::operator()

(

const ecl::Stencil< Container > &

stencil

)

[inline]

Pseudo formatter method, simply returns the underlying stencil which has its own stream operator.

Parameters:

stencil

: the stencil to be formatted.

Returns:

Stencil< Container > : just returns the input array.

Definition at line 83 of file stencil/formatters.hpp.

---

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

• stencil/formatters.hpp