operations_research::sat::VariablesShavingSolver Class Reference

#include <shaving_solver.h>

Inheritance diagram for operations_research::sat::VariablesShavingSolver:

Classes
struct	State

Public Member Functions
	VariablesShavingSolver (const SatParameters &local_parameters, SharedClasses *shared)
	~VariablesShavingSolver () override
bool	TaskIsAvailable () override
void	ProcessLocalResponse (const CpSolverResponse &local_response, const State &state)
std::function< void()>	GenerateTask (int64_t task_id) override
void	Synchronize () override
Public Member Functions inherited from operations_research::sat::SubSolver
	SubSolver (absl::string_view name, SubsolverType type)
virtual	~SubSolver ()=default
virtual bool	IsDone ()
double	deterministic_time () const
std::string	name () const
	Returns the name of this SubSolver. Used in logs.
SubsolverType	type () const
	Returns the type of the subsolver.
void	AddTaskDuration (double duration_in_seconds)
void	AddTaskDeterministicDuration (double deterministic_duration)
std::string	TimingInfo () const
std::string	DeterministicTimingInfo () const

Additional Inherited Members
Public Types inherited from operations_research::sat::SubSolver
enum	SubsolverType { FULL_PROBLEM , FIRST_SOLUTION , INCOMPLETE , HELPER }

Detailed Description

Definition at line 80 of file shaving_solver.h.

Constructor & Destructor Documentation

VariablesShavingSolver()

operations_research::sat::VariablesShavingSolver::VariablesShavingSolver	(	const SatParameters &	local_parameters,
		SharedClasses *	shared )

Definition at line 254 of file shaving_solver.cc.

~VariablesShavingSolver()

operations_research::sat::VariablesShavingSolver::~VariablesShavingSolver ( )

override

Definition at line 271 of file shaving_solver.cc.

Member Function Documentation

GenerateTask()

std::function< void()> operations_research::sat::VariablesShavingSolver::GenerateTask ( int64_t task_id )

overridevirtual

Returns a task to run. The task_id is just an ever increasing counter that correspond to the number of total calls to GenerateTask().

Todo

(user): We could use a more complex selection logic and pass in the deterministic time limit this subtask should run for. Unclear at this stage.

This is only called by the main thread.

Implements operations_research::sat::SubSolver.

Definition at line 314 of file shaving_solver.cc.

ProcessLocalResponse()

void operations_research::sat::VariablesShavingSolver::ProcessLocalResponse	(	const CpSolverResponse &	local_response,
		const State &	state )

Definition at line 287 of file shaving_solver.cc.

Synchronize()

void operations_research::sat::VariablesShavingSolver::Synchronize ( )

overridevirtual

Synchronizes with the external world from this SubSolver point of view. Also incorporate the results of the latest completed tasks if any.

Note(user): The intended implementation for determinism is that tasks update asynchronously (and so non-deterministically) global "shared" classes, but this global state is incorporated by the Subsolver only when Synchronize() is called.

This is only called by the main thread in Subsolver creation order.

We are just waiting for the inner code to check the time limit or to return nicely.

Implements operations_research::sat::SubSolver.

Definition at line 334 of file shaving_solver.cc.

TaskIsAvailable()

bool operations_research::sat::VariablesShavingSolver::TaskIsAvailable ( )

overridevirtual

Returns true iff GenerateTask() can be called. This is only called by the main thread in a sequential fashion.

Implements operations_research::sat::SubSolver.

Definition at line 283 of file shaving_solver.cc.

---

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

• ortools/sat/shaving_solver.h
• ortools/sat/shaving_solver.cc