:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/stag-toolkit/sphinx/gen/gdscript/StagTest.BenchmarkResult.xml.

.. _class_StagTest_BenchmarkResult:

StagTest.BenchmarkResult
========================

**Inherits:** ``RefCounted``

Helper class containing data of a StagTest benchmark results.

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +-----------+---------------------------------------------------------------------------------------+---------+
   | ``int``   | :ref:`count<class_StagTest_BenchmarkResult_property_count>`                           | ``0``   |
   +-----------+---------------------------------------------------------------------------------------+---------+
   | ``float`` | :ref:`minimum<class_StagTest_BenchmarkResult_property_minimum>`                       | ``0.0`` |
   +-----------+---------------------------------------------------------------------------------------+---------+
   | ``float`` | :ref:`maximum<class_StagTest_BenchmarkResult_property_maximum>`                       | ``0.0`` |
   +-----------+---------------------------------------------------------------------------------------+---------+
   | ``float`` | :ref:`mean<class_StagTest_BenchmarkResult_property_mean>`                             | ``0.0`` |
   +-----------+---------------------------------------------------------------------------------------+---------+
   | ``float`` | :ref:`median<class_StagTest_BenchmarkResult_property_median>`                         | ``0.0`` |
   +-----------+---------------------------------------------------------------------------------------+---------+
   | ``float`` | :ref:`standard_deviation<class_StagTest_BenchmarkResult_property_standard_deviation>` | ``0.0`` |
   +-----------+---------------------------------------------------------------------------------------+---------+

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +----------------------------------------------------------------+-----------------------------------------------------------------------------------+
   | :ref:`Dictionary<class_Dictionary>`\[``String``, ``Variant``\] | :ref:`dict<class_StagTest_BenchmarkResult_method_dict>`\ (\ )                     |
   +----------------------------------------------------------------+-----------------------------------------------------------------------------------+
   | ``String``                                                     | :ref:`_to_string<class_StagTest_BenchmarkResult_private_method__to_string>`\ (\ ) |
   +----------------------------------------------------------------+-----------------------------------------------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_StagTest_BenchmarkResult_property_count:

.. rst-class:: classref-property

``int`` **count** = ``0`` :ref:`🔗<class_StagTest_BenchmarkResult_property_count>`

Number of times benchmark Callable was ran

.. rst-class:: classref-item-separator

----

.. _class_StagTest_BenchmarkResult_property_minimum:

.. rst-class:: classref-property

``float`` **minimum** = ``0.0`` :ref:`🔗<class_StagTest_BenchmarkResult_property_minimum>`

Minimum completion time, in milliseconds

.. rst-class:: classref-item-separator

----

.. _class_StagTest_BenchmarkResult_property_maximum:

.. rst-class:: classref-property

``float`` **maximum** = ``0.0`` :ref:`🔗<class_StagTest_BenchmarkResult_property_maximum>`

Maximum completion time, in milliseconds

.. rst-class:: classref-item-separator

----

.. _class_StagTest_BenchmarkResult_property_mean:

.. rst-class:: classref-property

``float`` **mean** = ``0.0`` :ref:`🔗<class_StagTest_BenchmarkResult_property_mean>`

Average completion time, in milliseconds

.. rst-class:: classref-item-separator

----

.. _class_StagTest_BenchmarkResult_property_median:

.. rst-class:: classref-property

``float`` **median** = ``0.0`` :ref:`🔗<class_StagTest_BenchmarkResult_property_median>`

Median completion time, in milliseconds

.. rst-class:: classref-item-separator

----

.. _class_StagTest_BenchmarkResult_property_standard_deviation:

.. rst-class:: classref-property

``float`` **standard_deviation** = ``0.0`` :ref:`🔗<class_StagTest_BenchmarkResult_property_standard_deviation>`

Standard deviation of completion time, in milliseconds

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_StagTest_BenchmarkResult_method_dict:

.. rst-class:: classref-method

:ref:`Dictionary<class_Dictionary>`\[``String``, ``Variant``\] **dict**\ (\ ) :ref:`🔗<class_StagTest_BenchmarkResult_method_dict>`

Converts the benchmark result into a dictionary.

.. rst-class:: classref-item-separator

----

.. _class_StagTest_BenchmarkResult_private_method__to_string:

.. rst-class:: classref-method

``String`` **_to_string**\ (\ ) :ref:`🔗<class_StagTest_BenchmarkResult_private_method__to_string>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`