SHOGUN  6.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules
List of all members | Public Member Functions | Public Attributes
Parameter Struct Reference

Detailed Description

Struct Parameter for wrapping up parameters to custom OpenCL operation strings. Supports string type, C-style string type and all basic types of parameters.

Definition at line 51 of file mathematics/linalg/internal/implementation/operations/Parameter.h.

Public Member Functions

 Parameter (const char *name)
 
template<typename T >
Parameteroperator= (const T &value)
 
Parameteroperator= (const char *value)
 
Parameteroperator= (std::string value)
 
 operator std::string () const
 

Public Attributes

std::function< std::string()> to_string
 
std::string m_name
 

Constructor & Destructor Documentation

Parameter ( const char *  name)

Constructor that initlializes the name of the parameter.

Parameters
nameThe name of the parameter.

Definition at line 59 of file mathematics/linalg/internal/implementation/operations/Parameter.h.

Member Function Documentation

operator std::string ( ) const

Cast opetator to std::string

Definition at line 106 of file mathematics/linalg/internal/implementation/operations/Parameter.h.

Parameter& operator= ( const T &  value)

Template overloaded assignment operator for basic-types that initializes an internal to_string method which is invoked when the parameter is casted to std::string.

Parameters
valueThe value of the parameter.

Definition at line 71 of file mathematics/linalg/internal/implementation/operations/Parameter.h.

Parameter& operator= ( const char *  value)

Overloaded assignment operator for C-style string-types that initializes an internal to_string method which is invoked when the parameter is casted to std::string.

Parameters
valueThe value of the parameter.

Definition at line 84 of file mathematics/linalg/internal/implementation/operations/Parameter.h.

Parameter& operator= ( std::string  value)

Overloaded assignment operator for std::string that initializes an internal to_string method which is invoked when the parameter is casted to std::string.

Parameters
valueThe value of the parameter.

Definition at line 97 of file mathematics/linalg/internal/implementation/operations/Parameter.h.

Member Data Documentation

std::string m_name

The name of the parameter

Definition at line 118 of file mathematics/linalg/internal/implementation/operations/Parameter.h.

std::function<std::string()> to_string

The method to_string which is initialized by the assignment operators based on the parameter value types. This method is invoked by the cast operator to std::string

Definition at line 115 of file mathematics/linalg/internal/implementation/operations/Parameter.h.


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

SHOGUN Machine Learning Toolbox - Documentation