Legacy Documentation: Version 5.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Assert.AreApproximatelyEqual

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function AreApproximatelyEqual(expected: float, actual: float): void;
public static void AreApproximatelyEqual(float expected, float actual);
public static function AreApproximatelyEqual(expected: float, actual: float, message: string): void;
public static void AreApproximatelyEqual(float expected, float actual, string message);
public static function AreApproximatelyEqual(expected: float, actual: float, tolerance: float): void;
public static void AreApproximatelyEqual(float expected, float actual, float tolerance);
public static function AreApproximatelyEqual(expected: float, actual: float, tolerance: float, message: string): void;
public static void AreApproximatelyEqual(float expected, float actual, float tolerance, string message);

Parameters

tolerance Tolerance of approximation.

Description

Asserts that the values are approximately equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f.

Note: Every time you call the method with tolerance specified, a new instance of FloatComparer is created. For performance reasons you might want to instance your own comparer and pass it to the AreEqual method. If the tolerance is not specifies, a default comparer is used and the issue does not occur.

#pragma strict
public class AssertionExampleClass extends MonoBehaviour {
	function Update() {
		//Unless specified, default error tolerance will be used.
		Assert.AreApproximatelyEqual(0.0f, transform.position.x);
		Assert.AreApproximatelyEqual(0.0f, transform.position.y);
		Assert.AreApproximatelyEqual(0.0f, transform.position.z);
	}
}
public class AssertionExampleClass : MonoBehaviour {
        void Update () {
                //Make sure the positino of the GameObject is always in the center of the scene.
                //AreApproximatelyEqual should be used for comparing floating point variables.
                //Unless specified, default error tolerance will be used.
                Assert.AreApproximatelyEqual(0.0f, transform.position.x);
                Assert.AreApproximatelyEqual(0.0f, transform.position.y);
                Assert.AreApproximatelyEqual(0.0f, transform.position.z);
        }
}