X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2FAPI%2Fclass_bfp_check.html;fp=docs%2FAPI%2Fclass_bfp_check.html;h=0000000000000000000000000000000000000000;hb=bdbd414e8038630c154ee3c6b8bc9b3aeb954be6;hp=18454e381386b215fc719c08e71ceb8dc9a66375;hpb=e9403c457453dba780e64af7de9462fad7217aa3;p=o-du%2Fphy.git
diff --git a/docs/API/class_bfp_check.html b/docs/API/class_bfp_check.html
deleted file mode 100644
index 18454e3..0000000
--- a/docs/API/class_bfp_check.html
+++ /dev/null
@@ -1,866 +0,0 @@
-
-
-
-
-
-
-
-
-
- |
-void | SetUp () override |
- |
-void | TearDown () override |
- |
-void | set_division_factor (const double factor) |
- | Set division factor. More...
|
- |
-void | set_results_units (const std::string &units) |
- | Set reults units. More...
|
- |
-void | set_parallelization_factor (const int factor) |
- | Set size of processed data. More...
|
- |
-template<typename F , typename ... Args> |
-void | performance (const std::string &isa, const std::string &module_name, F function, Args ... args) |
- | Run performance test case for a given function. More...
|
- |
-void | print_test_description (const std::string &isa, const std::string &module_name) |
- | Print unique test description to the results xml file. More...
|
- |
-const std::string | get_case_name () |
- | Get name of the test case from JSON file. More...
|
- |
-void | init_test (const std::string &type) |
- | Defines section in the conf.json that is used to load parameters from. More...
|
- |
- |
-template<typename T > |
-T | get_input_parameter (const std::string ¶meter_name) |
- | Load selected data from a JSON object. get_input_parameter loads data from parameters section of the test case in JSON file and get_reference_parameter does the same thing for references section. More...
|
- |
-template<typename T > |
-T | get_reference_parameter (const std::string ¶meter_name) |
- |
-
-
-
-
Definition at line 78 of file compander_functional.cc.
-
-
-
◆ get_case_name()
-
-
-
-
-
-
-
-
- const std::string get_case_name |
- ( |
- | ) |
- |
-
-
- |
-
-inlineprotectedinherited |
-
-
-
-
-
Get name of the test case from JSON file.
-
- Returns
- Test'ss case name or a default name if name field is missing.
-
-
Definition at line 338 of file common.hpp.
-
-
-
-
-
◆ get_input_parameter()
-
-
-
-
-
-
-
-
- T get_input_parameter |
- ( |
- const std::string & |
- parameter_name | ) |
- |
-
-
- |
-
-inlineprotectedinherited |
-
-
-
-
-
Load selected data from a JSON object. get_input_parameter loads data from parameters section of the test case in JSON file and get_reference_parameter does the same thing for references section.
-
Get parameter function uses template type to figure out how to load parameters. If type is NOT a pointer it'll load value directly from the JSON. Otherwise path to the test vector is expected and function will allocate memory, load data from the binary file to this memory location and return pointer to it. For example in here we request to load pointer to float so llrs filed is expected to be a path to the binary file.
-
-
Definition at line 290 of file common.hpp.
-
-
-
-
-
-
-
-
-
-
◆ get_number_of_cases()
-
-
-
-
-
-
-
-
- static unsigned get_number_of_cases |
- ( |
- const std::string & |
- type | ) |
- |
-
-
- |
-
-inlinestaticinherited |
-
-
-
-
-
-
◆ get_reference_parameter()
-
-
-
-
-
-
-
-
- T get_reference_parameter |
- ( |
- const std::string & |
- parameter_name | ) |
- |
-
-
- |
-
-inlineprotectedinherited |
-
-
-
-
-
Definition at line 312 of file common.hpp.
-
-
-
-
-
-
-
-
-
-
◆ init_test()
-
-
-
-
-
-
-
-
- void init_test |
- ( |
- const std::string & |
- type | ) |
- |
-
-
- |
-
-inlineprotectedinherited |
-
-
-
-
-
Defines section in the conf.json that is used to load parameters from.
-
- Parameters
-
-
- [in] | type | Name of the section in the JSON file. |
-
-
-
-
-
Definition at line 358 of file common.hpp.
-
-
-
-
-
-
-
-
-
◆ performance()
-
-
-
-
-
-
-
-
- void performance |
- ( |
- const std::string & |
- isa, |
-
-
- |
- |
- const std::string & |
- module_name, |
-
-
- |
- |
- F |
- function, |
-
-
- |
- |
- Args ... |
- args |
-
-
- |
- ) |
- | |
-
-
- |
-
-inlineprotectedinherited |
-
-
-
-
-
Run performance test case for a given function.
-
- Parameters
-
-
- [in] | isa | Used Instruction Set. |
- [in] | module_name | name of the tested kernel. |
- [in] | function | function to be tested. |
- [in] | args | function's arguments. |
-
-
-
-
-
Definition at line 253 of file common.hpp.
-
-
-
-
-
-
-
-
-
◆ print_test_description()
-
-
-
-
-
-
-
-
- void print_test_description |
- ( |
- const std::string & |
- isa, |
-
-
- |
- |
- const std::string & |
- module_name |
-
-
- |
- ) |
- | |
-
-
- |
-
-inlineprotectedinherited |
-
-
-
-
-
Print unique test description to the results xml file.
-
- Parameters
-
-
- [in] | isa | Used Instruction Set. |
- [in] | module_name | name of the tested kernel. |
- [in] | function | function to be tested. |
-
-
-
-
-
Definition at line 271 of file common.hpp.
-
-
-
-
-
◆ set_division_factor()
-
-
-
-
-
-
-
-
- void set_division_factor |
- ( |
- const double |
- factor | ) |
- |
-
-
- |
-
-inlineprotectedinherited |
-
-
-
-
-
Set division factor.
-
- Parameters
-
-
- [in] | factor | Division factor that divides mean and standard deviation. |
-
-
-
-
-
Definition at line 222 of file common.hpp.
-
-
-
-
-
◆ set_parallelization_factor()
-
-
-
-
-
-
-
-
- void set_parallelization_factor |
- ( |
- const int |
- factor | ) |
- |
-
-
- |
-
-inlineprotectedinherited |
-
-
-
-
-
Set size of processed data.
-
- Parameters
-
-
- [in] | size | Size of processed data used to calculate module throughput. |
-
-
-
-
-
Definition at line 240 of file common.hpp.
-
-
-
-
-
◆ set_results_units()
-
-
-
-
-
-
-
-
- void set_results_units |
- ( |
- const std::string & |
- units | ) |
- |
-
-
- |
-
-inlineprotectedinherited |
-
-
-
-
-
Set reults units.
-
- Parameters
-
-
- [in] | units | Units that are displayed in the report. |
-
-
-
-
-
Definition at line 231 of file common.hpp.
-
-
-
-
-
◆ SetUp()
-
-
-
-
-
-
-
-
- void SetUp |
- ( |
- | ) |
- |
-
-
- |
-
-inlineoverrideprotected |
-
-
-
-
-
-
◆ SetUpTestCase()
-
-
-
-
-
-
-
-
- static void SetUpTestCase |
- ( |
- | ) |
- |
-
-
- |
-
-inlinestaticinherited |
-
-
-
-
-
-
◆ TearDown()
-
-
-
-
-
-
-
-
- void TearDown |
- ( |
- | ) |
- |
-
-
- |
-
-inlineoverrideprotected |
-
-
-
-
-
-
◆ TearDownTestCase()
-
-
-
-
-
-
-
-
- static void TearDownTestCase |
- ( |
- | ) |
- |
-
-
- |
-
-inlinestaticinherited |
-
-
-
-
-
-
-
◆ conf
-
-
-
-
-
-
-
- |
-
-staticinherited |
-
-
-
-
-
-
◆ division_factor
-
-
-
-
-
-
-
-
- double division_factor = 1.0 |
-
-
- |
-
-protectedinherited |
-
-
-
-
-
-
◆ parallelization_factor
-
-
-
-
-
-
-
-
- int parallelization_factor = 1 |
-
-
- |
-
-protectedinherited |
-
-
-
-
-
-
◆ result_units
-
-
-
-
-
-
-
-
- std::string result_units = "None" |
-
-
- |
-
-protectedinherited |
-
-
-
-
-
-
◆ test_type
-
-
-
-
-
-
-
-
- std::string test_type |
-
-
- |
-
-staticinherited |
-
-
-
-
-
The documentation for this class was generated from the following file:
-
-
-
-
-