operations_research::math_opt::NonStreamableSolverInitArguments Struct Reference

#include <non_streamable_solver_init_arguments.h>

Inheritance diagram for operations_research::math_opt::NonStreamableSolverInitArguments:

Public Member Functions
virtual	~NonStreamableSolverInitArguments ()=default
virtual SolverTypeProto	solver_type () const =0
	Returns the type of solver that the implementation is for.
virtual const NonStreamableCpSatInitArguments *	ToNonStreamableCpSatInitArguments () const
virtual const NonStreamableGScipInitArguments *	ToNonStreamableGScipInitArguments () const
virtual const NonStreamableGlopInitArguments *	ToNonStreamableGlopInitArguments () const
virtual const NonStreamableGlpkInitArguments *	ToNonStreamableGlpkInitArguments () const
virtual const NonStreamableGurobiInitArguments *	ToNonStreamableGurobiInitArguments () const
virtual const NonStreamablePdlpInitArguments *	ToNonStreamablePdlpInitArguments () const
virtual std::unique_ptr< const NonStreamableSolverInitArguments >	Clone () const =0

Detailed Description

Interface for solver specific parameters used at the solver instantiation that can't be streamed (for example instances of C/C++ types that only exist in the process memory).

Since implementations of this interface usually depend on solver specific C/C++ types, they are in a dedicated header in the solver library.

This class is the interface shared by the parameters of each solver, users should instantiate the solver specific class below.

To enable safe cast of a pointer to this interface, there is an ToNonStreamableXxxInitArguments() function for each solver. Only one of these function will return a non-null value, depending on the type of the implementation class.

Implementation should use NonStreamableSolverInitArgumentsHelper to automatically implements some methods.

Definition at line 48 of file non_streamable_solver_init_arguments.h.

Constructor & Destructor Documentation

~NonStreamableSolverInitArguments()

virtual operations_research::math_opt::NonStreamableSolverInitArguments::~NonStreamableSolverInitArguments ( )

virtualdefault

Member Function Documentation

Clone()

virtual std::unique_ptr< const NonStreamableSolverInitArguments > operations_research::math_opt::NonStreamableSolverInitArguments::Clone ( ) const

pure virtual

Return a copy of this.

The NonStreamableSolverInitArgumentsHelper implements this automatically using the copy constructor (this base class is copyable intentionally).

Implemented in operations_research::math_opt::NonStreamableSolverInitArgumentsHelper< Implementation, impl_solver_type >, and operations_research::math_opt::NonStreamableSolverInitArgumentsHelper< NonStreamableGurobiInitArguments, SOLVER_TYPE_GUROBI >.

solver_type()

virtual SolverTypeProto operations_research::math_opt::NonStreamableSolverInitArguments::solver_type ( ) const

pure virtual

Returns the type of solver that the implementation is for.

Implemented in operations_research::math_opt::NonStreamableSolverInitArgumentsHelper< Implementation, impl_solver_type >, and operations_research::math_opt::NonStreamableSolverInitArgumentsHelper< NonStreamableGurobiInitArguments, SOLVER_TYPE_GUROBI >.

ToNonStreamableCpSatInitArguments()

virtual const NonStreamableCpSatInitArguments * operations_research::math_opt::NonStreamableSolverInitArguments::ToNonStreamableCpSatInitArguments ( ) const

inlinevirtual

Returns this for the NonStreamableCpSatInitArguments class, nullptr for other classes.

Definition at line 57 of file non_streamable_solver_init_arguments.h.

ToNonStreamableGlopInitArguments()

virtual const NonStreamableGlopInitArguments * operations_research::math_opt::NonStreamableSolverInitArguments::ToNonStreamableGlopInitArguments ( ) const

inlinevirtual

Returns this for the NonStreamableGlopInitArguments class, nullptr for other classes.

Definition at line 71 of file non_streamable_solver_init_arguments.h.

ToNonStreamableGlpkInitArguments()

virtual const NonStreamableGlpkInitArguments * operations_research::math_opt::NonStreamableSolverInitArguments::ToNonStreamableGlpkInitArguments ( ) const

inlinevirtual

Returns this for the NonStreamableGlpkInitArguments class, nullptr for other classes.

Definition at line 78 of file non_streamable_solver_init_arguments.h.

ToNonStreamableGScipInitArguments()

virtual const NonStreamableGScipInitArguments * operations_research::math_opt::NonStreamableSolverInitArguments::ToNonStreamableGScipInitArguments ( ) const

inlinevirtual

Returns this for the NonStreamableGScipInitArguments class, nullptr for other classes.

Definition at line 64 of file non_streamable_solver_init_arguments.h.

ToNonStreamableGurobiInitArguments()

virtual const NonStreamableGurobiInitArguments * operations_research::math_opt::NonStreamableSolverInitArguments::ToNonStreamableGurobiInitArguments ( ) const

inlinevirtual

Returns this for the NonStreamableGurobiInitArguments class, nullptr for other classes.

Reimplemented in operations_research::math_opt::NonStreamableGurobiInitArguments.

Definition at line 85 of file non_streamable_solver_init_arguments.h.

ToNonStreamablePdlpInitArguments()

virtual const NonStreamablePdlpInitArguments * operations_research::math_opt::NonStreamableSolverInitArguments::ToNonStreamablePdlpInitArguments ( ) const

inlinevirtual

Returns this for the NonStreamablePdlpInitArguments class, nullptr for other classes.

Definition at line 92 of file non_streamable_solver_init_arguments.h.

---

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

• ortools/math_opt/core/non_streamable_solver_init_arguments.h