apf::math::raised_cosine< T > Class Template Reference

Raised cosine (function object). More...

#include <apf/math.h>

Public Types
using	argument_type = T
using	result_type = T

Public Member Functions
	raised_cosine (T period=0)
	Constructor. More...
T	operator() (T in) const
	Function call operator. More...

Detailed Description

template<typename T>
class apf::math::raised_cosine< T >

Raised cosine (function object).

Result ranges from 0 to 1.

Definition at line 248 of file math.h.

Member Typedef Documentation

argument_type

template<typename T >

using apf::math::raised_cosine< T >::argument_type = T

Definition at line 251 of file math.h.

result_type

template<typename T >

using apf::math::raised_cosine< T >::result_type = T

Definition at line 252 of file math.h.

Constructor & Destructor Documentation

raised_cosine()

template<typename T >

apf::math::raised_cosine< T >::raised_cosine ( T  period = 0 )

inlineexplicit

Constructor.

Parameters

period

of a full cosine oscillation

Definition at line 255 of file math.h.

Member Function Documentation

operator()()

template<typename T >

T apf::math::raised_cosine< T >::operator() ( T  in ) const

inline

Function call operator.

Definition at line 258 of file math.h.

---

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

• apf/math.h