SPH
Public Member Functions | List of all members
Integrator< TRng, TInternal > Class Template Reference

Object for integrating a generic three-dimensional scalar function. More...

#include <Functional.h>

Inheritance diagram for Integrator< TRng, TInternal >:
Noncopyable

Public Member Functions

 Integrator (const IDomain &domain)
 Constructs an integrator given the domain of integration. More...
 
 Integrator (IDomain &&domain)=delete
 
template<typename TFunctor >
Float integrate (TFunctor &&f, const Float targetError=0.001_f)
 Integrates a function. More...
 
- Public Member Functions inherited from Noncopyable
 Noncopyable ()=default
 
 Noncopyable (const Noncopyable &)=delete
 
 Noncopyable (Noncopyable &&)=default
 
Noncopyableoperator= (const Noncopyable &)=delete
 
Noncopyableoperator= (Noncopyable &&)=default
 

Detailed Description

template<typename TRng = UniformRng, typename TInternal = double>
class Integrator< TRng, TInternal >

Object for integrating a generic three-dimensional scalar function.

Definition at line 36 of file Functional.h.

Constructor & Destructor Documentation

◆ Integrator() [1/2]

template<typename TRng = UniformRng, typename TInternal = double>
Integrator< TRng, TInternal >::Integrator ( const IDomain domain)
inline

Constructs an integrator given the domain of integration.

Definition at line 45 of file Functional.h.

◆ Integrator() [2/2]

template<typename TRng = UniformRng, typename TInternal = double>
Integrator< TRng, TInternal >::Integrator ( IDomain &&  domain)
delete

Member Function Documentation

◆ integrate()

template<typename TRng = UniformRng, typename TInternal = double>
template<typename TFunctor >
Float Integrator< TRng, TInternal >::integrate ( TFunctor &&  f,
const Float  targetError = 0.001_f 
)
inline

Integrates a function.

Parameters
fFunctor with a Vector parameter, returning the integral as a scalar value

Definition at line 54 of file Functional.h.


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