Add result statistics on measurement outcomes in QAOAResult object

TerraVenil commented 1 year ago

Description

This PR is for solving issue https://github.com/entropicalabs/openqaoa/issues/235.

Checklist

[x] I have performed a self-review of my code.
[x] I have commented my code and used numpy-style docstrings
[ ] I have made corresponding updates to the documentation.
[x] My changes generate no new warnings
[x] I have added/updated tests to make sure bugfix/feature works.
[x] New and existing unit tests pass locally with my changes.

Type of change

Please delete options that are not relevant.

[x] New feature (non-breaking change which adds functionality)
[x] This change requires a documentation update

How Has This Been Tested?

test_qaoa_results_calculate_statistics_full, test_qaoa_results_calculate_statistics_without_intermediate, test_qaoa_results_calculate_statistics_raise_value_error.

TerraVenil commented 1 year ago

Hi, @vishal-ph . Just let me know if we want to handle analytical_simulator in a special way.

Q-lds commented 1 year ago

@TerraVenil, very nice contribution! I just left two minor comments/suggestions and then we are good to merge :)

[edit] Make sure you write a message under https://github.com/entropicalabs/openqaoa/issues/235, so that I can assign the issue to you :)

entropicalabs / openqaoa