faunus
Classes | Public Types | Public Member Functions | List of all members
Faunus::Scatter::SamplingPolicy< T > Class Template Reference

A policy for collecting samples. More...

#include <scatter.h>

Classes

struct  sampled_value
 

Public Types

typedef std::map< T, sampled_valueTSampledValueMap
 

Public Member Functions

std::map< T, TgetSampling () const
 
void addSampling (T key_approx, T value, T weight=1.0)
 

Detailed Description

template<std::floating_point T>
class Faunus::Scatter::SamplingPolicy< T >

A policy for collecting samples.

To be used together with StructureFactor class templates.

Template Parameters
Tfloat or double

Member Function Documentation

◆ addSampling()

template<std::floating_point T>
void Faunus::Scatter::SamplingPolicy< T >::addSampling ( T  key_approx,
T  value,
T  weight = 1.0 
)
inline
Parameters
key_approxis subject of rounding for better binning
value
weight

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