roboctrl::utils::RLS< dim > 模板类 参考

详细描述

template<uint32_t dim>
class roboctrl::utils::RLS< dim >

在文件 RLS.hpp 第 12 行定义.

Public 成员函数
	RLS ()=delete
	Delete the default constructor
constexpr	RLS (float delta_, float lambda_)
	The constructor
constexpr	RLS (float delta_, float lambda_, Matrixf< dim, 1 > initParam)
void	reset ()
	Reset the RLS module
const Matrixf< dim, 1 > &	update (Matrixf< dim, 1 > &sampleVector, float actualOutput)
	Proccess a cycle of RLS update
void	setParamVector (const Matrixf< dim, 1 > &updatedParams)
	Set the default regression parameters
constexpr Matrixf< dim, 1 > &	getParamsVector () const
	The getter function of the params vector
const float &	getOutput () const
	The getter function of the output vector

构造及析构函数说明

RLS() [1/2]

template<uint32_t dim>

constexpr roboctrl::utils::RLS< dim >::RLS ( float  delta_, float  lambda_  )

inlineconstexpr

The constructor

参数

delta_	The intialized non-singular value of the transfer matrix
lambda_	The forgotten index

在文件 RLS.hpp 第 25 行定义.

引用了 roboctrl::utils::RLS< dim >::reset().

RLS() [2/2]

template<uint32_t dim>

constexpr roboctrl::utils::RLS< dim >::RLS ( float  delta_, float  lambda_, Matrixf< dim, 1 >  initParam  )

inlineconstexpr

在文件 RLS.hpp 第 36 行定义.

成员函数说明

getOutput()

template<uint32_t dim>

const float & roboctrl::utils::RLS< dim >::getOutput ( ) const

inline

The getter function of the output vector

参数

None

返回值

The	estimated / filterd output of the RLS module

在文件 RLS.hpp 第 93 行定义.

getParamsVector()

template<uint32_t dim>

constexpr Matrixf< dim, 1 > & roboctrl::utils::RLS< dim >::getParamsVector ( ) const

inlineconstexpr

The getter function of the params vector

参数

None

返回值

paramsVector

在文件 RLS.hpp 第 84 行定义.

reset()

template<uint32_t dim>

void roboctrl::utils::RLS< dim >::reset ( )

inline

Reset the RLS module

返回值

None

在文件 RLS.hpp 第 44 行定义.

引用了 roboctrl::utils::Matrix< _rows, _cols, T >::eye() , 以及 roboctrl::utils::Matrix< _rows, _cols, T >::zeros().

被这些函数引用 roboctrl::utils::RLS< dim >::RLS().

setParamVector()

template<uint32_t dim>

void roboctrl::utils::RLS< dim >::setParamVector ( const Matrixf< dim, 1 > &  updatedParams )

inline

Set the default regression parameters

参数

updatedParams

返回值

None

在文件 RLS.hpp 第 75 行定义.

update()

template<uint32_t dim>

const Matrixf< dim, 1 > & roboctrl::utils::RLS< dim >::update ( Matrixf< dim, 1 > &  sampleVector, float  actualOutput  )

inline

Proccess a cycle of RLS update

参数

sampleVector	The new samples input expressed in n x 1 dimensionasl vector form
actualOutput	The actual feedback real output

返回值

paramsVector

在文件 RLS.hpp 第 56 行定义.

---

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

• /home/runner/work/GKD.RoboCtrl/GKD.RoboCtrl/include/utils/RLS.hpp