ocean::Variable

变量基础类是变量的基础 More...

#include <Variable.hpp>

Inherits from std::enable_shared_from_this< Variable >

Inherited by ocean::SingleVariable, ocean::TensorVariable

Public Functions

	Name
	Variable(PIVariable variable) 构建变量
virtual	~Variable() 析构变量
const std::string &	getName() const 获取变量名称
const std::string &	getDescription() const 获取变量描述
void	setDescription(const std::string & description) 设置变量描述
bool	isShared() const 是否共享
bool	isPersistent() const 是否持久化，只对张量有效
Layout	getLayout() const 获取变量布局
PIVariable	getInternalVariable() 获取内部变量指针

Protected Attributes

	Name
PIVariable	internalVariable 内部变量指针

Detailed Description

class ocean::Variable;

变量基础类是变量的基础

变量提供了变量体系的基础接口，包括名称、描述、共享、持久化及布局的获取功能。

Public Functions Documentation

function Variable

explicit Variable(
    PIVariable variable
)

构建变量

Parameters:

• variable 内部变量指针

function ~Variable

virtual ~Variable()

析构变量

function getName

const std::string & getName() const

获取变量名称

Return: 变量名称

function getDescription

const std::string & getDescription() const

获取变量描述

Return:

function setDescription

void setDescription(
    const std::string & description
)

设置变量描述

Parameters:

• description 变量描述

function isShared

bool isShared() const

是否共享

Return:

function isPersistent

bool isPersistent() const

是否持久化，只对张量有效

Return:

function getLayout

Layout getLayout() const

获取变量布局

Return: 变量布局

function getInternalVariable

PIVariable getInternalVariable()

获取内部变量指针

Return: 内部变量指针

Note: 仅被内部模块调用

Protected Attributes Documentation

variable internalVariable

PIVariable internalVariable;

内部变量指针

---

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