xgboost::GradientContainer Struct Reference

Container for gradient produced by objective. More...

#include <gradient.h>

Collaboration diagram for xgboost::GradientContainer:

Public Member Functions
bool	HasValueGrad () const noexcept
std::size_t	NumSplitTargets () const noexcept
std::size_t	NumTargets () const noexcept
linalg::MatrixView< GradientPair const >	ValueGrad (Context const *ctx) const
linalg::Matrix< GradientPair > const *	Grad () const
linalg::Matrix< GradientPair > *	Grad ()
linalg::Matrix< GradientPair > const *	FullGradOnly () const
linalg::Matrix< GradientPair > *	FullGradOnly ()

Public Attributes
linalg::Matrix< GradientPair >	gpair
	Gradient used for multi-target tree split and linear model. More...
linalg::Matrix< GradientPair >	value_gpair
	Gradient used for tree leaf value, optional. More...

Detailed Description

Container for gradient produced by objective.

Member Function Documentation

FullGradOnly() [1/2]

linalg::Matrix<GradientPair>* xgboost::GradientContainer::FullGradOnly ( )

inline

FullGradOnly() [2/2]

linalg::Matrix<GradientPair> const* xgboost::GradientContainer::FullGradOnly ( ) const

inline

Grad() [1/2]

linalg::Matrix<GradientPair>* xgboost::GradientContainer::Grad ( )

inline

Grad() [2/2]

linalg::Matrix<GradientPair> const* xgboost::GradientContainer::Grad ( ) const

inline

HasValueGrad()

bool xgboost::GradientContainer::HasValueGrad ( ) const

inlinenoexcept

NumSplitTargets()

std::size_t xgboost::GradientContainer::NumSplitTargets ( ) const

inlinenoexcept

NumTargets()

std::size_t xgboost::GradientContainer::NumTargets ( ) const

inlinenoexcept

ValueGrad()

linalg::MatrixView<GradientPair const> xgboost::GradientContainer::ValueGrad ( Context const *  ctx ) const

inline

Member Data Documentation

gpair

linalg::Matrix<GradientPair> xgboost::GradientContainer::gpair

Gradient used for multi-target tree split and linear model.

value_gpair

linalg::Matrix<GradientPair> xgboost::GradientContainer::value_gpair

Gradient used for tree leaf value, optional.

---

The documentation for this struct was generated from the following file:

• /home/docs/checkouts/readthedocs.org/user_builds/xgboost/checkouts/latest/include/xgboost/gradient.h