ConicBundle
Public Member Functions | Private Attributes | List of all members
ConicBundle::SOCSupportMinorantExtender Class Reference

Implementation of MinorantExtender for SOCSupportFunction. More...

#include <SOCSupportFunction.hxx>

Inheritance diagram for ConicBundle::SOCSupportMinorantExtender:
ConicBundle::CBout ConicBundle::MinorantExtender

Public Member Functions

 SOCSupportMinorantExtender (SOCSupportFunction *fun)
 the SOCSupportFunction pointed to has to be valid for the livetime of this object
 
int extend (Minorant &minorant, int n_coords, const int *indices)
 called by ConicBundle to update internal Minorant objects, has to return 0 on success More...
 
- Public Member Functions inherited from ConicBundle::CBout
virtual void set_out (std::ostream *out=0, int print_level=1)
 Specifies the output level (out==NULL: no output at all, out!=NULL and level=0: errors and warnings, level>0 increasingly detailed information) More...
 
virtual void set_cbout (const CBout *cb, int incr=-1)
 Specifies the output level relative to the given CBout class. More...
 
void clear_cbout ()
 reset to default settings (out=0,print_level=1)
 
 CBout (const CBout *cb=0, int incr=-1)
 calls set_cbout
 
 CBout (std::ostream *outp, int pl=1)
 initialize correspondingly
 
 CBout (const CBout &cb, int incr=0)
 copy constructor
 
virtual bool cb_out (int pl=-1) const
 Returns true if out!=0 and (pl<print_level), pl<0 should be used for WARNINGS and ERRORS only, pl==0 for usual output.
 
std::ostream & get_out () const
 If cb_out() returned true, this returns the output stream, but it will abort if called with out==0.
 
std::ostream * get_out_ptr () const
 returns the pointer to the output stream
 
int get_print_level () const
 returns the print_level
 
virtual int mfile_data (std::ostream &out) const
 writes problem data to the given outstream
 

Private Attributes

SOCSupportFunctionfun
 the oracle this MinorantExtender was generated by, needed for retrieving problem data
 

Detailed Description

Implementation of MinorantExtender for SOCSupportFunction.

This object will be returned as an object on the heap by SOCSupportFunction::apply_modification and will be deleted by ConicBundle after use. Its purpose is to fill up further coordinates of the minorant (if this is possible).

Member Function Documentation

◆ extend()

int ConicBundle::SOCSupportMinorantExtender::extend ( Minorant minorant,
int  n_coords,
const int *  indices 
)
virtual

called by ConicBundle to update internal Minorant objects, has to return 0 on success

Parameters
[in,out]minorant(Minorant&) it holds a (possibly aggregated) minorant that was generated from minorants returned by oracle calls, e.g. as in FunctionOracle::evaluate() If PrimalData was provided in these minorants, this will be aggregated along and will also be available in this minorant.
[in]n_coords(int) the number of coordinate positions that have to be filled in
[out]indices(const int*) the indices of these coordinate positions (sorted in strictly increasing order)
Returns
  • 0 on success,
  • 1 if extension is impossible

Implements ConicBundle::MinorantExtender.


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