ortools.constraint_solver.pywrapcp.SearchMonitor Class Reference

Inheritance diagram for ortools.constraint_solver.pywrapcp.SearchMonitor:

Public Member Functions
	__init__ (self, s)
	EnterSearch (self)
	RestartSearch (self)
	ExitSearch (self)
	BeginNextDecision (self, b)
	EndNextDecision (self, b, d)
	ApplyDecision (self, d)
	RefuteDecision (self, d)
	AfterDecision (self, d, apply)
	BeginFail (self)
	EndFail (self)
	BeginInitialPropagation (self)
	EndInitialPropagation (self)
	AcceptSolution (self)
	AtSolution (self)
	NoMoreSolutions (self)
	LocalOptimum (self)
	AcceptDelta (self, delta, deltadelta)
	AcceptNeighbor (self)
	ProgressPercent (self)
	solver (self)
	__repr__ (self)
	__str__ (self)
	__disown__ (self)
Public Member Functions inherited from ortools.constraint_solver.pywrapcp.BaseObject
	DebugString (self)

Static Public Attributes
	kNoProgress = _pywrapcp.SearchMonitor_kNoProgress

Properties
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
Properties inherited from ortools.constraint_solver.pywrapcp.BaseObject
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Detailed Description

 A search monitor is a simple set of callbacks to monitor all search events

Definition at line 2234 of file pywrapcp.py.

Constructor & Destructor Documentation

__init__()

ortools.constraint_solver.pywrapcp.SearchMonitor.__init__	(		self,
			s )

Reimplemented from ortools.constraint_solver.pywrapcp.BaseObject.

Reimplemented in ortools.constraint_solver.pywrapcp.SearchLimit, and ortools.constraint_solver.pywrapcp.SolutionCollector.

Definition at line 2240 of file pywrapcp.py.

Member Function Documentation

__disown__()

ortools.constraint_solver.pywrapcp.SearchMonitor.__disown__

(

self

)

Reimplemented from ortools.constraint_solver.pywrapcp.BaseObject.

Definition at line 2349 of file pywrapcp.py.

__repr__()

ortools.constraint_solver.pywrapcp.SearchMonitor.__repr__

(

self

)

Reimplemented from ortools.constraint_solver.pywrapcp.BaseObject.

Definition at line 2344 of file pywrapcp.py.

__str__()

ortools.constraint_solver.pywrapcp.SearchMonitor.__str__

(

self

)

Reimplemented from ortools.constraint_solver.pywrapcp.BaseObject.

Definition at line 2347 of file pywrapcp.py.

AcceptDelta()

ortools.constraint_solver.pywrapcp.SearchMonitor.AcceptDelta	(		self,
			delta,
			deltadelta )

Definition at line 2326 of file pywrapcp.py.

AcceptNeighbor()

ortools.constraint_solver.pywrapcp.SearchMonitor.AcceptNeighbor

(

self

)

 After accepting a neighbor during local search.

Definition at line 2330 of file pywrapcp.py.

AcceptSolution()

ortools.constraint_solver.pywrapcp.SearchMonitor.AcceptSolution

(

self

)

    This method is called when a solution is found. It asserts whether the
    solution is valid. A value of false indicates that the solution
    should be discarded.

Definition at line 2299 of file pywrapcp.py.

AfterDecision()

ortools.constraint_solver.pywrapcp.SearchMonitor.AfterDecision	(		self,
			d,
			apply )

    Just after refuting or applying the decision, apply is true after Apply.
    This is called only if the Apply() or Refute() methods have not failed.

Definition at line 2276 of file pywrapcp.py.

ApplyDecision()

ortools.constraint_solver.pywrapcp.SearchMonitor.ApplyDecision	(		self,
			d )

 Before applying the decision.

Definition at line 2268 of file pywrapcp.py.

AtSolution()

ortools.constraint_solver.pywrapcp.SearchMonitor.AtSolution

(

self

)

    This method is called when a valid solution is found. If the
    return value is true, then search will resume after. If the result
    is false, then search will stop there.

Definition at line 2307 of file pywrapcp.py.

BeginFail()

ortools.constraint_solver.pywrapcp.SearchMonitor.BeginFail

(

self

)

 Just when the failure occurs.

Definition at line 2283 of file pywrapcp.py.

BeginInitialPropagation()

ortools.constraint_solver.pywrapcp.SearchMonitor.BeginInitialPropagation

(

self

)

 Before the initial propagation.

Definition at line 2291 of file pywrapcp.py.

BeginNextDecision()

ortools.constraint_solver.pywrapcp.SearchMonitor.BeginNextDecision	(		self,
			b )

 Before calling DecisionBuilder::Next.

Reimplemented in ortools.constraint_solver.pywrapcp.SearchLimit.

Definition at line 2260 of file pywrapcp.py.

EndFail()

ortools.constraint_solver.pywrapcp.SearchMonitor.EndFail

(

self

)

 After completing the backtrack.

Definition at line 2287 of file pywrapcp.py.

EndInitialPropagation()

ortools.constraint_solver.pywrapcp.SearchMonitor.EndInitialPropagation

(

self

)

 After the initial propagation.

Definition at line 2295 of file pywrapcp.py.

EndNextDecision()

ortools.constraint_solver.pywrapcp.SearchMonitor.EndNextDecision	(		self,
			b,
			d )

 After calling DecisionBuilder::Next, along with the returned decision.

Definition at line 2264 of file pywrapcp.py.

EnterSearch()

ortools.constraint_solver.pywrapcp.SearchMonitor.EnterSearch

(

self

)

 Beginning of the search.

Reimplemented in ortools.constraint_solver.pywrapcp.SearchLimit, and ortools.constraint_solver.pywrapcp.SolutionCollector.

Definition at line 2248 of file pywrapcp.py.

ExitSearch()

ortools.constraint_solver.pywrapcp.SearchMonitor.ExitSearch

(

self

)

 End of the search.

Definition at line 2256 of file pywrapcp.py.

LocalOptimum()

ortools.constraint_solver.pywrapcp.SearchMonitor.LocalOptimum

(

self

)

    When a local optimum is reached. If 'true' is returned, the last solution
    is discarded and the search proceeds with the next one.

Definition at line 2319 of file pywrapcp.py.

NoMoreSolutions()

ortools.constraint_solver.pywrapcp.SearchMonitor.NoMoreSolutions

(

self

)

 When the search tree is finished.

Definition at line 2315 of file pywrapcp.py.

ProgressPercent()

ortools.constraint_solver.pywrapcp.SearchMonitor.ProgressPercent

(

self

)

    Returns a percentage representing the propress of the search before
    reaching limits.

Definition at line 2334 of file pywrapcp.py.

RefuteDecision()

ortools.constraint_solver.pywrapcp.SearchMonitor.RefuteDecision	(		self,
			d )

 Before refuting the decision.

Reimplemented in ortools.constraint_solver.pywrapcp.SearchLimit.

Definition at line 2272 of file pywrapcp.py.

RestartSearch()

ortools.constraint_solver.pywrapcp.SearchMonitor.RestartSearch

(

self

)

 Restart the search.

Definition at line 2252 of file pywrapcp.py.

solver()

ortools.constraint_solver.pywrapcp.SearchMonitor.solver

(

self

)

Definition at line 2341 of file pywrapcp.py.

Member Data Documentation

kNoProgress

ortools.constraint_solver.pywrapcp.SearchMonitor.kNoProgress = _pywrapcp.SearchMonitor_kNoProgress

static

Definition at line 2238 of file pywrapcp.py.

Property Documentation

thisown

ortools.constraint_solver.pywrapcp.SearchMonitor.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static

Definition at line 2237 of file pywrapcp.py.

---

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

• build/python/ortools/constraint_solver/pywrapcp.py