rexfw.test.cases.statistics package

Module contents

class rexfw.test.cases.statistics.MockREStatistics[source]

Bases: rexfw.statistics.Statistics

elements

Returns all quantities which this object is keeping track of

Returns:this object’s quantities
Return type:list of LoggedQuantity objects
update(origins, sampler_stats_list)

Updates sampling stats stemming from the replicas in origins with the sampling statistics in sampler_stats_list

Parameters:
  • origins (list of str) – a list of object (usually, replica) names which gave rise to the sampling stats in sampler_stats_list
  • sampler_stats_list (list of sampler statistic objects) – a list of sampler statistics (c.f. the samplers submodule) to update quantities from
update_single_step(origins, step, sampling_stats)

Updates sampling statistics for a single sampling step

Parameters:
  • origins (list of str) – a list of object (usually, replica) names which gave rise to the sampling stats in sampler_stats_list
  • step (int) – the sampling step during which the statistic objects in sampling_stats have been created
  • sampling_stats (list of sampler statistic objects) – a list of sampler statistics (c.f. the samplers submodule) to update quantities from
write_last(step)[source]

Probably writes most up-to-date sampling statistics and labels them with a certain sampling step

Parameters:step (int) – the sampling step for which to write the statistics
class rexfw.test.cases.statistics.MockStatistics[source]

Bases: rexfw.statistics.Statistics

elements

Returns all quantities which this object is keeping track of

Returns:this object’s quantities
Return type:list of LoggedQuantity objects
update(origins, sampler_stats_list)[source]

Updates sampling stats stemming from the replicas in origins with the sampling statistics in sampler_stats_list

Parameters:
  • origins (list of str) – a list of object (usually, replica) names which gave rise to the sampling stats in sampler_stats_list
  • sampler_stats_list (list of sampler statistic objects) – a list of sampler statistics (c.f. the samplers submodule) to update quantities from
update_single_step(origins, step, sampling_stats)

Updates sampling statistics for a single sampling step

Parameters:
  • origins (list of str) – a list of object (usually, replica) names which gave rise to the sampling stats in sampler_stats_list
  • step (int) – the sampling step during which the statistic objects in sampling_stats have been created
  • sampling_stats (list of sampler statistic objects) – a list of sampler statistics (c.f. the samplers submodule) to update quantities from
write_last(step)[source]

Probably writes most up-to-date sampling statistics and labels them with a certain sampling step

Parameters:step (int) – the sampling step for which to write the statistics