rm::para::AlgorithmParam类 参考

AlgorithmParam 参数模块 更多...

#include <rmvlpara/algorithm.hpp>

rm::para::AlgorithmParam 的协作图:

Public 成员函数
	AlgorithmParam ()=default
	创建 AlgorithmParam 参数对象
bool	read (const std::string &path)
	从指定 YAML 文件中加载，并读取至 AlgorithmParam 中
bool	write (const std::string &path) const
	将 AlgorithmParam 的数据写入指定的 YAML 文件中
bool	load (const std::string &path)
	从指定 YAML 文件中加载 AlgorithmParam

Public 属性
double	SECANT_STEP = 1e-3
	离散Newton弦截法用于近似求导的步长

详细描述

AlgorithmParam 参数模块

构造及析构函数说明

AlgorithmParam()

rm::para::AlgorithmParam::AlgorithmParam ( )

default

创建 AlgorithmParam 参数对象

警告

不建议手动创建对象

成员函数说明

load()

bool rm::para::AlgorithmParam::load ( const std::string & path )

inline

从指定 YAML 文件中加载 AlgorithmParam

弃用

请使用 read 方法

read()

bool rm::para::AlgorithmParam::read

(

const std::string &

path

)

Python:
	rm.AlgorithmParam.read(	path	) ->	<success ?>

从指定 YAML 文件中加载，并读取至 AlgorithmParam 中

注解

YAML 文件的后缀允许是 *.yml 和 *.yaml

参数

[in]

path

参数路径

返回

是否读取成功

write()

bool rm::para::AlgorithmParam::write

(

const std::string &

path

)

const

Python:
	rm.AlgorithmParam.write(	path	) ->	<success ?>

将 AlgorithmParam 的数据写入指定的 YAML 文件中

注解

YAML 文件的后缀允许是 *.yml 和 *.yaml

参数

[in]

path

参数路径

返回

是否写入成功

类成员变量说明

SECANT_STEP

double rm::para::AlgorithmParam::SECANT_STEP = 1e-3

离散Newton弦截法用于近似求导的步长

注解

默认值：1e-3

---

该类的文档由以下文件生成:

• rmvlpara/algorithm.hpp