ocean::Argument

参数，提供了大量便捷的参数构建方法，极大方便了用户的使用。 More...

#include <Argument.hpp>

Public Functions

	Name
	Argument() 默认为空字符串参数
	Argument(VariableValue value_) 从变量值构建单变量参数
template <typename T >	Argument(DataType type, const T & v) 从数值构建单变量值参数
	Argument(const std::string & content_) 从字符串值构建字符串参数
	Argument(const char * content_) 从字符串指针值构建字符串参数
	Argument(const Tensor & tensor_) 构建张量参数
template <typename T >	Argument(const std::vector< T > & data) 从向量构建张量参数
	Argument(const Filler & filler_) 从填充器构建填充器参数
template <typename dataType >	Argument(dataType min, dataType max, uint32_t seed =0) 构建均匀分布填充器参数
	Argument(PArgumentPointer container_) 从通用参数指针构建通用对象参数
template <class T >	Argument(const T & value_) 通用自动推倒模板
virtual	~Argument() 释放参数
	Argument(const Argument & arg) 拷贝参数
Argument &	operator=(const Argument & arg) 赋值参数
ArgumentType	getArgType() const 获取参数类型
VariableValue &	getValue() 获取变量值
const std::string &	getContent() const 获取字符串值
void	setContent(const std::string & content_) 设置字符串值
Tensor &	getTensor() 获取张量
void	setTensor(const Tensor & tensor_) 设置张量
Filler &	getFiller() 获取填充器
void	setFiller(const Filler & filler_) 设置填充器
PArgumentPointer &	getContainer() 获取通用指针
void	setContainer(const PArgumentPointer & pointer) 设置通用指针
Filler	toFiller(DataType type) 参数转换为填充器

Protected Functions

	Name
template <class Type > void	setArg(const Type & value_, const VariableValue & ) 设置单变量参数信息
template <class T > void	setArg(const T & pointer, const PArgumentPointer & ) 设置通用对象信息
void	release() 释放数据

Protected Attributes

	Name
ArgumentType	argType 参数类型
VariableValue	value 变量值
std::string	content 字符串值
Tensor	tensor 张量值
Filler	filler 填充器
PArgumentPointer	container 通用指针

Detailed Description

class ocean::Argument;

参数，提供了大量便捷的参数构建方法，极大方便了用户的使用。

参数是能够承载多种数据类型的载体，包括：

• 字符串
• 张量
• 填充器
• 数值
• 通用对象

Public Functions Documentation

function Argument

inline Argument()

默认为空字符串参数

function Argument

inline Argument(
    VariableValue value_
)

从变量值构建单变量参数

Parameters:

• value_ 变量值

function Argument

template <typename T >
inline Argument(
    DataType type,
    const T & v
)

从数值构建单变量值参数

Parameters:

• type 数据类型
• v 数值

Template Parameters:

• T 模板类型

function Argument

inline Argument(
    const std::string & content_
)

从字符串值构建字符串参数

Parameters:

• content_ 字符串

function Argument

inline Argument(
    const char * content_
)

从字符串指针值构建字符串参数

Parameters:

• content_ 字符串指针

function Argument

inline Argument(
    const Tensor & tensor_
)

构建张量参数

Parameters:

• tensor_ 张量

function Argument

template <typename T >
inline Argument(
    const std::vector< T > & data
)

从向量构建张量参数

Parameters:

• data 向量

function Argument

inline Argument(
    const Filler & filler_
)

从填充器构建填充器参数

Parameters:

• filler_

function Argument

template <typename dataType >
inline Argument(
    dataType min,
    dataType max,
    uint32_t seed =0
)

构建均匀分布填充器参数

Parameters:

• min 最小值
• max 最大值
• seed 随机种子

Template Parameters:

• dataType 数据类型

function Argument

inline Argument(
    PArgumentPointer container_
)

从通用参数指针构建通用对象参数

Parameters:

• container_ 通用对象指针

function Argument

template <class T >
inline Argument(
    const T & value_
)

通用自动推倒模板

Parameters:

• value_ 数据值

Template Parameters:

• T 数据类型

function ~Argument

inline virtual ~Argument()

释放参数

function Argument

inline Argument(
    const Argument & arg
)

拷贝参数

Parameters:

• arg

function operator=

inline Argument & operator=(
    const Argument & arg
)

赋值参数

Parameters:

• arg

Return:

release

reset new content

function getArgType

inline ArgumentType getArgType() const

获取参数类型

Return: 参数类型

function getValue

inline VariableValue & getValue()

获取变量值

Return: 变量值

function getContent

inline const std::string & getContent() const

获取字符串值

Return: 字符串值

function setContent

inline void setContent(
    const std::string & content_
)

设置字符串值

Parameters:

• content_ 字符串值

function getTensor

inline Tensor & getTensor()

获取张量

Return: 张量

function setTensor

inline void setTensor(
    const Tensor & tensor_
)

设置张量

Parameters:

• tensor_ 张量

function getFiller

inline Filler & getFiller()

获取填充器

Return: 填充器

function setFiller

inline void setFiller(
    const Filler & filler_
)

设置填充器

Parameters:

• filler_ 填充器

function getContainer

inline PArgumentPointer & getContainer()

获取通用指针

Return: 通用指针

function setContainer

inline void setContainer(
    const PArgumentPointer & pointer
)

设置通用指针

Parameters:

• pointer 通用指针

function toFiller

inline Filler toFiller(
    DataType type
)

参数转换为填充器

Parameters:

• type 数据类型

Return: 填充器

Protected Functions Documentation

function setArg

template <class Type >
inline void setArg(
    const Type & value_,
    const VariableValue & 
)

设置单变量参数信息

Parameters:

• value_ 数值

Template Parameters:

• Type 数据类型

function setArg

template <class T >
inline void setArg(
    const T & pointer,
    const PArgumentPointer & 
)

设置通用对象信息

Parameters:

• pointer 指针

Template Parameters:

• T 数据类型

function release

inline void release()

释放数据

Protected Attributes Documentation

variable argType

ArgumentType argType;

参数类型

variable value

VariableValue value;

变量值

variable content

std::string content;

字符串值

variable tensor

Tensor tensor;

张量值

variable filler

Filler filler;

填充器

variable container

PArgumentPointer container;

通用指针

---

Updated on 2022-08-19 at 17:14:26 +0800