Sleipnir C++ API
Loading...
Searching...
No Matches
slp::StallDetector< Scalar > Class Template Reference

#include </home/runner/work/Sleipnir/Sleipnir/include/sleipnir/optimization/solver/util/filter.hpp>

Public Member Functions

bool update (const FilterEntry< Scalar > &current_entry, const FilterEntry< Scalar > &trial_entry, Scalar α, Scalar min_constraint_violation)
 

Detailed Description

template<typename Scalar>
class slp::StallDetector< Scalar >

Detects a solver stall.

Template Parameters
ScalarScalar type.

Member Function Documentation

◆ update()

template<typename Scalar >
bool slp::StallDetector< Scalar >::update ( const FilterEntry< Scalar > &  current_entry,
const FilterEntry< Scalar > &  trial_entry,
Scalar  α,
Scalar  min_constraint_violation 
)
inline

Returns true if the solver stalled.

Parameters
current_entryThe entry corresponding to the current iterate.
trial_entryThe entry corresponding to the accepted trial iterate.
αThe accepted step size.
min_constraint_violationThe minimum constraint violation from the filter.
Returns
True if the solver stalled.

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