Google OR-Tools v9.12
a fast and portable software suite for combinatorial optimization
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
ortools.constraint_solver.pywrapcp.SolutionCollector Class Reference
Inheritance diagram for ortools.constraint_solver.pywrapcp.SolutionCollector:
ortools.constraint_solver.pywrapcp.SearchMonitor ortools.constraint_solver.pywrapcp.BaseObject

Public Member Functions

 __init__ (self, *args, **kwargs)
 
 DebugString (self)
 
 Add (self, *args)
 
 AddObjective (self, objective)
 
 EnterSearch (self)
 
 SolutionCount (self)
 
 Solution (self, n)
 
 WallTime (self, n)
 
 Branches (self, n)
 
 Failures (self, n)
 
 ObjectiveValue (self, n)
 
 Value (self, n, var)
 
 StartValue (self, n, var)
 
 EndValue (self, n, var)
 
 DurationValue (self, n, var)
 
 PerformedValue (self, n, var)
 
 ForwardSequence (self, n, var)
 
 BackwardSequence (self, n, var)
 
 Unperformed (self, n, var)
 
- Public Member Functions inherited from ortools.constraint_solver.pywrapcp.SearchMonitor
 __init__ (self, s)
 
 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
 __init__ (self)
 
 __str__ (self)
 
 __repr__ (self)
 
 __disown__ (self)
 

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.SearchMonitor
 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")
 

Additional Inherited Members

- Static Public Attributes inherited from ortools.constraint_solver.pywrapcp.SearchMonitor
 kNoProgress = _pywrapcp.SearchMonitor_kNoProgress
 

Detailed Description

This class is the root class of all solution collectors.
It implements a basic query API to be used independently
of the collector used.

Definition at line 2917 of file pywrapcp.py.

Constructor & Destructor Documentation

◆ __init__()

ortools.constraint_solver.pywrapcp.SolutionCollector.__init__ ( self,
* args,
** kwargs )

Definition at line 2926 of file pywrapcp.py.

Member Function Documentation

◆ Add()

ortools.constraint_solver.pywrapcp.SolutionCollector.Add ( self,
* args ) 
Add API.

Definition at line 2933 of file pywrapcp.py.

◆ AddObjective()

ortools.constraint_solver.pywrapcp.SolutionCollector.AddObjective ( self,
objective )

Definition at line 2937 of file pywrapcp.py.

◆ BackwardSequence()

ortools.constraint_solver.pywrapcp.SolutionCollector.BackwardSequence ( self,
n,
var ) 
    This is a shortcut to get the BackwardSequence of 'var' in the
    nth solution. The backward sequence is the list of ranked interval
    variables starting from the end of the sequence.

Definition at line 2999 of file pywrapcp.py.

◆ Branches()

ortools.constraint_solver.pywrapcp.SolutionCollector.Branches ( self,
n ) 
Returns the number of branches when the nth solution was found.

Definition at line 2956 of file pywrapcp.py.

◆ DebugString()

ortools.constraint_solver.pywrapcp.SolutionCollector.DebugString ( self)

Reimplemented from ortools.constraint_solver.pywrapcp.BaseObject.

Definition at line 2930 of file pywrapcp.py.

◆ DurationValue()

ortools.constraint_solver.pywrapcp.SolutionCollector.DurationValue ( self,
n,
var ) 
This is a shortcut to get the DurationValue of 'var' in the nth solution.

Definition at line 2983 of file pywrapcp.py.

◆ EndValue()

ortools.constraint_solver.pywrapcp.SolutionCollector.EndValue ( self,
n,
var ) 
This is a shortcut to get the EndValue of 'var' in the nth solution.

Definition at line 2979 of file pywrapcp.py.

◆ EnterSearch()

ortools.constraint_solver.pywrapcp.SolutionCollector.EnterSearch ( self) 
Beginning of the search.

Reimplemented from ortools.constraint_solver.pywrapcp.SearchMonitor.

Definition at line 2940 of file pywrapcp.py.

◆ Failures()

ortools.constraint_solver.pywrapcp.SolutionCollector.Failures ( self,
n ) 
    Returns the number of failures encountered at the time of the nth
    solution.

Definition at line 2960 of file pywrapcp.py.

◆ ForwardSequence()

ortools.constraint_solver.pywrapcp.SolutionCollector.ForwardSequence ( self,
n,
var ) 
    This is a shortcut to get the ForwardSequence of 'var' in the
    nth solution. The forward sequence is the list of ranked interval
    variables starting from the start of the sequence.

Definition at line 2991 of file pywrapcp.py.

◆ ObjectiveValue()

ortools.constraint_solver.pywrapcp.SolutionCollector.ObjectiveValue ( self,
n ) 
Returns the objective value of the nth solution.

Definition at line 2967 of file pywrapcp.py.

◆ PerformedValue()

ortools.constraint_solver.pywrapcp.SolutionCollector.PerformedValue ( self,
n,
var ) 
This is a shortcut to get the PerformedValue of 'var' in the nth solution.

Definition at line 2987 of file pywrapcp.py.

◆ Solution()

ortools.constraint_solver.pywrapcp.SolutionCollector.Solution ( self,
n ) 
Returns the nth solution.

Definition at line 2948 of file pywrapcp.py.

◆ SolutionCount()

ortools.constraint_solver.pywrapcp.SolutionCollector.SolutionCount ( self) 
Returns how many solutions were stored during the search.

Definition at line 2944 of file pywrapcp.py.

◆ StartValue()

ortools.constraint_solver.pywrapcp.SolutionCollector.StartValue ( self,
n,
var ) 
This is a shortcut to get the StartValue of 'var' in the nth solution.

Definition at line 2975 of file pywrapcp.py.

◆ Unperformed()

ortools.constraint_solver.pywrapcp.SolutionCollector.Unperformed ( self,
n,
var ) 
    This is a shortcut to get the list of unperformed of 'var' in the
    nth solution.

Definition at line 3007 of file pywrapcp.py.

◆ Value()

ortools.constraint_solver.pywrapcp.SolutionCollector.Value ( self,
n,
var ) 
This is a shortcut to get the Value of 'var' in the nth solution.

Definition at line 2971 of file pywrapcp.py.

◆ WallTime()

ortools.constraint_solver.pywrapcp.SolutionCollector.WallTime ( self,
n ) 
Returns the wall time in ms for the nth solution.

Definition at line 2952 of file pywrapcp.py.

Property Documentation

◆ thisown

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

Definition at line 2924 of file pywrapcp.py.

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