polygraphy.comparator.compare.OutputCompareResult Class Reference

Inheritance diagram for polygraphy.comparator.compare.OutputCompareResult:

Collaboration diagram for polygraphy.comparator.compare.OutputCompareResult:

Public Member Functions
def	__init__ (self, passed, max_absdiff, max_reldiff)
def	__bool__ (self)
def	__str__ (self)

Public Attributes
	passed
	max_absdiff
	max_reldiff

Detailed Description

Represents the result of comparing a single output of a single iteration
between two runners.

Constructor & Destructor Documentation

__init__()

def polygraphy.comparator.compare.OutputCompareResult.__init__	(		self,
			passed,
			max_absdiff,
			max_reldiff
	)

Records the required tolerances for the results to be considered equivalent.

Args:
    passed (bool): Whether the error was within acceptable limits.
    max_absdiff (float): The minimum required absolute tolerance to consider the outputs equivalent.
    max_reldiff (float): The minimum required relative tolerance to consider the outputs equivalent.

Member Function Documentation

__bool__()

def polygraphy.comparator.compare.OutputCompareResult.__bool__

(

self

)

Whether the output matched.

Returns:
    bool

__str__()

def polygraphy.comparator.compare.OutputCompareResult.__str__

(

self

)

Member Data Documentation

passed

polygraphy.comparator.compare.OutputCompareResult.passed

max_absdiff

polygraphy.comparator.compare.OutputCompareResult.max_absdiff

max_reldiff

polygraphy.comparator.compare.OutputCompareResult.max_reldiff

---

The documentation for this class was generated from the following file:

• compare.py