line::opt::LineEvaluator Class Reference

#include <line/opt/evaluator.h>

Public Types
using	Model = std::variant<qn::Network<double>, lqn::LqnModel<double>>
using	SolveFunction
using	LayerSensitivityMap = std::map<std::string, LayerSensitivity>

Public Member Functions
	LineEvaluator (qn::Network< double > model, std::vector< VariablePtr > variables, std::vector< std::pair< VariablePtr, Value > > fixed={}, SolveFunction solve={})
	LineEvaluator (lqn::LqnModel< double > model, std::vector< VariablePtr > variables, std::vector< std::pair< VariablePtr, Value > > fixed={})
	LineEvaluator (Model model, std::vector< VariablePtr > variables, std::vector< std::pair< VariablePtr, Value > > fixed={}, SolveFunction solve={})
bool	is_layered () const
std::size_t	evaluation_count () const
std::vector< std::pair< double, double > >	bounds () const
VariableValues	decode (const std::vector< double > &x) const
EvaluationResult	evaluate (const VariableValues &values)
std::optional< LayerSensitivityMap >	evaluate_layered_sensitivities (const VariableValues &values) const

Detailed Description

Definition at line 46 of file evaluator.h.

Member Typedef Documentation

LayerSensitivityMap

using line::opt::LineEvaluator::LayerSensitivityMap = std::map<std::string, LayerSensitivity>

Definition at line 51 of file evaluator.h.

Model

using line::opt::LineEvaluator::Model = std::variant<qn::Network<double>, lqn::LqnModel<double>>

Definition at line 48 of file evaluator.h.

SolveFunction

using line::opt::LineEvaluator::SolveFunction

Initial value:

std::function<mva::AvgResult<double>(
       const qn::NetworkStruct<double>&)>

Definition at line 49 of file evaluator.h.

Constructor & Destructor Documentation

LineEvaluator() [1/3]

line::opt::LineEvaluator::LineEvaluator ( qn::Network< double > model, std::vector< VariablePtr > variables, std::vector< std::pair< VariablePtr, Value > > fixed = {}, SolveFunction solve = {} )

inline

Definition at line 53 of file evaluator.h.

LineEvaluator() [2/3]

line::opt::LineEvaluator::LineEvaluator ( lqn::LqnModel< double > model, std::vector< VariablePtr > variables, std::vector< std::pair< VariablePtr, Value > > fixed = {} )

inline

Definition at line 59 of file evaluator.h.

LineEvaluator() [3/3]

line::opt::LineEvaluator::LineEvaluator ( Model model, std::vector< VariablePtr > variables, std::vector< std::pair< VariablePtr, Value > > fixed = {}, SolveFunction solve = {} )

inline

Definition at line 63 of file evaluator.h.

Member Function Documentation

bounds()

std::vector< std::pair< double, double > > line::opt::LineEvaluator::bounds ( ) const

inline

Definition at line 84 of file evaluator.h.

decode()

VariableValues line::opt::LineEvaluator::decode ( const std::vector< double > & x ) const

inline

Definition at line 87 of file evaluator.h.

evaluate()

EvaluationResult line::opt::LineEvaluator::evaluate ( const VariableValues & values )

inline

Definition at line 97 of file evaluator.h.

References line::opt::EvaluationResult::feasible, is_layered(), and line::opt::EvaluationResult::solve_time.

evaluate_layered_sensitivities()

std::optional< LayerSensitivityMap > line::opt::LineEvaluator::evaluate_layered_sensitivities ( const VariableValues & values ) const

inline

Definition at line 115 of file evaluator.h.

References line::ln::SolverLN< T >::get_sensitivity_table(), is_layered(), line::lqn::lqn_finalize(), line::opt::metric_key(), and line::ln::LnSensTable< T >::rows.

evaluation_count()

std::size_t line::opt::LineEvaluator::evaluation_count ( ) const

inline

Definition at line 83 of file evaluator.h.

is_layered()

bool line::opt::LineEvaluator::is_layered ( ) const

inline

Definition at line 80 of file evaluator.h.

Referenced by evaluate(), and evaluate_layered_sensitivities().

---

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

• include/line/opt/evaluator.h