Generated on for Gecode by doxygen 1.17.0
Gecode::MetaInfo Class Reference

Information passed by meta search engines. More...

#include <gecode/kernel/core.hpp>

Public Types

enum  Type { RESTART , PORTFOLIO }
 Which type of information is provided. More...
enum  RestartReason {
  RR_NO , RR_INIT , RR_SOL , RR_CMPL ,
  RR_LIM
}
 Reason for restarting. More...

Protected Attributes

const Type t
 Type of information.

Restart-based information

const unsigned long int r
 Number of restarts.
const RestartReason rr
 Reason for restarting.
const unsigned long long int s
 Number of solutions since last restart.
const unsigned long long int f
 Number of failures since last restart.
const Spacel
 Last solution found.
const NoGoodsng
 No-goods from restart.
unsigned long int restart (void) const
 Return number of restarts.
RestartReason reason (void) const
 Return reason for restarting.
unsigned long long int solution (void) const
 Return number of solutions since last restart.
unsigned long long int fail (void) const
 Return number of failures since last restart.
const Spacelast (void) const
 Return last solution found (possibly nullptr).
const NoGoodsnogoods (void) const
 Return no-goods recorded from restart.

Portfolio-based information

const unsigned int a
 Number of asset in portfolio.
unsigned int asset (void) const
 Return number of asset in portfolio.

Constructors depending on type of engine

 MetaInfo (unsigned long int r, RestartReason rr, unsigned long long int s, unsigned long long int f, const Space *l, NoGoods &ng)
 Constructor for restart-based engine.
 MetaInfo (unsigned int a)
 Constructor for portfolio-based engine.
Type type (void) const
 Return type of information.

Detailed Description

Information passed by meta search engines.

Definition at line 1628 of file core.hpp.

Member Enumeration Documentation

◆ Type

Which type of information is provided.

Enumerator
RESTART 

Information is provided by a restart-based engine.

PORTFOLIO 

Information is provided by a portfolio-based engine.

Definition at line 1631 of file core.hpp.

◆ RestartReason

Reason for restarting.

Enumerator
RR_NO 

No reason - used for PORTFOLIO.

RR_INIT 

Restarting after initialisation.

RR_SOL 

Restarting after a solution is found.

RR_CMPL 

Restarting after exhausting search space.

RR_LIM 

Restarting after reaching restart limit.

Definition at line 1638 of file core.hpp.

Constructor & Destructor Documentation

◆ MetaInfo() [1/2]

Gecode::MetaInfo::MetaInfo ( unsigned long int r,
RestartReason rr,
unsigned long long int s,
unsigned long long int f,
const Space * l,
NoGoods & ng )
inline

Constructor for restart-based engine.

Definition at line 3147 of file core.hpp.

◆ MetaInfo() [2/2]

Gecode::MetaInfo::MetaInfo ( unsigned int a)
inline

Constructor for portfolio-based engine.

Definition at line 3156 of file core.hpp.

Member Function Documentation

◆ type()

MetaInfo::Type Gecode::MetaInfo::type ( void ) const
inline

Return type of information.

Definition at line 3160 of file core.hpp.

◆ restart()

unsigned long int Gecode::MetaInfo::restart ( void ) const
inline

Return number of restarts.

Definition at line 3164 of file core.hpp.

◆ reason()

MetaInfo::RestartReason Gecode::MetaInfo::reason ( void ) const
inline

Return reason for restarting.

Definition at line 3169 of file core.hpp.

◆ solution()

unsigned long long int Gecode::MetaInfo::solution ( void ) const
inline

Return number of solutions since last restart.

Definition at line 3173 of file core.hpp.

◆ fail()

unsigned long long int Gecode::MetaInfo::fail ( void ) const
inline

Return number of failures since last restart.

Definition at line 3178 of file core.hpp.

◆ last()

const Space * Gecode::MetaInfo::last ( void ) const
inline

Return last solution found (possibly nullptr).

Definition at line 3183 of file core.hpp.

◆ nogoods()

const NoGoods & Gecode::MetaInfo::nogoods ( void ) const
inline

Return no-goods recorded from restart.

Definition at line 3188 of file core.hpp.

◆ asset()

unsigned int Gecode::MetaInfo::asset ( void ) const
inline

Return number of asset in portfolio.

Definition at line 3193 of file core.hpp.

Member Data Documentation

◆ t

const Type Gecode::MetaInfo::t
protected

Type of information.

Definition at line 1652 of file core.hpp.

◆ r

const unsigned long int Gecode::MetaInfo::r
protected

Number of restarts.

Definition at line 1656 of file core.hpp.

◆ rr

const RestartReason Gecode::MetaInfo::rr
protected

Reason for restarting.

Definition at line 1658 of file core.hpp.

◆ s

const unsigned long long int Gecode::MetaInfo::s
protected

Number of solutions since last restart.

Definition at line 1660 of file core.hpp.

◆ f

const unsigned long long int Gecode::MetaInfo::f
protected

Number of failures since last restart.

Definition at line 1662 of file core.hpp.

◆ l

const Space* Gecode::MetaInfo::l
protected

Last solution found.

Definition at line 1664 of file core.hpp.

◆ ng

const NoGoods& Gecode::MetaInfo::ng
protected

No-goods from restart.

Definition at line 1666 of file core.hpp.

◆ a

const unsigned int Gecode::MetaInfo::a
protected

Number of asset in portfolio.

Definition at line 1671 of file core.hpp.


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