Class to store a solution of a QUBO model using Gurobi Optimizer. More...

#include <qbpp_grb.hpp>

Inheritance diagram for qbpp_grb::Sol:

Collaboration diagram for qbpp_grb::Sol:

[legend]

Public Member Functions
	Sol (const qbpp::QuadModel &quad_model)
	Creates a solution object from a model. More...

qbpp::energy_t	get_bound () const
	Gets the energy bound of the solution. More...

qbpp::energy_t	set_bound (qbpp::energy_t eval)
	Sets the energy bound of the solution. More...

bool	operator== (const Sol &sol) const

bool	operator< (const Sol &sol) const

var_val_t	get (vindex_t index) const

var_val_t	get (Var var) const

energy_t	get (const Expr &expr) const

template<typename T >
auto	get (const Vector< T > &vec) const

bool	has (Var var) const

void	clear ()

void	set (vindex_t index, bool value)

void	set (Var var, bool value)

Sol	set (const Sol &sol)

Sol	set (const MapList &map_list)

virtual void	flip (vindex_t index)

void	flip (Var var)

vindex_t	popcount () const

energy_t	get_energy () const

void	set_energy (energy_t energy)

const impl::BitVector &	get_bit_vector () const

vindex_t	var_count () const

energy_t	get_constant () const

Var	get_var (vindex_t index) const

vindex_t	get_index (Var var) const

	operator MapList () const

Protected Member Functions
energy_t	comp_energy () const

MapList	get_map_list () const

Protected Attributes
const QuadModel	quad_model_

impl::BitVector	bit_vector_

std::optional< energy_t >	energy_ = std::nullopt

Private Attributes
qbpp::energy_t	bound
	Energy Bound obtained by of the Grobi Optimizer. More...

Detailed Description

Class to store a solution of a QUBO model using Gurobi Optimizer.

This class is used to store a solution of a QUBO model obtained by Gurobi Optimizer through QUBO++ library.

Definition at line 120 of file qbpp_grb.hpp.

Member Function Documentation

◆ get_bound()

qbpp::energy_t qbpp_grb::Sol::get_bound ( ) const

inline

Gets the energy bound of the solution.

Returns: Energy bound

Definition at line 136 of file qbpp_grb.hpp.

◆ set_bound()

qbpp::energy_t qbpp_grb::Sol::set_bound ( qbpp::energy_t eval )

inline

Sets the energy bound of the solution.

Returns: Energy bound

Definition at line 140 of file qbpp_grb.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ comp_energy()

energy_t qbpp::Sol::comp_energy ( ) const

inlineprotectedinherited

Definition at line 2809 of file qbpp.hpp.

Here is the caller graph for this function:

◆ get_map_list()

MapList qbpp::Sol::get_map_list ( ) const

inlineprotectedinherited

Definition at line 2834 of file qbpp.hpp.

Here is the call graph for this function:

◆ operator==()

bool qbpp::Sol::operator== ( const Sol & sol ) const

inlineinherited

Definition at line 1487 of file qbpp.hpp.

Here is the call graph for this function:

◆ operator<()

bool qbpp::Sol::operator< ( const Sol & sol ) const

inlineinherited

Definition at line 1491 of file qbpp.hpp.

Here is the call graph for this function:

◆ get() [1/4]

var_val_t qbpp::Sol::get ( vindex_t index ) const

inlineinherited

Definition at line 1500 of file qbpp.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get() [2/4]

var_val_t qbpp::Sol::get ( Var var ) const

inlineinherited

Definition at line 1502 of file qbpp.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get() [3/4]

energy_t qbpp::Sol::get ( const Expr & expr ) const

inlineinherited

Definition at line 1504 of file qbpp.hpp.

Here is the call graph for this function:

◆ get() [4/4]

template<typename T >

auto qbpp::Sol::get ( const Vector< T > & vec ) const

inlineinherited

Definition at line 1514 of file qbpp.hpp.

Here is the call graph for this function:

◆ has()

bool qbpp::Sol::has ( Var var ) const

inlineinherited

Definition at line 1506 of file qbpp.hpp.

Here is the call graph for this function:

◆ clear()

void qbpp::Sol::clear ( )

inlineinherited

Definition at line 1508 of file qbpp.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set() [1/4]

void qbpp::Sol::set	(	vindex_t	index,
		bool	value
	)

inlineinherited

Definition at line 1523 of file qbpp.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set() [2/4]

void qbpp::Sol::set	(	Var	var,
		bool	value
	)

inlineinherited

Definition at line 1528 of file qbpp.hpp.

Here is the call graph for this function:

◆ set() [3/4]

Sol qbpp::Sol::set ( const Sol & sol )

inlineinherited

Definition at line 1566 of file qbpp.hpp.

Here is the call graph for this function:

◆ set() [4/4]

Sol qbpp::Sol::set ( const MapList & map_list )

inlineinherited

Definition at line 1573 of file qbpp.hpp.

Here is the call graph for this function:

◆ flip() [1/2]

virtual void qbpp::Sol::flip ( vindex_t index )

inlinevirtualinherited

Reimplemented in qbpp::exhaustive_solver::SolDelta, qbpp::easy_solver::TabuSolDelta, and qbpp::easy_solver::SolDelta.

Definition at line 1533 of file qbpp.hpp.

Here is the call graph for this function:

◆ flip() [2/2]

void qbpp::Sol::flip ( Var var )

inlineinherited

Definition at line 1538 of file qbpp.hpp.

Here is the call graph for this function:

◆ popcount()

vindex_t qbpp::Sol::popcount ( ) const

inlineinherited

Definition at line 1543 of file qbpp.hpp.

Here is the call graph for this function:

◆ get_energy()

energy_t qbpp::Sol::get_energy ( ) const

inlineinherited

Definition at line 1545 of file qbpp.hpp.

Here is the caller graph for this function:

◆ set_energy()

void qbpp::Sol::set_energy ( energy_t energy )

inlineinherited

Definition at line 1550 of file qbpp.hpp.

Here is the caller graph for this function:

◆ get_bit_vector()

const impl::BitVector& qbpp::Sol::get_bit_vector ( ) const

inlineinherited

Definition at line 1552 of file qbpp.hpp.

◆ var_count()

vindex_t qbpp::Sol::var_count ( ) const

inlineinherited

Definition at line 1556 of file qbpp.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_constant()

energy_t qbpp::Sol::get_constant ( ) const

inlineinherited

Definition at line 1558 of file qbpp.hpp.

Here is the call graph for this function:

◆ get_var()

Var qbpp::Sol::get_var ( vindex_t index ) const

inlineinherited

Definition at line 1560 of file qbpp.hpp.

Here is the call graph for this function:

◆ get_index()

vindex_t qbpp::Sol::get_index ( Var var ) const

inlineinherited

Definition at line 1562 of file qbpp.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator MapList()

qbpp::Sol::operator MapList ( ) const

inlineinherited

Definition at line 1564 of file qbpp.hpp.

Member Data Documentation

◆ bound

qbpp::energy_t qbpp_grb::Sol::bound

private

Energy Bound obtained by of the Grobi Optimizer.

Definition at line 122 of file qbpp_grb.hpp.

◆ quad_model_

const QuadModel qbpp::Sol::quad_model_

protectedinherited

Definition at line 1444 of file qbpp.hpp.

◆ bit_vector_

impl::BitVector qbpp::Sol::bit_vector_

protectedinherited

Definition at line 1446 of file qbpp.hpp.

◆ energy_

std::optional<energy_t> qbpp::Sol::energy_ = std::nullopt

mutableprotectedinherited

Definition at line 1448 of file qbpp.hpp.

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

include/qbpp_grb.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Function Documentation

◆ get_bound()

◆ set_bound()

◆ comp_energy()

◆ get_map_list()

◆ operator==()

◆ operator<()

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ has()

◆ clear()

◆ set() [1/4]

◆ set() [2/4]

◆ set() [3/4]

◆ set() [4/4]

◆ flip() [1/2]

◆ flip() [2/2]

◆ popcount()

◆ get_energy()

◆ set_energy()

◆ get_bit_vector()

◆ var_count()

◆ get_constant()

◆ get_var()

◆ get_index()

◆ operator MapList()

Member Data Documentation

◆ bound

◆ quad_model_

◆ bit_vector_

◆ energy_