Detailed Description

Sparse vectors and matrices using variables and constraints from Model.

Analogous to sparse_containers.proto, with bidirectional conversion.

Classes
class	SparseVectorFilter

Functions
sparse_containers_pb2.SparseDoubleVectorProto	to_sparse_double_vector_proto (Mapping[VarOrConstraintType, float] terms)
sparse_containers_pb2.SparseInt32VectorProto	to_sparse_int32_vector_proto (Mapping[VarOrConstraintType, int] terms)
Dict[variables.Variable, float]	parse_variable_map (sparse_containers_pb2.SparseDoubleVectorProto proto, model.Model mod, bool validate=True)
Dict[linear_constraints.LinearConstraint, float]	parse_linear_constraint_map (sparse_containers_pb2.SparseDoubleVectorProto proto, model.Model mod, bool validate=True)
Dict[quadratic_constraints.QuadraticConstraint, float]	parse_quadratic_constraint_map (sparse_containers_pb2.SparseDoubleVectorProto proto, model.Model mod, bool validate=True)

Variables
	VarOrConstraintType
	VariableFilter = SparseVectorFilter[variables.Variable]
	LinearConstraintFilter = SparseVectorFilter[linear_constraints.LinearConstraint]
	QuadraticConstraintFilter

Function Documentation

◆ parse_linear_constraint_map()

Dict[linear_constraints.LinearConstraint, float] ortools.math_opt.python.sparse_containers.parse_linear_constraint_map	(	sparse_containers_pb2.SparseDoubleVectorProto	proto,
		model.Model	mod,
		bool	validate = True )

Converts a sparse vector of linear constraints from proto to dict representation.

Definition at line 75 of file sparse_containers.py.

◆ parse_quadratic_constraint_map()

Dict[quadratic_constraints.QuadraticConstraint, float] ortools.math_opt.python.sparse_containers.parse_quadratic_constraint_map	(	sparse_containers_pb2.SparseDoubleVectorProto	proto,
		model.Model	mod,
		bool	validate = True )

Converts a sparse vector of quadratic constraints from proto to dict representation.

Definition at line 89 of file sparse_containers.py.

◆ parse_variable_map()

Dict[variables.Variable, float] ortools.math_opt.python.sparse_containers.parse_variable_map	(	sparse_containers_pb2.SparseDoubleVectorProto	proto,
		model.Model	mod,
		bool	validate = True )

Converts a sparse vector of variables from proto to dict representation.

Definition at line 63 of file sparse_containers.py.

◆ to_sparse_double_vector_proto()

sparse_containers_pb2.SparseDoubleVectorProto ortools.math_opt.python.sparse_containers.to_sparse_double_vector_proto ( Mapping[VarOrConstraintType, float] terms )

Converts a sparse vector from proto to dict representation.

Definition at line 35 of file sparse_containers.py.

◆ to_sparse_int32_vector_proto()

sparse_containers_pb2.SparseInt32VectorProto ortools.math_opt.python.sparse_containers.to_sparse_int32_vector_proto ( Mapping[VarOrConstraintType, int] terms )

Converts a sparse vector from proto to dict representation.

Definition at line 49 of file sparse_containers.py.

Variable Documentation

◆ LinearConstraintFilter

ortools.math_opt.python.sparse_containers.LinearConstraintFilter = SparseVectorFilter[linear_constraints.LinearConstraint]

Definition at line 150 of file sparse_containers.py.

◆ QuadraticConstraintFilter

ortools.math_opt.python.sparse_containers.QuadraticConstraintFilter

Initial value:

=  SparseVectorFilter[
    quadratic_constraints.QuadraticConstraint
]

Definition at line 151 of file sparse_containers.py.

◆ VariableFilter

ortools.math_opt.python.sparse_containers.VariableFilter = SparseVectorFilter[variables.Variable]

Definition at line 149 of file sparse_containers.py.

◆ VarOrConstraintType

ortools.math_opt.python.sparse_containers.VarOrConstraintType