swarmsim.metrics.Circliness
===========================

.. currentmodule:: swarmsim.metrics

.. autoclass:: Circliness

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~Circliness.__init__
      ~Circliness.as_config_dict
      ~Circliness.attach_world
      ~Circliness.calculate
      ~Circliness.center_of_mass
      ~Circliness.draw
      ~Circliness.out_average
      ~Circliness.out_current
      ~Circliness.reset
      ~Circliness.set_value
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~Circliness.average
      ~Circliness.instantaneous
      ~Circliness.population
      ~Circliness.value
      ~Circliness.world_radius