beluga::views::detail::take_while_kld_fn Struct Reference

Implementation detail for a take_while_kld range adaptor object. More...

#include <take_while_kld.hpp>

Public Member Functions
template<class Hasher >
constexpr auto	operator() (Hasher hasher, std::size_t min, std::size_t max, double epsilon, double z=beluga::detail::kDefaultKldZ) const
	Overload that returns a view closure to compose with other views. More...
template<class Range , class Hasher , std::enable_if_t< ranges::range< Range >, int > = 0>
constexpr auto	operator() (Range &&range, Hasher hasher, std::size_t min, std::size_t max, double epsilon, double z=beluga::detail::kDefaultKldZ) const
	Overload that implements the take_while_kld algorithm. More...

Detailed Description

Implementation detail for a take_while_kld range adaptor object.

Definition at line 95 of file take_while_kld.hpp.

Member Function Documentation

operator()() [1/2]

template<class Hasher >

constexpr auto beluga::views::detail::take_while_kld_fn::operator() ( Hasher  hasher, std::size_t  min, std::size_t  max, double  epsilon, double  z = beluga::detail::kDefaultKldZ  ) const

inlineconstexpr

Overload that returns a view closure to compose with other views.

Template Parameters

Hasher

A callable object that can compute the spatial hash for a given state.

Parameters

hasher	Hasher instance used to compute the spatial hash for a given state.
min	Minimum samples to take.
max	Maximum samples to take.
epsilon	See beluga::kld_condition() for details.
z	See beluga::kld_condition() for details.

Definition at line 149 of file take_while_kld.hpp.

operator()() [2/2]

template<class Range , class Hasher , std::enable_if_t< ranges::range< Range >, int > = 0>

constexpr auto beluga::views::detail::take_while_kld_fn::operator() ( Range &&  range, Hasher  hasher, std::size_t  min, std::size_t  max, double  epsilon, double  z = beluga::detail::kDefaultKldZ  ) const

inlineconstexpr

Overload that implements the take_while_kld algorithm.

Template Parameters

Range	An input range with particle states.
Hasher	A callable object that can compute the spatial hash for a given state.

Parameters

range	Source range from where to take elements.
hasher	Hasher instance used to compute the spatial hash for a given state.
min	Minimum samples to take.
max	Maximum samples to take.
epsilon	See beluga::kld_condition() for details.
z	See beluga::kld_condition() for details.

The hasher will be called with range elements by default. If that is not possible, it will assume that the range contains particles and invoke the hasher with the state element of each particle.

Definition at line 112 of file take_while_kld.hpp.

---

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

• take_while_kld.hpp