Scine::Readuct  6.0.0
This is the SCINE module ReaDuct.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Scine::Readuct::ElementaryStepOptimization::ElementaryStepOptimizerSettings< OptimizerType, ConvergenceCheckType > Class Template Reference

Settings for an ElementaryStepOptimizer. More...

#include <ElementaryStepOptimizerSettings.h>

Inheritance diagram for Scine::Readuct::ElementaryStepOptimization::ElementaryStepOptimizerSettings< OptimizerType, ConvergenceCheckType >:
Inheritance graph
Collaboration diagram for Scine::Readuct::ElementaryStepOptimization::ElementaryStepOptimizerSettings< OptimizerType, ConvergenceCheckType >:
Collaboration graph

Public Member Functions

 ElementaryStepOptimizerSettings (const OptimizerType &optimizer, const ConvergenceCheckType &check)
 Construct a new ElementaryStepOptimizerSettings object. More...
 

Detailed Description

template<class OptimizerType, class ConvergenceCheckType>
class Scine::Readuct::ElementaryStepOptimization::ElementaryStepOptimizerSettings< OptimizerType, ConvergenceCheckType >

Settings for an ElementaryStepOptimizer.

Uses template arguments in order to automatically include the settings of underlying objects into the given settings.

Template Parameters
OptimizerTypeThe underlying Optimizer class.
ConvergenceCheckTypeThe underlying ConvergenceCheck class.

Constructor & Destructor Documentation

template<class OptimizerType, class ConvergenceCheckType>
Scine::Readuct::ElementaryStepOptimization::ElementaryStepOptimizerSettings< OptimizerType, ConvergenceCheckType >::ElementaryStepOptimizerSettings ( const OptimizerType &  optimizer,
const ConvergenceCheckType &  check 
)
inline

Construct a new ElementaryStepOptimizerSettings object.

Sets the default values of the settings to the current values set in the objects given to the constructor.

Parameters
optimizerThe optimizer.
checkThe convergence check criteria.

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