Utility Modules

PyOED ships with utility functions for general-purpose mathematical, statistical, and plotting tasks that are shared across subpackages.

Module	Purpose
math	Matrix operations, trace estimation, log-determinant, finite-difference gradients
stats	Statistical helpers used internally by OED criteria
plot	Plotting helpers for visualising designs, trajectories, and posterior uncertainties
mixins	Mixin classes for common object patterns (e.g., RandomStateMixin)
misc	Miscellaneous helpers (string formatting, path utilities, etc.)

• Mixin Classes
  • RandomNumberGenerationMixin
• Math Utility Functions
  • validate_inverse_problem_derivatives()
  • inverse_problem_linearity_test()
  • validate_function_gradient()
  • finite_differences_gradient()
  • asarray()
  • matrix_trace()
  • matrix_logdet()
  • matrix_diagonal()
  • matrix_vecmult()
  • factorize_spsd_matrix()
  • truncate()
  • remainder()
  • ncr()
  • enumerate_binary()
  • sample_binary_states()
  • index_to_binary_state()
  • index_from_binary_state()
  • threshold_relaxed_design()
  • group_by_num_active()
• Stats Utility Functions
  • sample_standard_Normal()
  • sample_Rademacher()
  • trace_estimator()
  • logdet_estimator()
  • lanczos()
  • rsvd()
  • calculate_rmse()
  • factorize_covariances()
  • create_covariance_matrix()
  • posterior_covariance_matrix()
  • calculate_oed_criterion()
  • create_complex_covariance_matrices()
  • real_to_complex_covariances()
  • complex_to_real_covariances()
  • complex_sample_covariance()
• Plotting Utility Functions
  • plots_enhancer()
  • show_axis_grids()
  • unique_colors()
  • draw_curly_brace()
  • plot_sampling_results()
  • plot_sensors()
  • add_circle_to_axis()
  • axis_cartesian_dimensions()
  • add_box_to_axis()
  • add_cube_to_axis()
  • add_3D_cylinder_to_axis()
  • ridgeline()
  • adjust_boxplot_linewidth()
  • adjust_violinplot_linewidth()
• Miscellaneous Utility Functions
  • isnumber()
  • isstring()
  • isiterable()
  • aggregate()
  • aggregate_configurations()
  • print_configs()
  • path_is_accessible()
  • get_list_of_files()
  • get_list_of_subdirectories()
  • try_file_name()
  • validate_Cartesian_grid()
  • gridpoint_to_index()