class InferenceEngine::Parameter¶
Overview¶
This class represents an object to work with different parameters. More…
#include <ie_parameter.hpp>
class Parameter
{
public:
// structs
struct Any;
template <class T, class EqualTo>
struct CheckOperatorEqual;
template <class T, class EqualTo = T>
struct HasOperatorEqual;
template <class T>
struct RealData;
// construction
Parameter();
Parameter(Parameter&& parameter);
Parameter(const std::shared_ptr<ngraph::Variant>& var);
Parameter(std::shared_ptr<ngraph::Variant>& var);
Parameter(const Parameter& parameter);
template <
class T,
typename = typename std::enable_if<!std::is_same<typename std::decay<T>::type, Parameter>::value>::type
>
Parameter(T&& parameter);
Parameter(const char* str);
// methods
Parameter& operator = (const Parameter& parameter);
void clear();
bool empty() const;
template <class T>
bool is() const;
template <typename T>
T&& as();
template <class T>
T& as();
template <class T>
const T& as() const;
template <class T>
operator T&& ();
template <class T>
operator T& ();
template <class T>
operator const T & () const;
std::shared_ptr<ngraph::Variant> asVariant() const;
operator std::shared_ptr< ngraph::Variant > () const;
template <class T>
operator T& () const;
bool operator == (const Parameter& rhs) const;
bool operator != (const Parameter& rhs) const;
};
Detailed Documentation¶
This class represents an object to work with different parameters.
Construction¶
Parameter()
Default constructor.
Parameter(Parameter&& parameter)
Move constructor.
Parameters:
parameter |
Parameter object |
Parameter(const std::shared_ptr<ngraph::Variant>& var)
Creates parameter from variant. This method creates empty parameter if variant doesn’t contain Parameter.
Deprecated Use ngraph::Variant directly
Parameters:
var |
ngraph variant |
Parameter(std::shared_ptr<ngraph::Variant>& var)
Creates parameter from variant. This method creates empty parameter if variant doesn’t contain Parameter.
Deprecated Use ngraph::Variant directly
Parameters:
var |
ngraph variant |
Parameter(const Parameter& parameter)
Copy constructor.
Parameters:
parameter |
Parameter object |
template <
class T,
typename = typename std::enable_if<!std::is_same<typename std::decay<T>::type, Parameter>::value>::type
>
Parameter(T&& parameter)
Constructor creates parameter with object.
Parameters:
T |
Parameter type |
U |
Identity type-transformation |
parameter |
object |
Parameter(const char* str)
Constructor creates string parameter from char *.
Parameters:
str |
char array |
Methods¶
Parameter& operator = (const Parameter& parameter)
Copy operator for Parameter
Parameters:
parameter |
Parameter object |
Returns:
void clear()
Remove a value from parameter
bool empty() const
Checks that parameter contains a value
Returns:
false if parameter contains a value else false
template <class T>
bool is() const
Checks the type of value
Parameters:
T |
Type of value |
Returns:
true if type of value is correct
template <typename T>
T&& as()
Dynamic cast to specified type
Parameters:
T |
type |
Returns:
casted object
template <class T>
T& as()
Dynamic cast to specified type
Parameters:
T |
type |
Returns:
casted object
template <class T>
const T& as() const
Dynamic cast to specified type
Parameters:
T |
type |
Returns:
casted object
template <class T>
operator T&& ()
Dynamic cast to specified type
Parameters:
T |
type |
Returns:
casted object
template <class T>
operator T& ()
Dynamic cast to specified type
Parameters:
T |
type |
Returns:
casted object
template <class T>
operator const T & () const
Dynamic cast to specified type
Parameters:
T |
type |
Returns:
casted object
std::shared_ptr<ngraph::Variant> asVariant() const
Converts parameter to shared pointer on ngraph::Variant.
Deprecated Use ngraph::Variant directly
Returns:
shared pointer on ngraph::Variant
operator std::shared_ptr< ngraph::Variant > () const
Casts to shared pointer on ngraph::Variant.
Deprecated Use ngraph::Variant directly
Returns:
shared pointer on ngraph::Variant
template <class T>
operator T& () const
Dynamic cast to specified type
Parameters:
T |
type |
Returns:
casted object
bool operator == (const Parameter& rhs) const
The comparison operator for the Parameter.
Parameters:
rhs |
object to compare |
Returns:
true if objects are equal
bool operator != (const Parameter& rhs) const
The comparison operator for the Parameter.
Parameters:
rhs |
object to compare |
Returns:
true if objects aren’t equal