abs2::Param Class Reference

Class to store parameters for ABS2 QUBO solver. More...

#include <abs2.hpp>

Inheritance diagram for abs2::Param:

Public Member Functions
	Param ()
	Constructor for creating param object with empty parameters. More...
	~Param ()
	Destructor. More...
	Param (const Param &param)
	Copy Constructor with copying "param". More...
Param &	operator= (const Param &param)
	Assignment overload with copying "param". More...
void	set (const std::string &key, const std::string &val)
	Set "val" to "key". More...
std::string	get (const std::string &key) const
	Get the value of "key". More...
void	set (Callback &callback)
	Set Callback function to ABS2. More...
void	print (const std::string &option="", std::ostream &output_stream=std::cout) const
	Output parameters in stream "output_stream". More...
void	print (std::ostream &output_stream, const std::string &option="") const
	Output parameters in stream "output_stream". More...

Private Attributes
std::unique_ptr< Impl >	pimpl

Detailed Description

Class to store parameters for ABS2 QUBO solver.

Definition at line 162 of file abs2.hpp.

Constructor & Destructor Documentation

Param() [1/2]

abs2::Param::Param

(

)

Constructor for creating param object with empty parameters.

~Param()

abs2::Param::~Param

(

)

Destructor.

Param() [2/2]

abs2::Param::Param

(

const Param &

param

)

Copy Constructor with copying "param".

Parameters

param

Param object to be copied

Member Function Documentation

operator=()

Param& abs2::Param::operator=

(

const Param &

param

)

Assignment overload with copying "param".

Parameters

param

Param object to be copied

Returns

Param object

set() [1/2]

void abs2::Param::set	(	const std::string &	key,
		const std::string &	val
	)

Set "val" to "key".

Parameters

key	Parameter key
val	Parameter value

Here is the caller graph for this function:

get()

std::string abs2::Param::get

(

const std::string &

key

)

const

Get the value of "key".

Parameters

key	Parameter key

Returns

Parameter value

set() [2/2]

void abs2::Param::set

(

Callback &

callback

)

Set Callback function to ABS2.

Parameters

callback

Callback class object that includes user-defined callback function

The callback function in the class object "callback" is called during the optimization process of ABS2.

print() [1/2]

void abs2::Param::print	(	const std::string &	option = "",
		std::ostream &	output_stream = std::cout
	)		const

Output parameters in stream "output_stream".

Parameters

option	Format option
output_stream	Output stream

print() [2/2]

void abs2::Param::print	(	std::ostream &	output_stream,
		const std::string &	option = ""
	)		const

Output parameters in stream "output_stream".

Parameters

output_stream	Output stream
option	Format option

Member Data Documentation

pimpl

std::unique_ptr<Impl> abs2::Param::pimpl

private

Definition at line 201 of file abs2.hpp.

---

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

• include/abs2.hpp