Helios++
Helios software for LiDAR simulations
SurfaceInspector::maths::functions::IMathFunction< Tin, Tout > Class Template Reference

Interface defining math function core mechanics. More...

#include <IMathFunction.hpp>

Inheritance diagram for SurfaceInspector::maths::functions::IMathFunction< Tin, Tout >:
Collaboration diagram for SurfaceInspector::maths::functions::IMathFunction< Tin, Tout >:

Public Member Functions

virtual Tout operator() (Tin const &x)
 Math function callable. It must be implemented by any concrete implementation of a valid math function. More...
 
virtual Tout operator() (Tin const &&x)
 RValue reference callable. More...
 
virtual vector< Tout > operator() (vector< Tin > const &u)
 Base implementation for math function computation over a vector. It can be overridden for the sake of convenience by any subclass. More...
 

Detailed Description

template<typename Tin, typename Tout>
class SurfaceInspector::maths::functions::IMathFunction< Tin, Tout >

Interface defining math function core mechanics.

Author
Alberto M. Esmoris Pena
Version
1.0
Template Parameters
TinType of element the function operate over (input)
ToutType of element the function generates (output)

Member Function Documentation

◆ operator()() [1/3]

template<typename Tin , typename Tout >
virtual Tout SurfaceInspector::maths::functions::IMathFunction< Tin, Tout >::operator() ( Tin const &&  x)
inlinevirtual

RValue reference callable.

See also
IMathFunction::operator() (Tin const &)

◆ operator()() [2/3]

template<typename Tin , typename Tout >
virtual Tout SurfaceInspector::maths::functions::IMathFunction< Tin, Tout >::operator() ( Tin const &  x)
virtual

Math function callable. It must be implemented by any concrete implementation of a valid math function.

Parameters
xFunction input
Returns
Function output

Reimplemented in SurfaceInspector::maths::functions::GaussianFunction< T >.

◆ operator()() [3/3]

template<typename Tin , typename Tout >
virtual vector<Tout> SurfaceInspector::maths::functions::IMathFunction< Tin, Tout >::operator() ( vector< Tin > const &  u)
inlinevirtual

Base implementation for math function computation over a vector. It can be overridden for the sake of convenience by any subclass.

Parameters
uInput vector
Returns
Output vector

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