API Documentation

desdeo_problem.problem Package

Desdeo-problem package

This package is for creating a problem for desdeo to solve. It includes modules for Variables, Objectives, Constraints, and actual Problem.

Functions

constraint_function_factory(lhs, rhs, operator)

A function that creates an evaluator.

variable_builder(names, initial_values[, …])

Automatically build all variable objects.

Classes

ScalarConstraint(name, n_decision_vars, …)

A simple scalar constraint that evaluates to a single scalar.

ConstraintError

Raised when an error related to the Constraint class in encountered.

ConstraintBase()

Base class for constraints.

ObjectiveBase()

The abstract base class for objectives.

ObjectiveError

Raised when an error related to the Objective class is encountered.

ObjectiveEvaluationResults(objectives, …)

The return object of <problem>.evaluate methods.

VectorObjectiveBase()

The abstract base class for multiple objectives which are calculated at once.

ScalarObjective(name, evaluator[, …])

A simple objective function that returns a scalar.

_ScalarObjective(name, evaluator[, …])

VectorObjective(name, evaluator[, …])

An objective object that calculated one or more objective functions.

ScalarDataObjective(name, data[, evaluator, …])

A simple Objective class for single valued objectives.

_ScalarDataObjective(name, data[, …])

VectorDataObjective(name, data[, evaluator, …])

A Objective class for multi/valued objectives.

ProblemError

Raised when an error related to the Problem class is encountered.

ProblemBase()

The base class for the problems.

EvaluationResults(objectives, fitness, …)

The return object of <problem>.evaluate methods.

ScalarMOProblem(objectives, variables, …)

A multiobjective optimization problem.

ScalarDataProblem(decision_vectors, …)

A problem class for case where the data is pre-computed.

MOProblem(objectives, variables[, …])

An user defined multiobjective optimization problem.

DataProblem(data, variable_names, …[, …])

A class for a data based problem.

ExperimentalProblem(variable_names, …[, …])

A problem class for data-based problem.

VariableError

Raised when an error is encountered during the handling of the Variable objects.

VariableBuilderError

Raised when an error is encountered during the handling of the Variable objects.

Variable(name, initial_value[, lower_bound, …])

Simple variable with a name, initial value and bounds.

DiscreteDataProblem(data, variable_names, …)

A problem class for data-based problems with discrete values.

classificationPISProblem(objectives, …[, …])

A problem class for the IOPIS formulation for interactive optimization.

Class Inheritance Diagram

Inheritance diagram of desdeo_problem.problem.Constraint.ScalarConstraint, desdeo_problem.problem.Constraint.ConstraintError, desdeo_problem.problem.Constraint.ConstraintBase, desdeo_problem.problem.Objective.ObjectiveBase, desdeo_problem.problem.Objective.ObjectiveError, desdeo_problem.problem.Objective.ObjectiveEvaluationResults, desdeo_problem.problem.Objective.VectorObjectiveBase, desdeo_problem.problem.Objective.ScalarObjective, desdeo_problem.problem.Objective._ScalarObjective, desdeo_problem.problem.Objective.VectorObjective, desdeo_problem.problem.Objective.ScalarDataObjective, desdeo_problem.problem.Objective._ScalarDataObjective, desdeo_problem.problem.Objective.VectorDataObjective, desdeo_problem.problem.Problem.ProblemError, desdeo_problem.problem.Problem.ProblemBase, desdeo_problem.problem.Problem.EvaluationResults, desdeo_problem.problem.Problem.ScalarMOProblem, desdeo_problem.problem.Problem.ScalarDataProblem, desdeo_problem.problem.Problem.MOProblem, desdeo_problem.problem.Problem.DataProblem, desdeo_problem.problem.Problem.ExperimentalProblem, desdeo_problem.problem.Variable.VariableError, desdeo_problem.problem.Variable.VariableBuilderError, desdeo_problem.problem.Variable.Variable, desdeo_problem.problem.Problem.DiscreteDataProblem, desdeo_problem.problem.Problem.classificationPISProblem

desdeo_problem.testproblems Package

Functions

test_problem_builder(name[, n_of_variables, …])

Build test problems.

desdeo_problem.surrogatemodels Package

Classes

ModelError

Raised when an error related to the surrogate models classes is encountered.

BaseRegressor()

GaussianProcessRegressor(**kwargs)

LipschitzianRegressor([L])

Class Inheritance Diagram

Inheritance diagram of desdeo_problem.surrogatemodels.SurrogateModels.ModelError, desdeo_problem.surrogatemodels.SurrogateModels.BaseRegressor, desdeo_problem.surrogatemodels.SurrogateModels.GaussianProcessRegressor, desdeo_problem.surrogatemodels.lipschitzian.LipschitzianRegressor