ADTF
Loading...
Searching...
No Matches
ddl::mapping::PolynomialFunction Class Reference

Polynomial function with type string "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) Properties: More...

#include <polynomial_function.h>

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

Classes

struct  TransformParameter
 

Public Member Functions

 PolynomialFunction (std::string name, Properties properties)
 CTOR.
 
Function::Description getDescription () 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

Polynomial function with type string "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) Properties:

  • "a" : value for a (default is "0")
  • "b" : value for b (default is "0")
  • "c" : value for c (default is "0")
  • "d" : value for d (default is "0")
  • "e" : value for e (default is "0")

Constructor & Destructor Documentation

◆ PolynomialFunction()

ddl::mapping::PolynomialFunction::PolynomialFunction ( 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::PolynomialFunction::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::PolynomialFunction::getDefaultProperties ( )
inlinestatic

Get the Default Properties to register within factory.

Returns
Properties

◆ getDescription()

Function::Description ddl::mapping::PolynomialFunction::getDescription ( ) const
overridevirtual

Get the parameter descriptions.

Returns
Description

Implements ddl::mapping::Function.

◆ getType()

static std::string ddl::mapping::PolynomialFunction::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: