Class uipc::diff_sim::EnableGradFeature

ClassList > uipc > diff_sim > EnableGradFeature

Inherits the following classes: uipc::core::Feature

Public Static Attributes

Type	Name
std::string_view	FeatureName = "diff\_sim/enable\_grad"

Public Functions

Type	Name
	EnableGradFeature (S< EnableGradFeatureOverrider > overrider)
bool	is_grad_enabled () const Check if parameter gradient computation is enabled.
void	no_grad () With DiffSim on, turn off parameter gradient computation.
void	with_grad () With DiffSim on, turn on parameter gradient computation.

Public Functions inherited from uipc::core::IFeature

See uipc::core::IFeature

Type	Name
std::string_view	name () const
std::string_view	type_name () const
virtual	~IFeature () = default

Protected Functions inherited from uipc::core::IFeature

See uipc::core::IFeature

Type	Name
virtual void	do_on_required () const = 0
virtual std::string_view	get_name () const = 0
virtual std::string_view	get_type_name () const = 0

Public Static Attributes Documentation

variable FeatureName

std::string_view uipc::diff_sim::EnableGradFeature::FeatureName;

---

Public Functions Documentation

function EnableGradFeature

uipc::diff_sim::EnableGradFeature::EnableGradFeature (
    S< EnableGradFeatureOverrider > overrider
) 

---

function is_grad_enabled

Check if parameter gradient computation is enabled.

bool uipc::diff_sim::EnableGradFeature::is_grad_enabled () const

Returns:

true if parameter gradient computation is enabled.

---

function no_grad

With DiffSim on, turn off parameter gradient computation.

void uipc::diff_sim::EnableGradFeature::no_grad () 

---

function with_grad

With DiffSim on, turn on parameter gradient computation.

void uipc::diff_sim::EnableGradFeature::with_grad () 

---

---

The documentation for this class was generated from the following file include/uipc/diff_sim/enable_grad_feature.h