gemseo.algos package

Optimization and DOE algorithms.

Subpackages

• gemseo.algos.aggregation package
  • Submodules
    • gemseo.algos.aggregation.aggregation_func module
      • aggregate_iks()
      • aggregate_lower_bound_ks()
      • aggregate_max()
      • aggregate_positive_sum_square()
      • aggregate_sum_square()
      • aggregate_upper_bound_ks()
      • check_constraint_type()
    • gemseo.algos.aggregation.core module
      • compute_iks_agg()
      • compute_lower_bound_ks_agg()
      • compute_max_agg()
      • compute_max_agg_jac()
      • compute_partial_iks_agg_jac()
      • compute_partial_ks_agg_jac()
      • compute_partial_sum_positive_square_agg_jac()
      • compute_partial_sum_square_agg_jac()
      • compute_sum_positive_square_agg()
      • compute_sum_square_agg()
      • compute_total_iks_agg_jac()
      • compute_total_ks_agg_jac()
      • compute_total_sum_square_agg_jac()
      • compute_total_sum_square_positive_agg_jac()
      • compute_upper_bound_ks_agg()
• gemseo.algos.doe package
  • Subpackages
    • gemseo.algos.doe.custom_doe package
      • Subpackages
      • Submodules
    • gemseo.algos.doe.diagonal_doe package
      • Subpackages
      • Submodules
    • gemseo.algos.doe.morris_doe package
      • Subpackages
      • Submodules
    • gemseo.algos.doe.oat_doe package
      • Subpackages
      • Submodules
    • gemseo.algos.doe.openturns package
      • Subpackages
      • Submodules
    • gemseo.algos.doe.pydoe package
      • Subpackages
      • Submodules
    • gemseo.algos.doe.scipy package
      • Subpackages
      • Submodules
  • Submodules
    • gemseo.algos.doe.base_doe module
      • BaseDOE
    • gemseo.algos.doe.base_doe_library module
      • BaseDOELibrary
      • DOEAlgorithmDescription
      • CallbackType
    • gemseo.algos.doe.base_doe_settings module
      • BaseDOESettings
    • gemseo.algos.doe.base_full_factorial_doe module
      • BaseFullFactorialDOE
    • gemseo.algos.doe.base_n_samples_based_doe_settings module
      • BaseNSamplesBasedDOESettings
    • gemseo.algos.doe.doe_quality module
      • DOEMeasures
      • DOEQuality
      • compute_discrepancy()
      • compute_mindist_criterion()
      • compute_phip_criterion()
    • gemseo.algos.doe.factory module
      • DOELibraryFactory
• gemseo.algos.linear_solvers package
  • Subpackages
    • gemseo.algos.linear_solvers.scipy_linalg package
      • Subpackages
      • Submodules
  • Submodules
    • gemseo.algos.linear_solvers.base_linear_solver_library module
      • BaseLinearSolverLibrary
      • LinearSolverDescription
    • gemseo.algos.linear_solvers.base_linear_solver_settings module
      • BaseLinearSolverSettings
    • gemseo.algos.linear_solvers.factory module
      • LinearSolverLibraryFactory
    • gemseo.algos.linear_solvers.linear_problem module
      • LinearProblem
• gemseo.algos.ode package
  • Subpackages
    • gemseo.algos.ode.scipy_ode package
      • Subpackages
      • Submodules
  • Submodules
    • gemseo.algos.ode.base_ode_solver_library module
      • BaseODESolverLibrary
      • ODESolverDescription
    • gemseo.algos.ode.base_ode_solver_settings module
      • BaseODESolverSettings
    • gemseo.algos.ode.factory module
      • ODESolverLibraryFactory
    • gemseo.algos.ode.ode_problem module
      • DifferentiationFunctions
      • ODEProblem
      • TimeInterval
    • gemseo.algos.ode.ode_result module
      • ODEResult
    • gemseo.algos.ode.rhs_jacobian_checking module
      • RHSJacobianChecking
• gemseo.algos.opt package
  • Subpackages
    • gemseo.algos.opt.augmented_lagrangian package
      • Subpackages
      • Submodules
    • gemseo.algos.opt.core package
      • Submodules
    • gemseo.algos.opt.mnbi package
      • Subpackages
      • Submodules
    • gemseo.algos.opt.multi_start package
      • Subpackages
      • Submodules
    • gemseo.algos.opt.nlopt package
      • Subpackages
      • Submodules
    • gemseo.algos.opt.scipy_global package
      • Subpackages
      • Submodules
    • gemseo.algos.opt.scipy_linprog package
      • Subpackages
      • Submodules
    • gemseo.algos.opt.scipy_local package
      • Subpackages
      • Submodules
    • gemseo.algos.opt.scipy_milp package
      • Subpackages
      • Submodules
  • Submodules
    • gemseo.algos.opt.base_gradient_based_algorithm_settings module
      • BaseGradientBasedAlgorithmSettings
    • gemseo.algos.opt.base_milp_settings module
      • BaseMILPSettings
    • gemseo.algos.opt.base_optimization_library module
      • BaseOptimizationLibrary
      • OptimizationAlgorithmDescription
    • gemseo.algos.opt.base_optimizer_settings module
      • BaseOptimizerSettings
    • gemseo.algos.opt.factory module
      • OptimizationLibraryFactory
• gemseo.algos.pareto package
  • Submodules
    • gemseo.algos.pareto.pareto_front module
      • ParetoFront
    • gemseo.algos.pareto.pareto_plot_biobjective module
      • ParetoPlotBiObjective
    • gemseo.algos.pareto.utils module
      • compute_pareto_optimal_points()
      • generate_pareto_plots()
• gemseo.algos.sequence_transformer package
  • Subpackages
    • gemseo.algos.sequence_transformer.acceleration package
      • AccelerationMethod
      • Submodules
    • gemseo.algos.sequence_transformer.composite package
      • Submodules
    • gemseo.algos.sequence_transformer.relaxation package
      • Submodules
  • Submodules
    • gemseo.algos.sequence_transformer.factory module
      • SequenceTransformerFactory
    • gemseo.algos.sequence_transformer.no_transformation module
      • NoTransformation
    • gemseo.algos.sequence_transformer.sequence_transformer module
      • SequenceTransformer

Submodules

• gemseo.algos.base_algo_factory module
  • BaseAlgoFactory
    • BaseAlgoFactory.clear_lib_cache()
    • BaseAlgoFactory.create()
    • BaseAlgoFactory.execute()
    • BaseAlgoFactory.get_class()
    • BaseAlgoFactory.get_library_name()
    • BaseAlgoFactory.is_available()
    • BaseAlgoFactory.algo_names_to_libraries
    • BaseAlgoFactory.algorithms
    • BaseAlgoFactory.libraries
• gemseo.algos.base_algorithm_library module
  • AlgorithmDescription
    • AlgorithmDescription.Settings
    • AlgorithmDescription.algorithm_name
    • AlgorithmDescription.description
    • AlgorithmDescription.internal_algorithm_name
    • AlgorithmDescription.library_name
    • AlgorithmDescription.website
  • BaseAlgorithmLibrary
    • BaseAlgorithmLibrary.execute()
    • BaseAlgorithmLibrary.filter_adapted_algorithms()
    • BaseAlgorithmLibrary.is_algorithm_suited()
    • BaseAlgorithmLibrary.ALGORITHM_INFOS
    • BaseAlgorithmLibrary.algo_name
• gemseo.algos.base_algorithm_settings module
  • BaseAlgorithmSettings
    • BaseAlgorithmSettings.model_post_init()
• gemseo.algos.base_driver_library module
  • BaseDriverLibrary
    • BaseDriverLibrary.ApproximationMode
      • BaseDriverLibrary.ApproximationMode.CENTERED_DIFFERENCES
      • BaseDriverLibrary.ApproximationMode.COMPLEX_STEP
      • BaseDriverLibrary.ApproximationMode.FINITE_DIFFERENCES
    • BaseDriverLibrary.DifferentiationMethod
      • BaseDriverLibrary.DifferentiationMethod.CENTERED_DIFFERENCES
      • BaseDriverLibrary.DifferentiationMethod.COMPLEX_STEP
      • BaseDriverLibrary.DifferentiationMethod.FINITE_DIFFERENCES
      • BaseDriverLibrary.DifferentiationMethod.NO_DERIVATIVE
      • BaseDriverLibrary.DifferentiationMethod.USER_GRAD
    • BaseDriverLibrary.execute()
    • BaseDriverLibrary.ALGORITHM_INFOS
    • BaseDriverLibrary.enable_progress_bar
  • DriverDescription
    • DriverDescription.Settings
    • DriverDescription.handle_integer_variables
• gemseo.algos.base_driver_settings module
  • BaseDriverSettings
    • BaseDriverSettings.enable_progress_bar
    • BaseDriverSettings.eq_tolerance
    • BaseDriverSettings.ineq_tolerance
    • BaseDriverSettings.log_problem
    • BaseDriverSettings.max_time
    • BaseDriverSettings.normalize_design_space
    • BaseDriverSettings.reset_iteration_counters
    • BaseDriverSettings.round_ints
    • BaseDriverSettings.store_jacobian
    • BaseDriverSettings.use_database
    • BaseDriverSettings.use_one_line_progress_bar
• gemseo.algos.base_problem module
  • BaseProblem
    • BaseProblem.check()
• gemseo.algos.constraint_tolerances module
  • ConstraintTolerances
    • ConstraintTolerances.equality
    • ConstraintTolerances.inequality
• gemseo.algos.database module
  • Database
    • Database.add_new_iter_listener()
    • Database.add_store_listener()
    • Database.check_output_history_is_empty()
    • Database.clear()
    • Database.clear_from_iteration()
    • Database.clear_listeners()
    • Database.filter()
    • Database.from_hdf()
    • Database.get_function_history()
    • Database.get_function_names()
    • Database.get_function_value()
    • Database.get_gradient_history()
    • Database.get_gradient_name()
    • Database.get_hashable_ndarray()
    • Database.get_history()
    • Database.get_history_array()
    • Database.get_iteration()
    • Database.get_last_n_x_vect()
    • Database.get_x_vect()
    • Database.get_x_vect_history()
    • Database.notify_new_iter_listeners()
    • Database.notify_store_listeners()
    • Database.remove_empty_entries()
    • Database.store()
    • Database.to_dataset()
    • Database.to_ggobi()
    • Database.to_hdf()
    • Database.update_from_hdf()
    • Database.update_from_opendace()
    • Database.DEFAULT_INPUT_NAME
    • Database.GRAD_TAG
    • Database.MISSING_VALUE_TAG
    • Database.input_space
    • Database.last_item
    • Database.n_iterations
    • Database.name
  • DatabaseValueType
  • DatabaseKeyType
  • FunctionOutputValueType
  • ListenerType
• gemseo.algos.design_space module
  • DesignSpace
    • DesignSpace.DesignVariableType
    • DesignSpace.add_variable()
    • DesignSpace.add_variables_from()
    • DesignSpace.check()
    • DesignSpace.check_membership()
    • DesignSpace.convert_array_to_dict()
    • DesignSpace.convert_dict_to_array()
    • DesignSpace.extend()
    • DesignSpace.filter()
    • DesignSpace.filter_dimensions()
    • DesignSpace.from_csv()
    • DesignSpace.from_file()
    • DesignSpace.from_hdf()
    • DesignSpace.get_active_bounds()
    • DesignSpace.get_current_value()
    • DesignSpace.get_indexed_variable_names()
    • DesignSpace.get_lower_bound()
    • DesignSpace.get_lower_bounds()
    • DesignSpace.get_pretty_table()
    • DesignSpace.get_size()
    • DesignSpace.get_type()
    • DesignSpace.get_upper_bound()
    • DesignSpace.get_upper_bounds()
    • DesignSpace.get_variables_indexes()
    • DesignSpace.initialize_missing_current_values()
    • DesignSpace.normalize_grad()
    • DesignSpace.normalize_vect()
    • DesignSpace.project_into_bounds()
    • DesignSpace.remove_variable()
    • DesignSpace.rename_variable()
    • DesignSpace.round_vect()
    • DesignSpace.set_current_value()
    • DesignSpace.set_current_variable()
    • DesignSpace.set_lower_bound()
    • DesignSpace.set_upper_bound()
    • DesignSpace.to_complex()
    • DesignSpace.to_csv()
    • DesignSpace.to_file()
    • DesignSpace.to_hdf()
    • DesignSpace.to_scalar_variables()
    • DesignSpace.transform_vect()
    • DesignSpace.unnormalize_grad()
    • DesignSpace.unnormalize_vect()
    • DesignSpace.untransform_vect()
    • DesignSpace.DESIGN_SPACE_GROUP
    • DesignSpace.LB_GROUP
    • DesignSpace.MINIMAL_FIELDS
    • DesignSpace.NAMES_GROUP
    • DesignSpace.NAME_GROUP
    • DesignSpace.SIZE_GROUP
    • DesignSpace.TABLE_NAMES
    • DesignSpace.UB_GROUP
    • DesignSpace.VALUE_GROUP
    • DesignSpace.VARIABLE_TYPES_TO_DTYPES
    • DesignSpace.VAR_TYPE_GROUP
    • DesignSpace.dimension
    • DesignSpace.has_current_value
    • DesignSpace.has_integer_variables
    • DesignSpace.name
    • DesignSpace.names_to_indices
    • DesignSpace.normalize
    • DesignSpace.variable_names
    • DesignSpace.variable_sizes
    • DesignSpace.variable_types
• gemseo.algos.design_space_utils module
  • get_value_and_bounds()
• gemseo.algos.evaluation_counter module
  • EvaluationCounter
    • EvaluationCounter.current
    • EvaluationCounter.maximum
    • EvaluationCounter.maximum_is_reached
• gemseo.algos.evaluation_problem module
  • EvaluationProblem
    • EvaluationProblem.ApproximationMode
      • EvaluationProblem.ApproximationMode.CENTERED_DIFFERENCES
      • EvaluationProblem.ApproximationMode.COMPLEX_STEP
      • EvaluationProblem.ApproximationMode.FINITE_DIFFERENCES
    • EvaluationProblem.DifferentiationMethod
      • EvaluationProblem.DifferentiationMethod.CENTERED_DIFFERENCES
      • EvaluationProblem.DifferentiationMethod.COMPLEX_STEP
      • EvaluationProblem.DifferentiationMethod.FINITE_DIFFERENCES
      • EvaluationProblem.DifferentiationMethod.NO_DERIVATIVE
      • EvaluationProblem.DifferentiationMethod.USER_GRAD
    • EvaluationProblem.add_listener()
    • EvaluationProblem.add_observable()
    • EvaluationProblem.check()
    • EvaluationProblem.evaluate_functions()
    • EvaluationProblem.get_functions()
    • EvaluationProblem.preprocess_functions()
    • EvaluationProblem.reset()
    • EvaluationProblem.to_dataset()
    • EvaluationProblem.check_bounds
    • EvaluationProblem.database
    • EvaluationProblem.design_space
    • EvaluationProblem.differentiation_step
    • EvaluationProblem.evaluation_counter
    • EvaluationProblem.function_names
    • EvaluationProblem.functions
    • EvaluationProblem.new_iter_observables
    • EvaluationProblem.observables
    • EvaluationProblem.original_functions
    • EvaluationProblem.parallel_differentiation
    • EvaluationProblem.parallel_differentiation_options
    • EvaluationProblem.stop_if_nan
  • EvaluationType
• gemseo.algos.hashable_ndarray module
  • HashableNdarray
    • HashableNdarray.copy_wrapped_array()
    • HashableNdarray.unwrap()
    • HashableNdarray.is_copy
    • HashableNdarray.wrapped_array
• gemseo.algos.lagrange_multipliers module
  • LagrangeMultipliers
    • LagrangeMultipliers.compute()
    • LagrangeMultipliers.get_multipliers_arrays()
    • LagrangeMultipliers.get_objective_jacobian()
    • LagrangeMultipliers.CSTR_LABELS
    • LagrangeMultipliers.EQUALITY
    • LagrangeMultipliers.INEQUALITY
    • LagrangeMultipliers.LOWER_BOUNDS
    • LagrangeMultipliers.UPPER_BOUNDS
    • LagrangeMultipliers.constraint_violation
    • LagrangeMultipliers.kkt_residual
• gemseo.algos.multiobjective_optimization_result module
  • MultiObjectiveOptimizationResult
    • MultiObjectiveOptimizationResult.to_dict()
    • MultiObjectiveOptimizationResult.pareto_front
• gemseo.algos.optimization_history module
  • OptimizationHistory
    • OptimizationHistory.Solution
      • OptimizationHistory.Solution.constraint_jacobian
      • OptimizationHistory.Solution.constraints
      • OptimizationHistory.Solution.design
      • OptimizationHistory.Solution.is_feasible
      • OptimizationHistory.Solution.objective
    • OptimizationHistory.check_design_point_is_feasible()
    • OptimizationHistory.get_data_by_names()
    • OptimizationHistory.feasible_points
    • OptimizationHistory.last_point
    • OptimizationHistory.objective_name
    • OptimizationHistory.optimum
• gemseo.algos.optimization_problem module
  • OptimizationProblem
    • OptimizationProblem.AggregationFunction
    • OptimizationProblem.DifferentiationMethod
      • OptimizationProblem.DifferentiationMethod.CENTERED_DIFFERENCES
      • OptimizationProblem.DifferentiationMethod.COMPLEX_STEP
      • OptimizationProblem.DifferentiationMethod.FINITE_DIFFERENCES
      • OptimizationProblem.DifferentiationMethod.NO_DERIVATIVE
      • OptimizationProblem.DifferentiationMethod.USER_GRAD
    • OptimizationProblem.HistoryFileFormat
      • OptimizationProblem.HistoryFileFormat.GGOBI
      • OptimizationProblem.HistoryFileFormat.HDF5
    • OptimizationProblem.add_constraint()
    • OptimizationProblem.apply_exterior_penalty()
    • OptimizationProblem.check()
    • OptimizationProblem.from_hdf()
    • OptimizationProblem.get_function_dimension()
    • OptimizationProblem.get_function_names()
    • OptimizationProblem.get_functions()
    • OptimizationProblem.get_functions_dimensions()
    • OptimizationProblem.get_reformulated_problem_with_slack_variables()
    • OptimizationProblem.reset()
    • OptimizationProblem.to_dataset()
    • OptimizationProblem.to_hdf()
    • OptimizationProblem.constraints
    • OptimizationProblem.functions
    • OptimizationProblem.is_linear
    • OptimizationProblem.is_mono_objective
    • OptimizationProblem.minimize_objective
    • OptimizationProblem.objective
    • OptimizationProblem.objective_name
    • OptimizationProblem.optimum
    • OptimizationProblem.original_functions
    • OptimizationProblem.scalar_constraint_names
    • OptimizationProblem.solution
    • OptimizationProblem.standardized_objective_name
    • OptimizationProblem.tolerances
    • OptimizationProblem.use_standardized_objective
• gemseo.algos.optimization_result module
  • OptimizationResult
    • OptimizationResult.from_dict()
    • OptimizationResult.from_optimization_problem()
    • OptimizationResult.to_dict()
    • OptimizationResult.constraint_values
    • OptimizationResult.constraints_grad
    • OptimizationResult.f_opt
    • OptimizationResult.is_feasible
    • OptimizationResult.message
    • OptimizationResult.n_constr_call
    • OptimizationResult.n_grad_call
    • OptimizationResult.n_obj_call
    • OptimizationResult.objective_name
    • OptimizationResult.optimizer_name
    • OptimizationResult.optimum_index
    • OptimizationResult.status
    • OptimizationResult.x_0
    • OptimizationResult.x_0_as_dict
    • OptimizationResult.x_opt
    • OptimizationResult.x_opt_as_dict
• gemseo.algos.parameter_space module
  • Overview
  • Capabilities
  • ParameterSpace
    • ParameterSpace.add_random_variable()
    • ParameterSpace.add_random_vector()
    • ParameterSpace.add_variables_from()
    • ParameterSpace.build_joint_distribution()
    • ParameterSpace.compute_samples()
    • ParameterSpace.evaluate_cdf()
    • ParameterSpace.extract_deterministic_space()
    • ParameterSpace.extract_uncertain_space()
    • ParameterSpace.get_pretty_table()
    • ParameterSpace.get_range()
    • ParameterSpace.get_support()
    • ParameterSpace.get_tabular_view()
    • ParameterSpace.init_from_dataset()
    • ParameterSpace.is_deterministic()
    • ParameterSpace.is_uncertain()
    • ParameterSpace.normalize_vect()
    • ParameterSpace.remove_variable()
    • ParameterSpace.rename_variable()
    • ParameterSpace.to_design_space()
    • ParameterSpace.transform_vect()
    • ParameterSpace.unnormalize_vect()
    • ParameterSpace.untransform_vect()
    • ParameterSpace.deterministic_variables
    • ParameterSpace.distribution
    • ParameterSpace.distributions
    • ParameterSpace.uncertain_variables
  • RandomVariable
    • RandomVariable.distribution
    • RandomVariable.parameters
    • RandomVariable.size
  • RandomVector
    • RandomVector.distribution
    • RandomVector.parameters
    • RandomVector.size
• gemseo.algos.post_optimal_analysis module
  • PostOptimalAnalysis
    • PostOptimalAnalysis.check_validity()
    • PostOptimalAnalysis.compute_lagrangian_jac()
    • PostOptimalAnalysis.execute()
    • PostOptimalAnalysis.MULT_DOT_CONSTR_JAC
• gemseo.algos.problem_function module
  • ProblemFunction
    • ProblemFunction.check_function_output_includes_nan()
    • ProblemFunction.evaluate()
    • ProblemFunction.enable_statistics
    • ProblemFunction.func
    • ProblemFunction.n_calls
    • ProblemFunction.stop_if_nan
• gemseo.algos.stop_criteria module
  • DesvarIsNan
  • FtolReached
  • FunctionIsNan
  • KKTReached
  • MaxIterReachedException
  • MaxTimeReached
  • TerminationCriterion
  • XtolReached
  • BaseToleranceTester
    • BaseToleranceTester.check()
    • BaseToleranceTester.absolute
    • BaseToleranceTester.n_last_iterations
    • BaseToleranceTester.relative
    • BaseToleranceTester.termination_criterion
  • DesignToleranceTester
    • DesignToleranceTester.termination_criterion
  • KKTConditionsTester
    • KKTConditionsTester.termination_criterion
    • KKTConditionsTester.ineq_tolerance
    • KKTConditionsTester.kkt_norm
  • ObjectiveToleranceTester
    • ObjectiveToleranceTester.termination_criterion
  • is_f_tol_reached()
  • is_kkt_residual_norm_reached()
  • is_x_tol_reached()
  • kkt_residual_computation()
  • KKT_RESIDUAL_NORM