operations_research::math_opt::Termination Struct Reference

Detailed Description

Definition at line 289 of file solve_result.h.

#include <solve_result.h>

Public Member Functions
	Termination (bool is_maximize, TerminationReason reason, std::string detail={})
bool	limit_reached () const
absl::Status	EnsureIsOptimalOrFeasible () const
bool	IsOptimalOrFeasible () const
absl::Status	EnsureIsOptimal () const
bool	IsOptimal () const
absl::Status	EnsureReasonIs (TerminationReason reason) const
absl::Status	EnsureReasonIsAnyOf (std::initializer_list< TerminationReason > reasons) const
TerminationProto	Proto () const
std::string	ToString () const

Static Public Member Functions
static Termination	Optimal (double objective_value, std::string detail={})
static Termination	Optimal (double primal_objective_value, double dual_objective_value, std::string detail={})
static Termination	Infeasible (bool is_maximize, FeasibilityStatus dual_feasibility_status=FeasibilityStatus::kUndetermined, std::string detail={})
static Termination	InfeasibleOrUnbounded (bool is_maximize, FeasibilityStatus dual_feasibility_status=FeasibilityStatus::kUndetermined, std::string detail={})
static Termination	Unbounded (bool is_maximize, std::string detail={})
static Termination	NoSolutionFound (bool is_maximize, Limit limit, std::optional< double > optional_dual_objective=std::nullopt, std::string detail={})
static Termination	Feasible (bool is_maximize, Limit limit, double finite_primal_objective, std::optional< double > optional_dual_objective=std::nullopt, std::string detail={})
static Termination	Cutoff (bool is_maximize, std::string detail={})
static absl::StatusOr< Termination >	FromProto (const TerminationProto &termination_proto)

Public Attributes
TerminationReason	reason
std::optional< Limit >	limit
std::string	detail
ProblemStatus	problem_status
ObjectiveBounds	objective_bounds

Constructor & Destructor Documentation

Termination()

operations_research::math_opt::Termination::Termination	(	bool	is_maximize,
		TerminationReason	reason,
		std::string	detail = {} )

Definition at line 216 of file solve_result.cc.

Member Function Documentation

Cutoff()

Termination operations_research::math_opt::Termination::Cutoff ( bool is_maximize, std::string detail = {} )

static

Definition at line 307 of file solve_result.cc.

EnsureIsOptimal()

absl::Status operations_research::math_opt::Termination::EnsureIsOptimal

(

)

const

Definition at line 350 of file solve_result.cc.

EnsureIsOptimalOrFeasible()

absl::Status operations_research::math_opt::Termination::EnsureIsOptimalOrFeasible

(

)

const

Definition at line 359 of file solve_result.cc.

EnsureReasonIs()

absl::Status operations_research::math_opt::Termination::EnsureReasonIs

(

TerminationReason

reason

)

const

Definition at line 328 of file solve_result.cc.

EnsureReasonIsAnyOf()

absl::Status operations_research::math_opt::Termination::EnsureReasonIsAnyOf

(

std::initializer_list< TerminationReason >

reasons

)

const

Definition at line 334 of file solve_result.cc.

Feasible()

Termination operations_research::math_opt::Termination::Feasible ( bool is_maximize, Limit limit, double finite_primal_objective, std::optional< double > optional_dual_objective = std::nullopt, std::string detail = {} )

static

Definition at line 290 of file solve_result.cc.

FromProto()

absl::StatusOr< Termination > operations_research::math_opt::Termination::FromProto ( const TerminationProto & termination_proto )

static

Definition at line 368 of file solve_result.cc.

Infeasible()

Termination operations_research::math_opt::Termination::Infeasible ( bool is_maximize, FeasibilityStatus dual_feasibility_status = FeasibilityStatus::kUndetermined, std::string detail = {} )

static

Definition at line 239 of file solve_result.cc.

InfeasibleOrUnbounded()

Termination operations_research::math_opt::Termination::InfeasibleOrUnbounded ( bool is_maximize, FeasibilityStatus dual_feasibility_status = FeasibilityStatus::kUndetermined, std::string detail = {} )

static

Definition at line 252 of file solve_result.cc.

IsOptimal()

bool operations_research::math_opt::Termination::IsOptimal

(

)

const

Definition at line 364 of file solve_result.cc.

IsOptimalOrFeasible()

bool operations_research::math_opt::Termination::IsOptimalOrFeasible

(

)

const

Definition at line 354 of file solve_result.cc.

limit_reached()

bool operations_research::math_opt::Termination::limit_reached

(

)

const

Definition at line 323 of file solve_result.cc.

NoSolutionFound()

Termination operations_research::math_opt::Termination::NoSolutionFound ( bool is_maximize, Limit limit, std::optional< double > optional_dual_objective = std::nullopt, std::string detail = {} )

static

Definition at line 274 of file solve_result.cc.

Optimal() [1/2]

Termination operations_research::math_opt::Termination::Optimal ( double objective_value, std::string detail = {} )

static

Definition at line 234 of file solve_result.cc.

Optimal() [2/2]

Termination operations_research::math_opt::Termination::Optimal ( double primal_objective_value, double dual_objective_value, std::string detail = {} )

static

Definition at line 222 of file solve_result.cc.

Proto()

TerminationProto operations_research::math_opt::Termination::Proto

(

)

const

Definition at line 313 of file solve_result.cc.

ToString()

std::string operations_research::math_opt::Termination::ToString

(

)

const

Definition at line 401 of file solve_result.cc.

Unbounded()

Termination operations_research::math_opt::Termination::Unbounded ( bool is_maximize, std::string detail = {} )

static

Definition at line 265 of file solve_result.cc.

Member Data Documentation

detail

std::string operations_research::math_opt::Termination::detail

Definition at line 311 of file solve_result.h.

limit

std::optional<Limit> operations_research::math_opt::Termination::limit

Definition at line 306 of file solve_result.h.

objective_bounds

ObjectiveBounds operations_research::math_opt::Termination::objective_bounds

Definition at line 317 of file solve_result.h.

problem_status

ProblemStatus operations_research::math_opt::Termination::problem_status

Definition at line 314 of file solve_result.h.

reason

TerminationReason operations_research::math_opt::Termination::reason

Definition at line 299 of file solve_result.h.

---

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

• ortools/math_opt/cpp/solve_result.h
• ortools/math_opt/cpp/solve_result.cc