rexfw.statistics package

Module contents

Statistics classes responsible for tracking sampling statistics

class rexfw.statistics.FilterableQuantityList[source]

Bases: list

append()

L.append(object) – append object to end

count(value) → integer -- return number of occurrences of value
extend()

L.extend(iterable) – extend list by appending elements from the iterable

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

insert()

L.insert(index, object) – insert object before index

pop([index]) → item -- remove and return item at index (default last).

Raises IndexError if list is empty or index is out of range.

remove()

L.remove(value) – remove first occurrence of value. Raises ValueError if the value is not present.

reverse()

L.reverse() – reverse IN PLACE

select(**kwargs)[source]

A list which allows the user to select only elements whose attributes have certain values

Params dict kwargs:
 keyword arguments of the form attribute=value
Returns:a list containing the subset of elements with matching attribute values
Return type:list
sort()

L.sort(cmp=None, key=None, reverse=False) – stable sort IN PLACE; cmp(x, y) -> -1, 0, 1

class rexfw.statistics.REStatistics(elements, work_elements, heat_elements, stats_writer=[], works_writer=[], heats_writer=[])[source]

Bases: rexfw.statistics.Statistics

_write_heats()[source]

Makes the heat writers write heats

_write_works()[source]

Makes the work writers write works

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]

Makes the writers write works and heats for a given sampling step

class rexfw.statistics.Statistics(elements, stats_writer=[])[source]

Bases: object

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)[source]

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