Dev Essential  1.6.3
Loading...
Searching...
No Matches
ddl::mapping::InlinePolynomialFunction Class Reference

Inline Polynomial function with type string "inline_polynomial". The callable function retrieved with getCallable() will transform the value with
result = (a * value^0 + b * value^1 + c * value^2 + d * value^3 + d * value^4 + e * value^5)
where parameters are value, a, b, c, d, e. More...

#include <default_function.h>

Inherits ddl::mapping::MapperElementBase< Function >.

Public Member Functions

 InlinePolynomialFunction ()
 CTOR.
 
 InlinePolynomialFunction (std::string name, Properties properties)
 CTOR.
 
std::unordered_map< std::string, ParameterDescriptiongetDescription () const override
 Get the parameter descriptions.
 
std::shared_ptr< Function::CallablegetCallable () const override
 Get a Function Callable.
 
- Public Member Functions inherited from ddl::mapping::MapperElementBase< Function >
 MapperElementBase (std::string name, Properties properties)
 CTOR.
 
 ~MapperElementBase () override=default
 DTOR.
 
const std::string & getName () const override
 Get the Name.
 
const PropertiesgetProperties () const override
 Get the Properties.
 
const PropertygetProperty (const std::string &property_name) const
 Get the Property.
 
- Public Member Functions inherited from ddl::mapping::MapperElement
virtual ~MapperElement ()=default
 DTOR.
 

Static Public Member Functions

static std::string getType ()
 Get the Type as string to register within factory.
 
static Properties getDefaultProperties ()
 Get the Default Properties to register within factory.
 

Additional Inherited Members

- Public Types inherited from ddl::mapping::Function
using Description = std::unordered_map<std::string, ParameterDescription>
 

Detailed Description

Inline Polynomial function with type string "inline_polynomial". The callable function retrieved with getCallable() will transform the value with
result = (a * value^0 + b * value^1 + c * value^2 + d * value^3 + d * value^4 + e * value^5)
where parameters are value, a, b, c, d, e.

Constructor & Destructor Documentation

◆ InlinePolynomialFunction()

ddl::mapping::InlinePolynomialFunction::InlinePolynomialFunction ( std::string name,
Properties properties )

CTOR.

Parameters
namethe name of the instance
propertiesthe properties for the instance

Member Function Documentation

◆ getCallable()

std::shared_ptr< Function::Callable > ddl::mapping::InlinePolynomialFunction::getCallable ( ) const
overridevirtual

Get a Function Callable.

Parameters
function_namethe function name
Returns
std::shared_ptr<const FunctionCaller>

Implements ddl::mapping::Function.

◆ getDefaultProperties()

static Properties ddl::mapping::InlinePolynomialFunction::getDefaultProperties ( )
inlinestatic

Get the Default Properties to register within factory.

Returns
Properties

◆ getDescription()

std::unordered_map< std::string, ParameterDescription > ddl::mapping::InlinePolynomialFunction::getDescription ( ) const
overridevirtual

Get the parameter descriptions.

Returns
Description

Implements ddl::mapping::Function.

◆ getType()

static std::string ddl::mapping::InlinePolynomialFunction::getType ( )
inlinestatic

Get the Type as string to register within factory.

Returns
std::string

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