Skip to main content
Ctrl+K
SM-SPSA - Home
  • Installation
  • User guide
  • API reference
  • Releases
  • GitHub
  • Installation
  • User guide
  • API reference
  • Releases
  • GitHub

Section Navigation

SM-SPSA

  • algorithm_functions.py
    • algorithm_functions.generate_centred_mass_initial_matrix
    • algorithm_functions.hyperlink_cost_function
    • algorithm_functions.calculate_objective_value
    • algorithm_functions.stationary_distribution
    • algorithm_functions.inverse_logistic_transformation_matrix
    • algorithm_functions.logistic_transformation
    • algorithm_functions.normalisation
    • algorithm_functions.scale_matrix
    • algorithm_functions.logistic_simplex_transformation
  • generate_data_instances_set.py
  • input_output_functions.py
    • input_output_functions.print_parameters
    • input_output_functions.save_input_parameters
    • input_output_functions.check_input_parameters
    • input_output_functions.check_input_run_multiple_instances
    • input_output_functions.save_and_plot_results_memory_optimised
    • input_output_functions.save_and_plot_results
    • input_output_functions.check_stochasticity_input_matrix
    • input_output_functions.check_final_output
  • main.py
  • matrix_algorithms.py
    • matrix_algorithms.run_matrix_algorithm
    • matrix_algorithms.run_matrix_algorithm_improved_memory
  • matrix_SPSA_algorithm.py
    • matrix_SPSA_algorithm.calculate_numerator_SPSA
    • matrix_SPSA_algorithm.SPSA_gradient
  • plot_functions.py
    • plot_functions.plot_objective
    • plot_functions.plot_stat_dist
    • plot_functions.plot_matrix
    • plot_functions.plot_network
  • run_algorithm.py
    • run_algorithm.select_algorithm_run_type
    • run_algorithm.run_one_instance
    • run_algorithm.run_multiple_instances
  • API reference
  • algorithm_functions.py
  • algorithm_fu...

algorithm_functions.hyperlink_cost_function#

algorithm_functions.hyperlink_cost_function(x: float | numpy.ndarray) → float | numpy.ndarray#

Calculates the hyperlink cost function for a transition probability or matrix.

The objective function is equal to \(0.42sin(1.5\pi x)+ 1.92x^3\).

Parameters:

x (float | np.ndarray) – The transition probability (float) or the transition matrix (np.ndarray).

Returns:

float | np.ndarray – The hyperlink costs as float (if input is float) or as np.ndarray (if input is np.ndarray).

Created using Sphinx 5.0.2.

Built with the PyData Sphinx Theme 0.15.3.