Detailed Description

Defines how to request a callback and the input and output of a callback.

Classes
class	CallbackData
class	CallbackRegistration
class	CallbackResult
class	Event
class	GeneratedConstraint

Functions
CallbackData	parse_callback_data (callback_pb2.CallbackDataProto cb_data, model.Model mod)

Variables
	PresolveStats = callback_pb2.CallbackDataProto.PresolveStats
	SimplexStats = callback_pb2.CallbackDataProto.SimplexStats
	BarrierStats = callback_pb2.CallbackDataProto.BarrierStats
	MipStats = callback_pb2.CallbackDataProto.MipStats

Function Documentation

◆ parse_callback_data()

CallbackData ortools.math_opt.python.callback.parse_callback_data	(	callback_pb2.CallbackDataProto	cb_data,
		model.Model	mod )

Creates a CallbackData from an equivalent proto.

Args:
  cb_data: A protocol buffer with the information the user needs for a
    callback.
  mod: The model being solved.

Returns:
  An equivalent CallbackData.

Raises:
  ValueError: if cb_data is invalid or inconsistent with mod, e.g. cb_data
  refers to a variable id not in mod.

Definition at line 99 of file callback.py.

Variable Documentation

◆ BarrierStats

ortools.math_opt.python.callback.BarrierStats = callback_pb2.CallbackDataProto.BarrierStats

Definition at line 63 of file callback.py.

◆ MipStats

ortools.math_opt.python.callback.MipStats = callback_pb2.CallbackDataProto.MipStats

Definition at line 64 of file callback.py.

◆ PresolveStats

ortools.math_opt.python.callback.PresolveStats = callback_pb2.CallbackDataProto.PresolveStats

Definition at line 61 of file callback.py.

◆ SimplexStats

ortools.math_opt.python.callback.SimplexStats = callback_pb2.CallbackDataProto.SimplexStats

Definition at line 62 of file callback.py.