Class to store the QUBO expression for the Traveling Salesman Problem (TSP). More...

#include <qbpp_tsp.hpp>

Inheritance diagram for qbpp::tsp::TSPQuadModel:

Collaboration diagram for qbpp::tsp::TSPQuadModel:

[legend]

Public Member Functions
	TSPQuadModel (const TSPMap &map, bool fix_first=false)
	Generate a QUBO expression for the Traveling Salesman Problem (TSP) from a map. More...

uint32_t	node_count () const
	Returns the number of nodes in the TSP. More...

qbpp::Var	get_var (uint32_t i, uint32_t j) const
	Get the variable at (i, j). More...

bool	get_fix_first () const
	Returns true if the first node is fixed to node 0. More...

const std::vector< coeff_t > &	get_linear () const

coeff_t	get_linear (vindex_t index) const

const std::vector< vindex_t > &	get_degree () const

vindex_t	get_degree (vindex_t index) const

const std::vector< std::vector< std::pair< vindex_t, coeff_t > > > &	get_quadratic () const

std::pair< vindex_t, coeff_t >	get_quadratic (vindex_t i, vindex_t j) const

size_t	term_count (vindex_t deg) const

size_t	term_count () const override

coeff_t	get_min_coeff () const

coeff_t	get_max_coeff () const

vindex_t	var_count () const

Var	get_var (vindex_t index) const

vindex_t	get_index (Var var) const

bool	has (Var var) const

const Expr &	get_expr () const

	operator const Expr & () const

energy_t	get_constant () const

const Terms &	get_terms () const

std::vector< Var >	get_index_var () const

Static Protected Member Functions
static const Expr &	check_expr (const Expr &expr)

static Expr	check_expr (Expr &&expr)

Protected Attributes
const std::shared_ptr< const Expr >	expr_ptr_

const std::shared_ptr< const impl::IndexVarMapper >	index_var_ptr_

Private Member Functions
std::tuple< qbpp::Model, bool, qbpp::Vector< qbpp::Vector< qbpp::Var > > >	helper_func (const TSPMap &map, bool fix_first)
	Generate a QUBO expression for the Traveling Salesman Problem (TSP). More...

	TSPQuadModel (std::tuple< qbpp::QuadModel, bool, qbpp::Vector< qbpp::Vector< qbpp::Var >>> tuple)

Private Attributes
const bool	fix_first
	true if the first node is fixed to node 0. More...

const qbpp::Vector< qbpp::Vector< qbpp::Var > >	x
	Variables for the TSP. More...

const std::shared_ptr< const Impl >	pimpl_

const std::vector< coeff_t > &	linear_

const std::vector< vindex_t > &	degree_

const std::vector< std::vector< std::pair< vindex_t, coeff_t > > > &	quadratic_

Detailed Description

Class to store the QUBO expression for the Traveling Salesman Problem (TSP).

Definition at line 103 of file qbpp_tsp.hpp.

Constructor & Destructor Documentation

◆ TSPQuadModel() [1/2]

qbpp::tsp::TSPQuadModel::TSPQuadModel ( std::tuple< qbpp::QuadModel, bool, qbpp::Vector< qbpp::Vector< qbpp::Var >>> tuple )

inlineprivate

Definition at line 116 of file qbpp_tsp.hpp.

◆ TSPQuadModel() [2/2]

qbpp::tsp::TSPQuadModel::TSPQuadModel	(	const TSPMap &	map,
		bool	fix_first = `false`
	)

inline

Generate a QUBO expression for the Traveling Salesman Problem (TSP) from a map.

Parameters

map	Map of nodes with their coordinates
fix_first	true if the first node is fixed to node 0

Definition at line 128 of file qbpp_tsp.hpp.

Member Function Documentation

◆ helper_func()

std::tuple< qbpp::Model, bool, qbpp::Vector< qbpp::Vector< qbpp::Var > > > qbpp::tsp::TSPQuadModel::helper_func	(	const TSPMap &	map,
		bool	fix_first
	)

inlineprivate

Generate a QUBO expression for the Traveling Salesman Problem (TSP).

Returns: QUBO expression for the Traveling Salesman Problem (TSP).

Note: Helper function for the constructor.

Definition at line 309 of file qbpp_tsp.hpp.

Here is the call graph for this function:

◆ node_count()

uint32_t qbpp::tsp::TSPQuadModel::node_count ( ) const

inline

Returns the number of nodes in the TSP.

Returns: Number of nodes in the TSP.

Definition at line 133 of file qbpp_tsp.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_var() [1/2]

qbpp::Var qbpp::tsp::TSPQuadModel::get_var	(	uint32_t	i,
		uint32_t	j
	)		const

inline

Get the variable at (i, j).

Definition at line 136 of file qbpp_tsp.hpp.

Here is the caller graph for this function:

◆ get_fix_first()

bool qbpp::tsp::TSPQuadModel::get_fix_first ( ) const

inline

Returns true if the first node is fixed to node 0.

Definition at line 139 of file qbpp_tsp.hpp.

Here is the caller graph for this function:

◆ get_linear() [1/2]

const std::vector<coeff_t>& qbpp::QuadModel::get_linear ( ) const

inlineinherited

Definition at line 1241 of file qbpp.hpp.

Here is the caller graph for this function:

◆ get_linear() [2/2]

coeff_t qbpp::QuadModel::get_linear ( vindex_t index ) const

inlineinherited

Definition at line 1250 of file qbpp.hpp.

◆ get_degree() [1/2]

const std::vector<vindex_t>& qbpp::QuadModel::get_degree ( ) const

inlineinherited

Definition at line 1243 of file qbpp.hpp.

Here is the caller graph for this function:

◆ get_degree() [2/2]

vindex_t qbpp::QuadModel::get_degree ( vindex_t index ) const

inlineinherited

Definition at line 1252 of file qbpp.hpp.

◆ get_quadratic() [1/2]

const std::vector<std::vector<std::pair<vindex_t, coeff_t> > >& qbpp::QuadModel::get_quadratic ( ) const

inlineinherited

Definition at line 1245 of file qbpp.hpp.

Here is the caller graph for this function:

◆ get_quadratic() [2/2]

std::pair<vindex_t, coeff_t> qbpp::QuadModel::get_quadratic	(	vindex_t	i,
		vindex_t	j
	)		const

inlineinherited

Definition at line 1254 of file qbpp.hpp.

◆ term_count() [1/2]

size_t qbpp::QuadModel::term_count ( vindex_t deg ) const

inlineinherited

Definition at line 1258 of file qbpp.hpp.

Here is the caller graph for this function:

◆ term_count() [2/2]

size_t qbpp::QuadModel::term_count ( ) const

inlineoverridevirtualinherited

Reimplemented from qbpp::Model.

Definition at line 1268 of file qbpp.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_min_coeff()

coeff_t qbpp::QuadModel::get_min_coeff ( ) const

inlineinherited

Definition at line 1270 of file qbpp.hpp.

Here is the caller graph for this function:

◆ get_max_coeff()

coeff_t qbpp::QuadModel::get_max_coeff ( ) const

inlineinherited

Definition at line 1272 of file qbpp.hpp.

Here is the caller graph for this function:

◆ check_expr() [1/2]

static const Expr& qbpp::Model::check_expr ( const Expr & expr )

inlinestaticprotectedinherited

Definition at line 1111 of file qbpp.hpp.

Here is the call graph for this function:

◆ check_expr() [2/2]

static Expr qbpp::Model::check_expr ( Expr && expr )

inlinestaticprotectedinherited

Definition at line 1120 of file qbpp.hpp.

Here is the call graph for this function:

◆ var_count()

vindex_t qbpp::Model::var_count ( ) const

inlineinherited

Definition at line 1154 of file qbpp.hpp.

Here is the caller graph for this function:

◆ get_var() [2/2]

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

inlineinherited

Definition at line 1156 of file qbpp.hpp.

Here is the caller graph for this function:

◆ get_index()

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

inlineinherited

Definition at line 1158 of file qbpp.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ has()

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

inlineinherited

Definition at line 1160 of file qbpp.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_expr()

const Expr& qbpp::Model::get_expr ( ) const

inlineinherited

Definition at line 1164 of file qbpp.hpp.

Here is the caller graph for this function:

◆ operator const Expr &()

qbpp::Model::operator const Expr & ( ) const

inlineinherited

Definition at line 1166 of file qbpp.hpp.

◆ get_constant()

energy_t qbpp::Model::get_constant ( ) const

inlineinherited

Definition at line 1168 of file qbpp.hpp.

Here is the caller graph for this function:

◆ get_terms()

const Terms& qbpp::Model::get_terms ( ) const

inlineinherited

Definition at line 1170 of file qbpp.hpp.

◆ get_index_var()

std::vector<Var> qbpp::Model::get_index_var ( ) const

inlineinherited

Definition at line 1172 of file qbpp.hpp.

Here is the caller graph for this function:

Member Data Documentation

◆ fix_first

const bool qbpp::tsp::TSPQuadModel::fix_first

private

true if the first node is fixed to node 0.

Definition at line 105 of file qbpp_tsp.hpp.

◆ x

const qbpp::Vector<qbpp::Vector<qbpp::Var> > qbpp::tsp::TSPQuadModel::x

private

Variables for the TSP.

Definition at line 107 of file qbpp_tsp.hpp.

◆ pimpl_

const std::shared_ptr<const Impl> qbpp::QuadModel::pimpl_

privateinherited

Definition at line 1195 of file qbpp.hpp.

◆ linear_

const std::vector<coeff_t>& qbpp::QuadModel::linear_

privateinherited

Definition at line 1197 of file qbpp.hpp.

◆ degree_

const std::vector<vindex_t>& qbpp::QuadModel::degree_

privateinherited

Definition at line 1199 of file qbpp.hpp.

◆ quadratic_

const std::vector<std::vector<std::pair<vindex_t, coeff_t> > >& qbpp::QuadModel::quadratic_

privateinherited

Definition at line 1201 of file qbpp.hpp.

◆ expr_ptr_

const std::shared_ptr<const Expr> qbpp::Model::expr_ptr_

protectedinherited

Definition at line 1107 of file qbpp.hpp.

◆ index_var_ptr_

const std::shared_ptr<const impl::IndexVarMapper> qbpp::Model::index_var_ptr_

protectedinherited

Definition at line 1109 of file qbpp.hpp.

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

sample/qbpp_tsp.hpp

Public Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TSPQuadModel() [1/2]

◆ TSPQuadModel() [2/2]

Member Function Documentation

◆ helper_func()

◆ node_count()

◆ get_var() [1/2]

◆ get_fix_first()

◆ get_linear() [1/2]

◆ get_linear() [2/2]

◆ get_degree() [1/2]

◆ get_degree() [2/2]

◆ get_quadratic() [1/2]

◆ get_quadratic() [2/2]

◆ term_count() [1/2]

◆ term_count() [2/2]

◆ get_min_coeff()

◆ get_max_coeff()

◆ check_expr() [1/2]

◆ check_expr() [2/2]

◆ var_count()

◆ get_var() [2/2]

◆ get_index()

◆ has()

◆ get_expr()

◆ operator const Expr &()

◆ get_constant()

◆ get_terms()

◆ get_index_var()

Member Data Documentation

◆ fix_first

◆ x

◆ pimpl_

◆ linear_

◆ degree_

◆ quadratic_

◆ expr_ptr_

◆ index_var_ptr_