fitbenchmarking.utils package

Submodules

• fitbenchmarking.utils.checkpoint module
  • Checkpoint
    • Checkpoint.add_result()
    • Checkpoint.finalise()
    • Checkpoint.finalise_group()
    • Checkpoint.load()
• fitbenchmarking.utils.create_dirs module
  • css()
  • del_contents_of_dir()
  • figures()
  • group_results()
  • results()
  • support_pages()
• fitbenchmarking.utils.debug module
  • get_printable_table()
• fitbenchmarking.utils.exceptions module
  • CheckpointError
    • CheckpointError.class_message
    • CheckpointError.error_code
  • ControllerAttributeError
    • ControllerAttributeError.class_message
    • ControllerAttributeError.error_code
  • CostFuncError
    • CostFuncError.class_message
    • CostFuncError.error_code
  • FilePathError
    • FilePathError.class_message
    • FilePathError.error_code
  • FitBenchmarkException
    • FitBenchmarkException.class_message
    • FitBenchmarkException.error_code
  • FittingProblemError
    • FittingProblemError.class_message
    • FittingProblemError.error_code
  • IncompatibleCostFunctionError
    • IncompatibleCostFunctionError.class_message
    • IncompatibleCostFunctionError.error_code
  • IncompatibleHessianError
    • IncompatibleHessianError.class_message
    • IncompatibleHessianError.error_code
  • IncompatibleJacobianError
    • IncompatibleJacobianError.class_message
    • IncompatibleJacobianError.error_code
  • IncompatibleMinimizerError
    • IncompatibleMinimizerError.class_message
    • IncompatibleMinimizerError.error_code
  • IncompatibleProblemError
    • IncompatibleProblemError.class_message
    • IncompatibleProblemError.error_code
  • IncompatibleTableError
    • IncompatibleTableError.class_message
    • IncompatibleTableError.error_code
  • IncorrectBoundsError
    • IncorrectBoundsError.class_message
    • IncorrectBoundsError.error_code
  • MaxRuntimeError
    • MaxRuntimeError.class_message
    • MaxRuntimeError.error_code
  • MissingBoundsError
    • MissingBoundsError.class_message
    • MissingBoundsError.error_code
  • MissingSoftwareError
    • MissingSoftwareError.class_message
    • MissingSoftwareError.error_code
  • NoAnalyticJacobian
    • NoAnalyticJacobian.class_message
    • NoAnalyticJacobian.error_code
  • NoControllerError
    • NoControllerError.class_message
    • NoControllerError.error_code
  • NoDataError
    • NoDataError.class_message
    • NoDataError.error_code
  • NoHessianError
    • NoHessianError.class_message
    • NoHessianError.error_code
  • NoJacobianError
    • NoJacobianError.class_message
    • NoJacobianError.error_code
  • NoParserError
    • NoParserError.class_message
    • NoParserError.error_code
  • NoResultsError
    • NoResultsError.class_message
    • NoResultsError.error_code
  • NoSparseJacobianError
    • NoSparseJacobianError.class_message
    • NoSparseJacobianError.error_code
  • OptionsError
    • OptionsError.class_message
    • OptionsError.error_code
  • ParsingError
    • ParsingError.class_message
    • ParsingError.error_code
  • PlottingError
    • PlottingError.class_message
    • PlottingError.error_code
  • SparseJacobianIsDenseError
    • SparseJacobianIsDenseError.class_message
    • SparseJacobianIsDenseError.error_code
  • UnknownMinimizerError
    • UnknownMinimizerError.class_message
    • UnknownMinimizerError.error_code
  • UnknownTableError
    • UnknownTableError.class_message
    • UnknownTableError.error_code
  • UnsupportedMinimizerError
    • UnsupportedMinimizerError.class_message
    • UnsupportedMinimizerError.error_code
  • ValidationException
    • ValidationException.class_message
• fitbenchmarking.utils.fitbm_result module
  • FittingResult
    • FittingResult.first_runtime
    • FittingResult.get_1d_cuts_spinw()
    • FittingResult.get_indexes_1d_cuts_spinw()
    • FittingResult.get_n_data_points()
    • FittingResult.get_n_parameters()
    • FittingResult.harmonic_runtime
    • FittingResult.init_blank()
    • FittingResult.maximum_runtime
    • FittingResult.mean_runtime
    • FittingResult.median_runtime
    • FittingResult.minimum_runtime
    • FittingResult.modified_minimizer_name()
    • FittingResult.norm_acc
    • FittingResult.norm_energy
    • FittingResult.norm_runtime()
    • FittingResult.runtime_metric
    • FittingResult.sanitised_min_name()
    • FittingResult.sanitised_name
    • FittingResult.trim_runtime
• fitbenchmarking.utils.log module
  • get_logger()
  • setup_logger()
• fitbenchmarking.utils.matlab_engine module
  • add_persistent_matlab_var()
  • clear_non_persistent_matlab_vars()
  • list_persistent_matlab_vars()
• fitbenchmarking.utils.misc module
  • get_css()
  • get_js()
  • get_problem_files()
• fitbenchmarking.utils.options module
  • Options
    • Options.DEFAULTS
    • Options.DEFAULT_DASH
    • Options.DEFAULT_FITTING
    • Options.DEFAULT_HESSIAN
    • Options.DEFAULT_JACOBIAN
    • Options.DEFAULT_LOGGING
    • Options.DEFAULT_MINIMZERS
    • Options.DEFAULT_OUTPUT
    • Options.DEFAULT_RUNTIME
    • Options.VALID
    • Options.VALID_DASH
    • Options.VALID_FITTING
    • Options.VALID_HESSIAN
    • Options.VALID_JACOBIAN
    • Options.VALID_LOGGING
    • Options.VALID_MINIMIZERS
    • Options.VALID_OUTPUT
    • Options.VALID_RUNTIME
    • Options.VALID_SECTIONS
    • Options.minimizers
    • Options.read_value()
    • Options.results_dir
    • Options.write()
    • Options.write_to_stream()
  • find_options_file()
  • read_list()
  • read_range()
• fitbenchmarking.utils.output_grabber module
  • OutputGrabber
  • StreamGrabber
    • StreamGrabber.escape_char
    • StreamGrabber.readOutput()
    • StreamGrabber.start()
    • StreamGrabber.stop()
• fitbenchmarking.utils.timer module
  • TimerWithMaxTime
    • TimerWithMaxTime.check_elapsed_time()
    • TimerWithMaxTime.reset()
    • TimerWithMaxTime.start()
    • TimerWithMaxTime.stop()
• fitbenchmarking.utils.write_files module
  • write_file()

Module contents