rippled
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
ripple::DecayWindow< HalfLife, Clock > Class Template Reference

Sampling function using exponential decay to provide a continuous value. More...

Public Types

using time_point = typename Clock::time_point
 

Public Member Functions

 DecayWindow (time_point now)
 
void add (double value, time_point now)
 
double value (time_point now)
 

Private Member Functions

void decay (time_point now)
 

Private Attributes

double value_
 
time_point when_
 

Detailed Description

template<int HalfLife, class Clock>
class ripple::DecayWindow< HalfLife, Clock >

Sampling function using exponential decay to provide a continuous value.

Template Parameters
HalfLifeThe half life of a sample, in seconds.

Definition at line 112 of file DecayingSample.h.

Member Typedef Documentation

◆ time_point

template<int HalfLife, class Clock >
using ripple::DecayWindow< HalfLife, Clock >::time_point = typename Clock::time_point

Definition at line 115 of file DecayingSample.h.

Constructor & Destructor Documentation

◆ DecayWindow()

template<int HalfLife, class Clock >
ripple::DecayWindow< HalfLife, Clock >::DecayWindow ( time_point  now)
explicit

Definition at line 117 of file DecayingSample.h.

Member Function Documentation

◆ add()

template<int HalfLife, class Clock >
void ripple::DecayWindow< HalfLife, Clock >::add ( double  value,
time_point  now 
)

Definition at line 122 of file DecayingSample.h.

◆ value()

template<int HalfLife, class Clock >
double ripple::DecayWindow< HalfLife, Clock >::value ( time_point  now)

Definition at line 129 of file DecayingSample.h.

◆ decay()

template<int HalfLife, class Clock >
void ripple::DecayWindow< HalfLife, Clock >::decay ( time_point  now)
private

Definition at line 139 of file DecayingSample.h.

Member Data Documentation

◆ value_

template<int HalfLife, class Clock >
double ripple::DecayWindow< HalfLife, Clock >::value_
private

Definition at line 149 of file DecayingSample.h.

◆ when_

template<int HalfLife, class Clock >
time_point ripple::DecayWindow< HalfLife, Clock >::when_
private

Definition at line 150 of file DecayingSample.h.