opengen package
Subpackages
- opengen.builder package
- Submodules
- opengen.builder.optimizer_builder module
- opengen.builder.problem module
ProblemProblem.__init__()Problem.alm_set_cProblem.alm_set_yProblem.constraintsProblem.cost_functionProblem.decision_variablesProblem.dim_constraints_aug_lagrangian()Problem.dim_constraints_penalty()Problem.dim_decision_variables()Problem.dim_parameters()Problem.parameter_variablesProblem.penalty_functionProblem.penalty_mapping_f1Problem.penalty_mapping_f2Problem.preconditioning_coefficientsProblem.to_dict()Problem.w1Problem.w2Problem.w_costProblem.with_aug_lagrangian_constraints()Problem.with_constraints()Problem.with_penalty_constraints()
- opengen.builder.ros_builder module
- opengen.builder.set_y_calculator module
- Module contents
OpEnOptimizerBuilderProblemProblem.__init__()Problem.alm_set_cProblem.alm_set_yProblem.constraintsProblem.cost_functionProblem.decision_variablesProblem.dim_constraints_aug_lagrangian()Problem.dim_constraints_penalty()Problem.dim_decision_variables()Problem.dim_parameters()Problem.parameter_variablesProblem.penalty_functionProblem.penalty_mapping_f1Problem.penalty_mapping_f2Problem.preconditioning_coefficientsProblem.to_dict()Problem.w1Problem.w2Problem.w_costProblem.with_aug_lagrangian_constraints()Problem.with_constraints()Problem.with_penalty_constraints()
ROS2BuilderRosBuilderSetYCalculator
- opengen.config package
- Submodules
- opengen.config.build_config module
BuildConfigurationBuildConfiguration.DEBUG_MODEBuildConfiguration.RELEASE_MODEBuildConfiguration.__init__()BuildConfiguration.allocatorBuildConfiguration.build_c_bindingsBuildConfiguration.build_dirBuildConfiguration.build_modeBuildConfiguration.build_python_bindingsBuildConfiguration.local_pathBuildConfiguration.open_versionBuildConfiguration.rebuildBuildConfiguration.ros2_configBuildConfiguration.ros_configBuildConfiguration.target_systemBuildConfiguration.tcp_interface_configBuildConfiguration.to_dict()BuildConfiguration.with_allocator()BuildConfiguration.with_build_c_bindings()BuildConfiguration.with_build_directory()BuildConfiguration.with_build_mode()BuildConfiguration.with_build_python_bindings()BuildConfiguration.with_open_version()BuildConfiguration.with_rebuild()BuildConfiguration.with_ros()BuildConfiguration.with_ros2()BuildConfiguration.with_target_system()BuildConfiguration.with_tcp_interface_config()
RustAllocator
- opengen.config.meta module
OptimizerMetaOptimizerMeta.__init__()OptimizerMeta.alm_mapping_f1_function_nameOptimizerMeta.authorsOptimizerMeta.constraint_penalty_function_nameOptimizerMeta.cost_function_nameOptimizerMeta.grad_function_nameOptimizerMeta.initial_penalty_function_nameOptimizerMeta.licenceOptimizerMeta.optimizer_nameOptimizerMeta.preconditioning_file_nameOptimizerMeta.to_dict()OptimizerMeta.versionOptimizerMeta.w_cost_function_nameOptimizerMeta.w_f1_function_nameOptimizerMeta.w_f2_function_nameOptimizerMeta.with_authors()OptimizerMeta.with_licence()OptimizerMeta.with_optimizer_name()OptimizerMeta.with_version()
- opengen.config.ros_config module
RosConfigurationRosConfiguration.__init__()RosConfiguration.descriptionRosConfiguration.node_nameRosConfiguration.package_nameRosConfiguration.params_topic_queue_sizeRosConfiguration.publisher_subtopicRosConfiguration.rateRosConfiguration.result_topic_queue_sizeRosConfiguration.subscriber_subtopicRosConfiguration.to_dict()RosConfiguration.with_description()RosConfiguration.with_node_name()RosConfiguration.with_package_name()RosConfiguration.with_publisher_subtopic()RosConfiguration.with_queue_sizes()RosConfiguration.with_rate()RosConfiguration.with_subscriber_subtopic()
- opengen.config.solver_config module
SolverConfigurationSolverConfiguration.__init__()SolverConfiguration.cbfgs_alphaSolverConfiguration.cbfgs_epsilonSolverConfiguration.cbfgs_sy_epsilonSolverConfiguration.constraints_toleranceSolverConfiguration.initial_penaltySolverConfiguration.initial_toleranceSolverConfiguration.inner_tolerance_update_factorSolverConfiguration.lbfgs_memorySolverConfiguration.max_duration_microsSolverConfiguration.max_inner_iterationsSolverConfiguration.max_outer_iterationsSolverConfiguration.penalty_weight_update_factorSolverConfiguration.preconditioningSolverConfiguration.sufficient_decrease_coefficientSolverConfiguration.to_dict()SolverConfiguration.toleranceSolverConfiguration.with_cbfgs_parameters()SolverConfiguration.with_delta_tolerance()SolverConfiguration.with_initial_penalty()SolverConfiguration.with_initial_tolerance()SolverConfiguration.with_inner_tolerance_update_factor()SolverConfiguration.with_lbfgs_memory()SolverConfiguration.with_max_duration_micros()SolverConfiguration.with_max_inner_iterations()SolverConfiguration.with_max_outer_iterations()SolverConfiguration.with_penalty_weight_update_factor()SolverConfiguration.with_preconditioning()SolverConfiguration.with_sufficient_decrease_coefficient()SolverConfiguration.with_tolerance()
- opengen.config.tcp_server_config module
- Module contents
BuildConfigurationBuildConfiguration.DEBUG_MODEBuildConfiguration.RELEASE_MODEBuildConfiguration.__init__()BuildConfiguration.allocatorBuildConfiguration.build_c_bindingsBuildConfiguration.build_dirBuildConfiguration.build_modeBuildConfiguration.build_python_bindingsBuildConfiguration.local_pathBuildConfiguration.open_versionBuildConfiguration.rebuildBuildConfiguration.ros2_configBuildConfiguration.ros_configBuildConfiguration.target_systemBuildConfiguration.tcp_interface_configBuildConfiguration.to_dict()BuildConfiguration.with_allocator()BuildConfiguration.with_build_c_bindings()BuildConfiguration.with_build_directory()BuildConfiguration.with_build_mode()BuildConfiguration.with_build_python_bindings()BuildConfiguration.with_open_version()BuildConfiguration.with_rebuild()BuildConfiguration.with_ros()BuildConfiguration.with_ros2()BuildConfiguration.with_target_system()BuildConfiguration.with_tcp_interface_config()
OptimizerMetaOptimizerMeta.__init__()OptimizerMeta.alm_mapping_f1_function_nameOptimizerMeta.authorsOptimizerMeta.constraint_penalty_function_nameOptimizerMeta.cost_function_nameOptimizerMeta.grad_function_nameOptimizerMeta.initial_penalty_function_nameOptimizerMeta.licenceOptimizerMeta.optimizer_nameOptimizerMeta.preconditioning_file_nameOptimizerMeta.to_dict()OptimizerMeta.versionOptimizerMeta.w_cost_function_nameOptimizerMeta.w_f1_function_nameOptimizerMeta.w_f2_function_nameOptimizerMeta.with_authors()OptimizerMeta.with_licence()OptimizerMeta.with_optimizer_name()OptimizerMeta.with_version()
RosConfigurationRosConfiguration.__init__()RosConfiguration.descriptionRosConfiguration.node_nameRosConfiguration.package_nameRosConfiguration.params_topic_queue_sizeRosConfiguration.publisher_subtopicRosConfiguration.rateRosConfiguration.result_topic_queue_sizeRosConfiguration.subscriber_subtopicRosConfiguration.to_dict()RosConfiguration.with_description()RosConfiguration.with_node_name()RosConfiguration.with_package_name()RosConfiguration.with_publisher_subtopic()RosConfiguration.with_queue_sizes()RosConfiguration.with_rate()RosConfiguration.with_subscriber_subtopic()
RustAllocatorSolverConfigurationSolverConfiguration.__init__()SolverConfiguration.cbfgs_alphaSolverConfiguration.cbfgs_epsilonSolverConfiguration.cbfgs_sy_epsilonSolverConfiguration.constraints_toleranceSolverConfiguration.initial_penaltySolverConfiguration.initial_toleranceSolverConfiguration.inner_tolerance_update_factorSolverConfiguration.lbfgs_memorySolverConfiguration.max_duration_microsSolverConfiguration.max_inner_iterationsSolverConfiguration.max_outer_iterationsSolverConfiguration.penalty_weight_update_factorSolverConfiguration.preconditioningSolverConfiguration.sufficient_decrease_coefficientSolverConfiguration.to_dict()SolverConfiguration.toleranceSolverConfiguration.with_cbfgs_parameters()SolverConfiguration.with_delta_tolerance()SolverConfiguration.with_initial_penalty()SolverConfiguration.with_initial_tolerance()SolverConfiguration.with_inner_tolerance_update_factor()SolverConfiguration.with_lbfgs_memory()SolverConfiguration.with_max_duration_micros()SolverConfiguration.with_max_inner_iterations()SolverConfiguration.with_max_outer_iterations()SolverConfiguration.with_penalty_weight_update_factor()SolverConfiguration.with_preconditioning()SolverConfiguration.with_sufficient_decrease_coefficient()SolverConfiguration.with_tolerance()
TcpServerConfiguration
- opengen.constraints package
- Submodules
- opengen.constraints.affine_space module
- opengen.constraints.ball1 module
- opengen.constraints.ball2 module
- opengen.constraints.ball_inf module
- opengen.constraints.cartesian module
- opengen.constraints.constraint module
- opengen.constraints.finite_set module
- opengen.constraints.halfspace module
- opengen.constraints.no_constraints module
- opengen.constraints.rectangle module
- opengen.constraints.simplex module
- opengen.constraints.soc module
- opengen.constraints.sphere2 module
- opengen.constraints.zero module
- Module contents
- opengen.functions package
- Submodules
- opengen.functions.fabs module
- opengen.functions.fmax module
- opengen.functions.fmin module
- opengen.functions.is_numeric module
- opengen.functions.is_symbolic module
- opengen.functions.norm2 module
- opengen.functions.norm2_squared module
- opengen.functions.rosenbrock module
- opengen.functions.sign module
- Module contents
- opengen.ocp package
- Submodules
- opengen.ocp.builder module
- opengen.ocp.constraint_utils module
- opengen.ocp.dynamics module
- opengen.ocp.parameter module
- opengen.ocp.problem module
OptimalControlProblemOptimalControlProblem.__init__()OptimalControlProblem.add_parameter()OptimalControlProblem.build_symbolic_model()OptimalControlProblem.dynamicsOptimalControlProblem.hard_stage_state_input_constraintsOptimalControlProblem.hard_terminal_state_constraintsOptimalControlProblem.horizonOptimalControlProblem.input_constraintsOptimalControlProblem.nuOptimalControlProblem.nxOptimalControlProblem.parametersOptimalControlProblem.path_constraintsOptimalControlProblem.shootingOptimalControlProblem.symbol_typeOptimalControlProblem.terminal_constraintsOptimalControlProblem.validate()OptimalControlProblem.with_dynamics()OptimalControlProblem.with_dynamics_constraints()OptimalControlProblem.with_hard_stage_state_input_constraints()OptimalControlProblem.with_hard_terminal_state_constraints()OptimalControlProblem.with_input_constraints()OptimalControlProblem.with_path_constraint()OptimalControlProblem.with_stage_cost()OptimalControlProblem.with_terminal_constraint()OptimalControlProblem.with_terminal_cost()
ShootingMethod
- opengen.ocp.solution module
- Module contents
DynamicsDiscretizerGeneratedOptimizerOCPBuilderOcpSolutionOptimalControlProblemOptimalControlProblem.__init__()OptimalControlProblem.add_parameter()OptimalControlProblem.build_symbolic_model()OptimalControlProblem.dynamicsOptimalControlProblem.hard_stage_state_input_constraintsOptimalControlProblem.hard_terminal_state_constraintsOptimalControlProblem.horizonOptimalControlProblem.input_constraintsOptimalControlProblem.nuOptimalControlProblem.nxOptimalControlProblem.parametersOptimalControlProblem.path_constraintsOptimalControlProblem.shootingOptimalControlProblem.symbol_typeOptimalControlProblem.terminal_constraintsOptimalControlProblem.validate()OptimalControlProblem.with_dynamics()OptimalControlProblem.with_dynamics_constraints()OptimalControlProblem.with_hard_stage_state_input_constraints()OptimalControlProblem.with_hard_terminal_state_constraints()OptimalControlProblem.with_input_constraints()OptimalControlProblem.with_path_constraint()OptimalControlProblem.with_stage_cost()OptimalControlProblem.with_terminal_constraint()OptimalControlProblem.with_terminal_cost()
ParameterDefinitionParameterPackParameterViewShootingMethod
- opengen.tcp package
- Submodules
- opengen.tcp.optimizer_tcp_manager module
- opengen.tcp.solver_error module
- opengen.tcp.solver_response module
- opengen.tcp.solver_status module
SolverStatusSolverStatus.__init__()SolverStatus.costSolverStatus.exit_statusSolverStatus.f1_infeasibilitySolverStatus.f2_normSolverStatus.lagrange_multipliersSolverStatus.last_problem_norm_fprSolverStatus.num_inner_iterationsSolverStatus.num_outer_iterationsSolverStatus.penaltySolverStatus.solutionSolverStatus.solve_time_ms
- Module contents
OptimizerTcpManagerSolverErrorSolverResponseSolverStatusSolverStatus.__init__()SolverStatus.costSolverStatus.exit_statusSolverStatus.f1_infeasibilitySolverStatus.f2_normSolverStatus.lagrange_multipliersSolverStatus.last_problem_norm_fprSolverStatus.num_inner_iterationsSolverStatus.num_outer_iterationsSolverStatus.penaltySolverStatus.solutionSolverStatus.solve_time_ms
Submodules
opengen.definitions module
- opengen.definitions.original_icasadi_dir()
Directory where the original icasadi files are found (for internal use)
- opengen.definitions.templates_dir()
Directory where the templates are found (for internal use, mainly)
- opengen.definitions.templates_subdir(subdir=None)
Directory where the templates are found and subfolder relative to that path (for internal use, mainly)
Module contents
Top-level package for OpEn with lazy submodule imports.
This module defers importing heavy subpackages to attribute access to avoid circular import problems during package initialization.
Lazy submodule imports defer the loading of Python modules and their attributes until they are first accessed, reducing startup time and memory usage. This is achieved using PEP 562 (__getattr__ and __dir__) to intercept attribute access and load the underlying code only when necessary.