Public Member Functions | List of all members
ecl::formatters::StencilFormatter< ValueType, Container, ecl::enable_if< ecl::is_float< ValueType > >::type > Class Template Reference

Partial specialisation of the stencil formatter for float containers. More...

#include <formatters.hpp>

Inheritance diagram for ecl::formatters::StencilFormatter< ValueType, Container, ecl::enable_if< ecl::is_float< ValueType > >::type >:
Inheritance graph
[legend]

Public Member Functions

 StencilFormatter (const int p=2, const int w=-1)
 Default constructor. More...
 
virtual ~StencilFormatter ()
 
- Public Member Functions inherited from ecl::formatters::FloatContainerFormatter< ecl::Stencil< Container > >
 FloatContainerFormatter (const unsigned int p=2, const int w=-1)
 
FloatContainerFormatteroperator() (const ecl::Stencil< Container > &c)
 
FloatContainerFormatteroperator() (const unsigned int p, const int w)
 
FloatContainerFormatteroperator() (ecl::Stencil< Container > &c, const unsigned int p, const int w)
 
unsigned int precision () const
 Access the current precision used by this formatter. More...
 
FloatContainerFormatterprecision (const unsigned int p)
 Sets the precision format parameter. More...
 
FloatContainerFormatterwidth (const int w)
 Sets the width format parameter. More...
 
virtual ~FloatContainerFormatter ()
 

Additional Inherited Members

- Public Types inherited from ecl::formatters::FloatContainerFormatter< ecl::Stencil< Container > >
typedef ecl::Stencil< Container > ::value_type value_type
 Catches the container element's type. More...
 

Detailed Description

template<typename ValueType, typename Container>
class ecl::formatters::StencilFormatter< ValueType, Container, ecl::enable_if< ecl::is_float< ValueType > >::type >

Partial specialisation of the stencil formatter for float containers.

Allows precision settings for formatting of float stencils.

Template Parameters
N: the size of the fixed size float array to be formatted.
See also
FloatContainerFormatter.

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

Constructor & Destructor Documentation

◆ StencilFormatter()

template<typename ValueType , typename Container >
ecl::formatters::StencilFormatter< ValueType, Container, ecl::enable_if< ecl::is_float< ValueType > >::type >::StencilFormatter ( const int  p = 2,
const int  w = -1 
)
inline

Default constructor.

Optionally accepts a precision setting for the contents of the array.

Parameters
p: the number of decimal places of precision [default : 2].
w: width [default : no width constraint]

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

◆ ~StencilFormatter()

template<typename ValueType , typename Container >
virtual ecl::formatters::StencilFormatter< ValueType, Container, ecl::enable_if< ecl::is_float< ValueType > >::type >::~StencilFormatter ( )
inlinevirtual

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


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


ecl_containers
Author(s): Daniel Stonier
autogenerated on Wed Mar 2 2022 00:16:34