summaryrefslogtreecommitdiff
path: root/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-custom-equality-comparers.md
diff options
context:
space:
mode:
authorAndrew Lee <alee14498@protonmail.com>2020-04-20 19:09:33 -0400
committerAndrew Lee <alee14498@protonmail.com>2020-04-20 19:09:33 -0400
commit7c1e566113d59699af1624186c64eca67f063fc6 (patch)
tree5a6850a695986872d5d0b09d7dab8421628fe33e /Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-custom-equality-comparers.md
parentdd117b77aae1d8be7563b360d05b842a73b7dab2 (diff)
downloadProject-Sandbox-7c1e566113d59699af1624186c64eca67f063fc6.tar.gz
Project-Sandbox-7c1e566113d59699af1624186c64eca67f063fc6.tar.bz2
Project-Sandbox-7c1e566113d59699af1624186c64eca67f063fc6.zip
Upgraded Unity
Diffstat (limited to 'Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-custom-equality-comparers.md')
-rw-r--r--Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-custom-equality-comparers.md32
1 files changed, 0 insertions, 32 deletions
diff --git a/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-custom-equality-comparers.md b/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-custom-equality-comparers.md
deleted file mode 100644
index 15224f9..0000000
--- a/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-custom-equality-comparers.md
+++ /dev/null
@@ -1,32 +0,0 @@
-# Custom equality comparers
-
-To enable easier verification of custom Unity type values in your tests we provide you with some custom equality comparers:
-
-* [ColorEqualityComparer](./reference-comparer-color.md)
-* [FloatEqualityComparer](./reference-comparer-float.md)
-* [QuaternionEqualityComparer](./reference-comparer-quaternion.md)
-* [Vector2EqualityComparer](./reference-comparer-vector2.md)
-* [Vector3EqualityComparer](./reference-comparer-vector3.md)
-* [Vector4EqualityComparer](./reference-comparer-vector4.md)
-
-Use these classes to compare two objects of the same type for equality within the range of a given tolerance using [NUnit ](https://github.com/nunit/docs/wiki/Constraints)or [custom constraints](./reference-custom-constraints.md) . Call Instance to apply the default calculation error value to the comparison. To set a specific error value, instantiate a new comparer object using a one argument constructor `ctor(float error)`.
-
-## Static properties
-
-| Syntax | Description |
-| ---------- | ------------------------------------------------------------ |
-| `Instance` | A singleton instance of the comparer with a predefined default error value. |
-
-## Constructors
-
-| Syntax | Description |
-| ------------------- | ------------------------------------------------------------ |
-| `ctor(float error)` | Creates an instance of comparer with a custom error `value.allowedError`. The relative error to be considered while comparing two values. |
-
-## Public methods
-
-| Syntax | Description |
-| ------------------------------------ | ------------------------------------------------------------ |
-| `bool Equals(T expected, T actual);` | Compares the actual and expected objects for equality using a custom comparison mechanism. Returns `true` if expected and actual objects are equal, otherwise it returns `false`. |
-
-