JijZept Solver Python API
  • API Reference
    • jijzept_solver
      • Submodules
        • jijzept_solver.core
          • Module Contents
            • ALMSimulatedAnnealing
              • ALMSimulatedAnnealing.from_ommx_instance()
              • ALMSimulatedAnnealing.solve()
              • ALMSimulatedAnnealing.convergence_history
            • IdTranslator
              • IdTranslator.from_data()
              • IdTranslator.num_used_variables()
              • IdTranslator.to_data()
              • IdTranslator.constraint_degree
              • IdTranslator.objective_degree
              • IdTranslator.problem_type
            • LocalILP
              • LocalILP.from_ommx_instance()
              • LocalILP.get_operation_count()
              • LocalILP.get_random_sampling_param()
              • LocalILP.set_constraint_threshold()
              • LocalILP.set_random_sampling_param()
              • LocalILP.solve()
              • LocalILP.convergence_history
            • ProblemType
              • ProblemType.BINARY
              • ProblemType.INTEGER
              • ProblemType.MIXED_INTEGER
              • ProblemType.NO_VARIABLES
            • State
            • WeightedHillClimbing
              • WeightedHillClimbing.from_ommx_instance()
              • WeightedHillClimbing.solve()
              • WeightedHillClimbing.convergence_history
              • WeightedHillClimbing.weight_history
            • WeightedSimulatedAnnealing
              • WeightedSimulatedAnnealing.from_ommx_instance()
              • WeightedSimulatedAnnealing.solve()
              • WeightedSimulatedAnnealing.constraint_based_move_info
              • WeightedSimulatedAnnealing.convergence_history
              • WeightedSimulatedAnnealing.weight_history
        • jijzept_solver.metrics
          • Module Contents
            • ProcessInfo
              • ProcessInfo.algorithm_chain
              • ProcessInfo.pid
            • SummaryLogInfo
              • SummaryLogInfo.all_solutions
              • SummaryLogInfo.feasible_count
              • SummaryLogInfo.infeasible_count
              • SummaryLogInfo.is_solve_mode
              • SummaryLogInfo.num_threads
              • SummaryLogInfo.optimal_solution_pid
              • SummaryLogInfo.total_execution_time
            • display_summary_log()
        • jijzept_solver.sample_entries_utils
          • Submodules
            • jijzept_solver.sample_entries_utils.instance_converter
              • Module Contents
                • InstanceConverter
                  • InstanceConverter.convert_and_create_id_translator()
            • jijzept_solver.sample_entries_utils.option_builder
              • Module Contents
                • OptionBuilder
                  • OptionBuilder.build_options()
                  • OptionBuilder.inject_cancel_token()
            • jijzept_solver.sample_entries_utils.parameter_validator
              • Module Contents
                • ParameterValidator
                  • ParameterValidator.validate()
            • jijzept_solver.sample_entries_utils.process_executor
              • Module Contents
                • collect_results_with_timeout()
                • create_signal_safe_manager()
                • is_force_termination_solver()
                • run_sampling_in_process()
                • send_cancel_token_to_process()
                • terminate_gracefully_and_collect_results()
            • jijzept_solver.sample_entries_utils.result_processor
              • Module Contents
                • process_results()
          • Package Contents
            • InstanceConverter
              • InstanceConverter.convert_and_create_id_translator()
            • OptionBuilder
              • OptionBuilder.build_options()
              • OptionBuilder.inject_cancel_token()
            • ParameterValidator
              • ParameterValidator.validate()
            • collect_results_with_timeout()
            • create_signal_safe_manager()
            • process_results()
            • run_sampling_in_process()
            • terminate_gracefully_and_collect_results()
        • jijzept_solver.solution_info
          • Module Contents
            • SolutionInfo
              • SolutionInfo.feasible
              • SolutionInfo.objective
              • SolutionInfo.state
            • FeasObjectivePair
        • jijzept_solver.solver
          • Module Contents
            • sample()
            • solve()
        • jijzept_solver.solver_components
          • Module Contents
            • alm_simulated_annealing_solver()
            • cbc_solver()
            • convert_to_samples()
            • local_ilp_solver()
            • scip_solver()
            • weighted_hill_climbing_solver()
            • weighted_simulated_annealing_solver()
        • jijzept_solver.solver_parameters
          • Module Contents
            • ALMSimulatedAnnealingOption
              • ALMSimulatedAnnealingOption.num_iters
              • ALMSimulatedAnnealingOption.time_limit_sec_per_iter
              • ALMSimulatedAnnealingOption.count_per_iter
              • ALMSimulatedAnnealingOption.disable_annealing
              • ALMSimulatedAnnealingOption.allow_optimal_move
              • ALMSimulatedAnnealingOption.alm_search_option_number
              • ALMSimulatedAnnealingOption.normalize_coefficients
              • ALMSimulatedAnnealingOption.cancel_token
              • ALMSimulatedAnnealingOption.allow_optimal_move
              • ALMSimulatedAnnealingOption.alm_search_option_number
              • ALMSimulatedAnnealingOption.cancel_token
              • ALMSimulatedAnnealingOption.count_per_iter
              • ALMSimulatedAnnealingOption.disable_annealing
              • ALMSimulatedAnnealingOption.normalize_coefficients
              • ALMSimulatedAnnealingOption.num_iters
              • ALMSimulatedAnnealingOption.time_limit_sec_per_iter
            • BaseSolverOption
            • CBCOption
              • CBCOption.time_limit_sec
              • CBCOption.time_limit_sec
            • CancelToken
              • CancelToken.cancel()
              • CancelToken.is_cancelled()
            • JijZeptSolverOption
              • JijZeptSolverOption.processes
              • JijZeptSolverOption.processes
            • LocalILPOption
              • LocalILPOption.time_limit_sec
              • LocalILPOption.terminate_if_feasible
              • LocalILPOption.sparse
              • LocalILPOption.zero_objective
              • LocalILPOption.num_tabu_capacity
              • LocalILPOption.cancel_token
              • LocalILPOption.num_tabu_capacity
              • LocalILPOption.sparse
              • LocalILPOption.terminate_if_feasible
              • LocalILPOption.time_limit_sec
              • LocalILPOption.zero_objective
            • SCIPOption
              • SCIPOption.time_limit_sec
              • SCIPOption.time_limit_sec
            • WeightedHillClimbingOption
              • WeightedHillClimbingOption.num_iters
              • WeightedHillClimbingOption.time_limit_sec_per_iter
              • WeightedHillClimbingOption.cancel_token
              • WeightedHillClimbingOption.cancel_token
              • WeightedHillClimbingOption.num_iters
              • WeightedHillClimbingOption.time_limit_sec_per_iter
            • WeightedSimulatedAnnealingOption
              • WeightedSimulatedAnnealingOption.num_iters
              • WeightedSimulatedAnnealingOption.time_limit_sec_per_iter
              • WeightedSimulatedAnnealingOption.count_per_iter
              • WeightedSimulatedAnnealingOption.disable_annealing
              • WeightedSimulatedAnnealingOption.allow_multihot_equality_move
              • WeightedSimulatedAnnealingOption.allow_multihot_inequality_move
              • WeightedSimulatedAnnealingOption.allow_balance_equality_move
              • WeightedSimulatedAnnealingOption.allow_balance_inequality_move
              • WeightedSimulatedAnnealingOption.square_linear_equality_penalty
              • WeightedSimulatedAnnealingOption.square_linear_inequality_penalty
              • WeightedSimulatedAnnealingOption.square_quadratic_equality_penalty
              • WeightedSimulatedAnnealingOption.square_quadratic_inequality_penalty
              • WeightedSimulatedAnnealingOption.normalize_coefficients
              • WeightedSimulatedAnnealingOption.cancel_token
              • WeightedSimulatedAnnealingOption.allow_balance_equality_move
              • WeightedSimulatedAnnealingOption.allow_balance_inequality_move
              • WeightedSimulatedAnnealingOption.allow_multihot_equality_move
              • WeightedSimulatedAnnealingOption.allow_multihot_inequality_move
              • WeightedSimulatedAnnealingOption.cancel_token
              • WeightedSimulatedAnnealingOption.count_per_iter
              • WeightedSimulatedAnnealingOption.disable_annealing
              • WeightedSimulatedAnnealingOption.normalize_coefficients
              • WeightedSimulatedAnnealingOption.num_iters
              • WeightedSimulatedAnnealingOption.square_linear_equality_penalty
              • WeightedSimulatedAnnealingOption.square_linear_inequality_penalty
              • WeightedSimulatedAnnealingOption.square_quadratic_equality_penalty
              • WeightedSimulatedAnnealingOption.square_quadratic_inequality_penalty
              • WeightedSimulatedAnnealingOption.time_limit_sec_per_iter
            • cancel_token()
            • SolverOption
            • SolverOptions
        • jijzept_solver.utility
          • Module Contents
            • get_algorithm_chain()
            • get_algorithm_name()
            • get_wls_option()
            • suggest_recommended_options()
            • NUM_WLS_OPTION_CASES
      • Package Contents
        • ALMSimulatedAnnealingOption
          • ALMSimulatedAnnealingOption.num_iters
          • ALMSimulatedAnnealingOption.time_limit_sec_per_iter
          • ALMSimulatedAnnealingOption.count_per_iter
          • ALMSimulatedAnnealingOption.disable_annealing
          • ALMSimulatedAnnealingOption.allow_optimal_move
          • ALMSimulatedAnnealingOption.alm_search_option_number
          • ALMSimulatedAnnealingOption.normalize_coefficients
          • ALMSimulatedAnnealingOption.cancel_token
          • ALMSimulatedAnnealingOption.allow_optimal_move
          • ALMSimulatedAnnealingOption.alm_search_option_number
          • ALMSimulatedAnnealingOption.cancel_token
          • ALMSimulatedAnnealingOption.count_per_iter
          • ALMSimulatedAnnealingOption.disable_annealing
          • ALMSimulatedAnnealingOption.normalize_coefficients
          • ALMSimulatedAnnealingOption.num_iters
          • ALMSimulatedAnnealingOption.time_limit_sec_per_iter
        • CBCOption
          • CBCOption.time_limit_sec
          • CBCOption.time_limit_sec
        • JijZeptSolverOption
          • JijZeptSolverOption.processes
          • JijZeptSolverOption.processes
        • LocalILPOption
          • LocalILPOption.time_limit_sec
          • LocalILPOption.terminate_if_feasible
          • LocalILPOption.sparse
          • LocalILPOption.zero_objective
          • LocalILPOption.num_tabu_capacity
          • LocalILPOption.cancel_token
          • LocalILPOption.num_tabu_capacity
          • LocalILPOption.sparse
          • LocalILPOption.terminate_if_feasible
          • LocalILPOption.time_limit_sec
          • LocalILPOption.zero_objective
        • SCIPOption
          • SCIPOption.time_limit_sec
          • SCIPOption.time_limit_sec
        • WeightedHillClimbingOption
          • WeightedHillClimbingOption.num_iters
          • WeightedHillClimbingOption.time_limit_sec_per_iter
          • WeightedHillClimbingOption.cancel_token
          • WeightedHillClimbingOption.cancel_token
          • WeightedHillClimbingOption.num_iters
          • WeightedHillClimbingOption.time_limit_sec_per_iter
        • WeightedSimulatedAnnealingOption
          • WeightedSimulatedAnnealingOption.num_iters
          • WeightedSimulatedAnnealingOption.time_limit_sec_per_iter
          • WeightedSimulatedAnnealingOption.count_per_iter
          • WeightedSimulatedAnnealingOption.disable_annealing
          • WeightedSimulatedAnnealingOption.allow_multihot_equality_move
          • WeightedSimulatedAnnealingOption.allow_multihot_inequality_move
          • WeightedSimulatedAnnealingOption.allow_balance_equality_move
          • WeightedSimulatedAnnealingOption.allow_balance_inequality_move
          • WeightedSimulatedAnnealingOption.square_linear_equality_penalty
          • WeightedSimulatedAnnealingOption.square_linear_inequality_penalty
          • WeightedSimulatedAnnealingOption.square_quadratic_equality_penalty
          • WeightedSimulatedAnnealingOption.square_quadratic_inequality_penalty
          • WeightedSimulatedAnnealingOption.normalize_coefficients
          • WeightedSimulatedAnnealingOption.cancel_token
          • WeightedSimulatedAnnealingOption.allow_balance_equality_move
          • WeightedSimulatedAnnealingOption.allow_balance_inequality_move
          • WeightedSimulatedAnnealingOption.allow_multihot_equality_move
          • WeightedSimulatedAnnealingOption.allow_multihot_inequality_move
          • WeightedSimulatedAnnealingOption.cancel_token
          • WeightedSimulatedAnnealingOption.count_per_iter
          • WeightedSimulatedAnnealingOption.disable_annealing
          • WeightedSimulatedAnnealingOption.normalize_coefficients
          • WeightedSimulatedAnnealingOption.num_iters
          • WeightedSimulatedAnnealingOption.square_linear_equality_penalty
          • WeightedSimulatedAnnealingOption.square_linear_inequality_penalty
          • WeightedSimulatedAnnealingOption.square_quadratic_equality_penalty
          • WeightedSimulatedAnnealingOption.square_quadratic_inequality_penalty
          • WeightedSimulatedAnnealingOption.time_limit_sec_per_iter
        • cancel_token()
        • sample()
        • solve()
        • suggest_recommended_options()
        • SolverOptions
JijZept Solver Python API
  • API Reference

API Reference

This page contains auto-generated API reference documentation [1].

  • jijzept_solver
    • jijzept_solver.core
    • jijzept_solver.metrics
    • jijzept_solver.sample_entries_utils
      • jijzept_solver.sample_entries_utils.instance_converter
      • jijzept_solver.sample_entries_utils.option_builder
      • jijzept_solver.sample_entries_utils.parameter_validator
      • jijzept_solver.sample_entries_utils.process_executor
      • jijzept_solver.sample_entries_utils.result_processor
    • jijzept_solver.solution_info
    • jijzept_solver.solver
    • jijzept_solver.solver_components
    • jijzept_solver.solver_parameters
    • jijzept_solver.utility
[1]

Created with sphinx-autoapi

Previous Next

© Copyright 2026, Jij Inc..

Built with Sphinx using a theme provided by Read the Docs.