jormungandr.optimization.SolverStatus Class Reference

Public Member Functions
None	__init__ (self)
None	__init__ (self, ExpressionType cost_function_type=ExpressionType.NONE, ExpressionType equality_constraint_type=ExpressionType.NONE, ExpressionType inequality_constraint_type=ExpressionType.NONE, SolverExitCondition exit_condition=SolverExitCondition.SUCCESS, float cost=0.0)
ExpressionType	cost_function_type (self)
None	cost_function_type (self, ExpressionType arg)
ExpressionType	equality_constraint_type (self)
None	equality_constraint_type (self, ExpressionType arg)
ExpressionType	inequality_constraint_type (self)
None	inequality_constraint_type (self, ExpressionType arg)
SolverExitCondition	exit_condition (self)
None	exit_condition (self, SolverExitCondition arg)
float	cost (self)
None	cost (self, float arg)

Detailed Description

Return value of OptimizationProblem::Solve() containing the cost
function and constraint types and solver's exit condition.

Constructor & Destructor Documentation

__init__() [1/2]

None jormungandr.optimization.SolverStatus.__init__

(

self

)

__init__() [2/2]

None jormungandr.optimization.SolverStatus.__init__	(		self,
		ExpressionType	cost_function_type = ExpressionType.NONE,
		ExpressionType	equality_constraint_type = ExpressionType.NONE,
		ExpressionType	inequality_constraint_type = ExpressionType.NONE,
		SolverExitCondition	exit_condition = SolverExitCondition.SUCCESS,
		float	cost = 0.0
	)

Member Function Documentation

cost() [1/2]

float jormungandr.optimization.SolverStatus.cost

(

self

)

The solution's cost.

cost() [2/2]

None jormungandr.optimization.SolverStatus.cost	(		self,
		float	arg
	)

cost_function_type() [1/2]

ExpressionType jormungandr.optimization.SolverStatus.cost_function_type

(

self

)

The cost function type detected by the solver.

cost_function_type() [2/2]

None jormungandr.optimization.SolverStatus.cost_function_type	(		self,
		ExpressionType	arg
	)

equality_constraint_type() [1/2]

ExpressionType jormungandr.optimization.SolverStatus.equality_constraint_type

(

self

)

The equality constraint type detected by the solver.

equality_constraint_type() [2/2]

None jormungandr.optimization.SolverStatus.equality_constraint_type	(		self,
		ExpressionType	arg
	)

exit_condition() [1/2]

SolverExitCondition jormungandr.optimization.SolverStatus.exit_condition

(

self

)

The solver's exit condition.

exit_condition() [2/2]

None jormungandr.optimization.SolverStatus.exit_condition	(		self,
		SolverExitCondition	arg
	)

inequality_constraint_type() [1/2]

ExpressionType jormungandr.optimization.SolverStatus.inequality_constraint_type

(

self

)

The inequality constraint type detected by the solver.

inequality_constraint_type() [2/2]

None jormungandr.optimization.SolverStatus.inequality_constraint_type	(		self,
		ExpressionType	arg
	)

---

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

• jormungandr/optimization/__init__.py