CyRK

CyRK.get_include()

Subpackages

• CyRK.array
  • Submodules
  • CyRK.array.interp module
    • binary_search_with_guess()
    • interp()
    • interp_array()
    • interp_complex()
    • interp_complex_array()
    • interp_complexj()
    • interpj()
• CyRK.cy
  • Submodules
  • CyRK.cy.common module
    • CyrkErrorCodes
      • CyrkErrorCodes.ARGUMENT_ERROR
      • CyrkErrorCodes.ARGUMENT_NOT_SET
      • CyrkErrorCodes.ATTRIBUTE_ERROR
      • CyrkErrorCodes.BAD_CONFIG_DATA
      • CyrkErrorCodes.BAD_INITIAL_STEP_SIZE
      • CyrkErrorCodes.BOUNDS_ERROR
      • CyrkErrorCodes.CONVERGED
      • CyrkErrorCodes.CYSOLVER_INITIALIZATION_ERROR
      • CyrkErrorCodes.DENSE_BUILD_FAILED
      • CyrkErrorCodes.DENSE_OUTPUT_NOT_SAVED
      • CyrkErrorCodes.ERROR_IMPORTING_PYTHON_MODULE
      • CyrkErrorCodes.EVENT_SETUP_FAILED
      • CyrkErrorCodes.EVENT_TERMINATED
      • CyrkErrorCodes.GENERAL_ERROR
      • CyrkErrorCodes.INCOMPATIBLE_INPUT
      • CyrkErrorCodes.INITIALIZING
      • CyrkErrorCodes.INTEGRATION_NOT_SUCCESSFUL
      • CyrkErrorCodes.MAX_ITERATIONS_HIT
      • CyrkErrorCodes.MAX_STEPS_SYSARCH_EXCEEDED
      • CyrkErrorCodes.MAX_STEPS_USER_EXCEEDED
      • CyrkErrorCodes.MEMORY_ALLOCATION_ERROR
      • CyrkErrorCodes.NO_ERROR
      • CyrkErrorCodes.NUMBER_OF_EQUATIONS_IS_ZERO
      • CyrkErrorCodes.OPTIMIZE_CONVERGENCE_ERROR
      • CyrkErrorCodes.OPTIMIZE_SIGN_ERROR
      • CyrkErrorCodes.OTHER_ERROR
      • CyrkErrorCodes.PROPERTY_NOT_SET
      • CyrkErrorCodes.SETUP_NOT_CALLED
      • CyrkErrorCodes.STEP_SIZE_ERROR_ACCEPTANCE
      • CyrkErrorCodes.STEP_SIZE_ERROR_SPACING
      • CyrkErrorCodes.SUCCESSFUL_INTEGRATION
      • CyrkErrorCodes.UNINITIALIZED_CLASS
      • CyrkErrorCodes.UNSET_ERROR_CODE
      • CyrkErrorCodes.UNSUPPORTED_UNKNOWN_MODEL
      • CyrkErrorCodes.VECTOR_SIZE_EXCEEDS_LIMITS
  • CyRK.cy.cysolver_api module
    • ODEMethod
      • ODEMethod.BASE_METHOD
      • ODEMethod.DOP853
      • ODEMethod.NO_METHOD_SET
      • ODEMethod.RK23
      • ODEMethod.RK45
      • ODEMethod.RK_BASE_METHOD
    • WrapCySolverResult
      • WrapCySolverResult.call()
      • WrapCySolverResult.call_vectorize()
      • WrapCySolverResult.error_code
      • WrapCySolverResult.event_terminate_index
      • WrapCySolverResult.event_terminated
      • WrapCySolverResult.finalize()
      • WrapCySolverResult.integration_method
      • WrapCySolverResult.message
      • WrapCySolverResult.method
      • WrapCySolverResult.num_dy
      • WrapCySolverResult.num_events
      • WrapCySolverResult.num_y
      • WrapCySolverResult.print_diagnostics()
      • WrapCySolverResult.size
      • WrapCySolverResult.solve()
      • WrapCySolverResult.status
      • WrapCySolverResult.status_message
      • WrapCySolverResult.steps_taken
      • WrapCySolverResult.success
      • WrapCySolverResult.t
      • WrapCySolverResult.t_events
      • WrapCySolverResult.y
      • WrapCySolverResult.y_events
  • CyRK.cy.cysolver_test module
    • cy_extra_output_tester()
    • cytester()
  • CyRK.cy.events module
  • CyRK.cy.events_test module
    • build_event_wrapper_test()
    • run_cysolver_with_events()
  • CyRK.cy.helpers module
  • CyRK.cy.prange_test module
    • run_prange_common_args_test()
    • run_prange_test()
  • CyRK.cy.pyhelpers module
    • find_ode_method_int()
    • get_error_message()
  • CyRK.cy.pysolver module
    • PySolver
      • PySolver.set_problem_parameters()
      • PySolver.set_pydiffeq()
    • pysolve_ivp()
  • CyRK.cy.pysolver_cyhook module
• CyRK.nb
  • Submodules
  • CyRK.nb.dop_coefficients module
  • CyRK.nb.nb_storage module
    • WrapNBRKResult
      • WrapNBRKResult.error_code
      • WrapNBRKResult.message
      • WrapNBRKResult.num_dy
      • WrapNBRKResult.num_y
      • WrapNBRKResult.size
      • WrapNBRKResult.success
      • WrapNBRKResult.t
      • WrapNBRKResult.y
  • CyRK.nb.nbrk module
    • nbsolve_ivp()
  • CyRK.nb.numba_c_api module
    • get_args_ptr_func_ptr()
    • get_args_size_func_ptr()
    • get_call_call_func_ptr()
    • get_call_call_vectorize_func_ptr()
    • get_capture_dense_func_ptr()
    • get_capture_extra_func_ptr()
    • get_direction_func_ptr()
    • get_dy_now_ptr_func_ptr()
    • get_free_func_ptr()
    • get_message_buffer_func_ptr()
    • get_method_func_ptr()
    • get_num_dy_func_ptr()
    • get_num_interpolates_func_ptr()
    • get_num_y_func_ptr()
    • get_size_func_ptr()
    • get_solve_func_ptr()
    • get_status_func_ptr()
    • get_status_message_buffer_func_ptr()
    • get_steps_taken_func_ptr()
    • get_success_func_ptr()
    • get_t_func_ptr()
    • get_t_now_func_ptr()
    • get_y_func_ptr()
    • get_y_now_ptr_func_ptr()
  • CyRK.nb.numba_solver module
    • NbCySolverResult
      • NbCySolverResult.class_type
    • get_method_str()
    • get_status_message_str()
    • nb_diffeq_addr()
    • nbsolve2_ivp()
    • njit_test_nbsolve_ivp()
    • test_nbsolve_ivp()
    • to_hex()
• CyRK.optimize
  • Submodules
  • CyRK.optimize.brentq module
  • CyRK.optimize.optimize_test module
    • brentq_test()

Submodules

CyRK.helper module

Helper function to convert conventional solve_ivp or numba diffeq’s into a format that cyrk can accept.

CyRK.helper.cy2nb(diffeq: callable, use_njit: bool = True, cache_njit: bool = False) → callable

Convert cyrk differential equation functions to the numba/scipy format.

Parameters:

• diffeq (callable) – Differential equation function.

• use_njit (bool = True) – If True, the final function will be njited.

• cache_njit (bool = False) – If True, then the njit-complied function will be cached.

Returns:

diffeq_nbrk – numba/scipy-safe differential equation function.

Return type:

callable

CyRK.helper.nb2cy(diffeq: callable, use_njit: bool = True, cache_njit: bool = False) → callable

Convert numba/scipy differential equation functions to the cyrk format.

Parameters:

• diffeq (callable) – Differential equation function.

• use_njit (bool = True) – If True, the final function will be njited.

• cache_njit (bool = False) – If True, then the njit-complied function will be cached.

Returns:

diffeq_cyrk – cyrk-safe differential equation function.

Return type:

callable