AreApproximatelyEqual
Assert the values are approximately equal.
Read time 4 minutesLast updated 6 days ago
Definition
- Type: Method
- Namespace: UnityEngine.Assertions
- Assembly: UnityEngine.CoreModule
AreApproximatelyEqual(float, float)
Assert the values are approximately equal.
[Conditional("UNITY_ASSERTIONS")]public static void AreApproximatelyEqual(float expected, float actual)
Parameters
Remarks
An absolute error check is used for approximate equality check (|a-b| < tolerance). Default is 0.00001f.
toleranceNote: 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 Assert.AreApproximatelyEqual method. If the tolerance is not specifies, a default comparer is used and the issue does not occur.
Examples
using UnityEngine;using UnityEngine.Assertions;public class AssertionExampleClass : MonoBehaviour{ void Update() { // Make sure the position 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); }}
AreApproximatelyEqual(float, float, string)
Assert the values are approximately equal.
[Conditional("UNITY_ASSERTIONS")]public static void AreApproximatelyEqual(float expected, float actual, string message)
Parameters
Remarks
An absolute error check is used for approximate equality check (|a-b| < tolerance). Default is 0.00001f.
toleranceNote: 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 Assert.AreApproximatelyEqual method. If the tolerance is not specifies, a default comparer is used and the issue does not occur.
Examples
using UnityEngine;using UnityEngine.Assertions;public class AssertionExampleClass : MonoBehaviour{ void Update() { // Make sure the position 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); }}
AreApproximatelyEqual(float, float, float)
Assert the values are approximately equal.
[Conditional("UNITY_ASSERTIONS")]public static void AreApproximatelyEqual(float expected, float actual, float tolerance)
Parameters
Remarks
An absolute error check is used for approximate equality check (|a-b| < tolerance). Default is 0.00001f.
toleranceNote: 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 Assert.AreApproximatelyEqual method. If the tolerance is not specifies, a default comparer is used and the issue does not occur.
Examples
using UnityEngine;using UnityEngine.Assertions;public class AssertionExampleClass : MonoBehaviour{ void Update() { // Make sure the position 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); }}
AreApproximatelyEqual(float, float, float, string)
Assert the values are approximately equal.
[Conditional("UNITY_ASSERTIONS")]public static void AreApproximatelyEqual(float expected, float actual, float tolerance, string message)
Parameters
Remarks
An absolute error check is used for approximate equality check (|a-b| < tolerance). Default is 0.00001f.
toleranceNote: 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 Assert.AreApproximatelyEqual method. If the tolerance is not specifies, a default comparer is used and the issue does not occur.
Examples
using UnityEngine;using UnityEngine.Assertions;public class AssertionExampleClass : MonoBehaviour{ void Update() { // Make sure the position 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); }}