EllAlgo 1.6.13
Loading...
Searching...
No Matches
Public Member Functions | List of all members
BSearchAdaptor< Oracle, Space > Class Template Reference

Binary search adaptor wrapping a cutting-plane feasibility oracle. More...

#include <cutting_plane.hpp>

Public Member Functions

 BSearchAdaptor (Oracle &omega, Space &space)
 Construct a new bsearch adaptor object.
 
 BSearchAdaptor (Oracle &omega, Space &space, const Options &options)
 Construct a new bsearch adaptor object.
 
auto x_best () const -> ArrayType
 Get the best x value.
 
template<typename Num >
auto assess_bs (Num &gamma) -> bool
 

Detailed Description

template<typename Oracle, typename Space>
class BSearchAdaptor< Oracle, Space >

Binary search adaptor wrapping a cutting-plane feasibility oracle.

Uses cutting_plane_feas() as a sub-routine to test feasibility at each candidate value, enabling binary search on a parameter.

Note
Adapter pattern: adapts a feasibility oracle (assess_feas) to the binary-search protocol (assess_bs), enabling parameter sweep via feasibility queries. Note the explicit 'Adaptor' name documenting the pattern.
Template Parameters
OracleFeasibility oracle type
SpaceSearch space type

Constructor & Destructor Documentation

◆ BSearchAdaptor() [1/2]

template<typename Oracle , typename Space >
BSearchAdaptor< Oracle, Space >::BSearchAdaptor ( Oracle omega,
Space space 
)
inline

Construct a new bsearch adaptor object.

Parameters
[in,out]omegaperform assessment on x0
[in,out]spacesearch Space containing x*

◆ BSearchAdaptor() [2/2]

template<typename Oracle , typename Space >
BSearchAdaptor< Oracle, Space >::BSearchAdaptor ( Oracle omega,
Space space,
const Options options 
)
inline

Construct a new bsearch adaptor object.

Parameters
[in,out]omegaperform assessment on x0
[in,out]spacesearch space containing x*
[in]optionsmaximum iteration and error tolerance etc.

Member Function Documentation

◆ assess_bs()

template<typename Oracle , typename Space >
template<typename Num >
auto BSearchAdaptor< Oracle, Space >::assess_bs ( Num gamma) -> bool
inline
Template Parameters
Num
Parameters
[in,out]gammathe best-so-far optimal value
Returns
bool

◆ x_best()

template<typename Oracle , typename Space >
auto BSearchAdaptor< Oracle, Space >::x_best ( ) const -> ArrayType
inline

Get the best x value.

Returns
ArrayType The best x value.

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