Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
mln::accu::convolve< T1, T2, R > Struct Template Reference

Generic convolution accumulator class. More...

#include <convolve.hh>

Inherits mln::accu::internal::base< R, convolve< T1, T2, R > >, and check_t< mln::trait::value_< mln::trait::op::times< T1, T2 >::ret >::sum, R >.

Public Member Functions

bool is_valid () const
 Check whether this accu is able to return a result.
 
void take_as_init (const T &t)
 Take as initialization the value t.
 
void take_n_times (unsigned n, const T &t)
 Take n times the value t.
 
to_result () const
 Get the value of the accumulator.
 
void init ()
 Manipulators.
 

Detailed Description

template<typename T1, typename T2, typename R = typename mln::trait::value_< typename mln::trait::op::times< T1 , T2 >::ret >::sum>
struct mln::accu::convolve< T1, T2, R >

Generic convolution accumulator class.

Parameters T1 and T2 are the type of values to be convolved. Parameter R is the result type.

Definition at line 54 of file accu/convolve.hh.

Member Function Documentation

template<typename T1 , typename T2 , typename R >
void mln::accu::convolve< T1, T2, R >::init ( )
inline

Manipulators.

Definition at line 96 of file accu/convolve.hh.

References mln::literal::zero.

template<typename T1 , typename T2 , typename R >
bool mln::accu::convolve< T1, T2, R >::is_valid ( ) const
inline

Check whether this accu is able to return a result.

Always true here.

Definition at line 137 of file accu/convolve.hh.

void mln::Accumulator< convolve< T1, T2, R > >::take_as_init ( const T &  t)
inherited

Take as initialization the value t.

Dev note: this is a final method; override if needed by take_as_init_ (ending with '_').

void mln::Accumulator< convolve< T1, T2, R > >::take_n_times ( unsigned  n,
const T &  t 
)
inherited

Take n times the value t.

Dev note: this is a final method; override if needed by take_as_init_ (ending with '_').

template<typename T1 , typename T2 , typename R >
R mln::accu::convolve< T1, T2, R >::to_result ( ) const
inline

Get the value of the accumulator.

Definition at line 129 of file accu/convolve.hh.