Simplified doc-site generation

[AGL/documentation.git] / docs / 4_APIs_and_Services / 4.4_AGL_Test_Framework / 5_Reference / 4_LuaUnit_Assertion_Functions / 2_Scientific_Assertions.md

diff --git a/docs/4_APIs_and_Services/4.4_AGL_Test_Framework/5_Reference/4_LuaUnit_Assertion_Functions/2_Scientific_Assertions.md b/docs/4_APIs_and_Services/4.4_AGL_Test_Framework/5_Reference/4_LuaUnit_Assertion_Functions/2_Scientific_Assertions.md
new file mode 100644 (file)
index 0000000..4c2208a
--- /dev/null
+++ b/docs/4_APIs_and_Services/4.4_AGL_Test_Framework/5_Reference/4_LuaUnit_Assertion_Functions/2_Scientific_Assertions.md
@@ -0,0 +1,57 @@
+---
+edit_link: ''
+title: Scientific Assertions
+origin_url: >-
+  https://git.automotivelinux.org/apps/app-afb-test/plain/docs/Reference/LuaUnitAssertionFunctions/2_ScientificAssertions.md?h=master
+---
+
+<!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/apis_services/master/app-afb-test-developer-guides-api-services-book.yml -->
+
+# Scientific assertions
+
+>**Note**
+>If you need to deal with value minus zero, be very careful because Lua versions
+are inconsistent on how they treat the >syntax -0 : it creates either a plus
+zero or a minus zero. Multiplying or dividing 0 by -1 also yields inconsistent >
+results. The reliable way to create the -0 value is : minusZero = -1 / (1/0).
+
+* **_AFT.assertIsNaN(value)**
+    Assert that a given number is a *NaN* (Not a Number), according to the
+    definition of IEEE-754_ . If provided, *extra_msg* is a string which will
+    be printed along with the failure message.
+
+* **_AFT.assertIsPlusInf(value)**
+
+    Assert that a given number is *plus infinity*, according to the definition of
+    IEEE-754_. If provided, *extra_msg* is a string which will be printed along
+    with the failure message.
+
+* **_AFT.assertIsMinusInf(value)**
+
+    Assert that a given number is *minus infinity*, according to the definition of
+    IEEE-754_. If provided, *extra_msg* is a string which will be printed along
+    with the failure message.
+
+* **_AFT.assertIsInf(value)**
+
+    Assert that a given number is *infinity* (either positive or negative),
+    according to the definition of IEEE-754_. If provided, *extra_msg* is a string
+    which will be printed along with the failure message.
+
+* **_AFT.assertIsPlusZero(value)**
+
+    Assert that a given number is *+0*, according to the definition of IEEE-754_.
+    The verification is done by dividing by the provided number and verifying
+    that it yields *infinity* . If provided, *extra_msg* is a string which will
+    be printed along with the failure message.
+
+    Be careful when dealing with *+0* and *-0*, see note above
+
+* **_AFT.assertIsMinusZero(value)**
+
+    Assert that a given number is *-0*, according to the definition of IEEE-754_.
+    The verification is done by dividing by the provided number and verifying that
+    it yields *minus infinity* . If provided, *extra_msg* is a string which will
+    be printed along with the failure message.
+
+    Be careful when dealing with *+0* and *-0*
\ No newline at end of file