diff --git a/tests/README.md b/tests/README.md index 1b30d03..0496915 100644 --- a/tests/README.md +++ b/tests/README.md @@ -2,18 +2,15 @@ Here is developed the testing unit for all the lina functions that need numerical testing. ## Usage -For each function in the lina library named in the form of 'lina_something()', here is defined a folder named 'something'. In each folder there are many tests, each one identified by a ti.txt file, for i=1,...,n. +For each function in the lina library named in the form of _lina_something()_, here is defined a folder named _something_. In each folder there are many tests, each one identified by a ti.txt file, for i=1,...,n. Each test file is defined as follows: The first matrix/matrices are the inputs of the function (depending on the function, for example: lina_add() has two inputs A,B and one output C=A+B. A and B have to be the first two matrices in the test file), the last matrix/matrices are the output of the function and after there are input scalar values (ordered in the same order of the function under test) of the function represented as a 1x1 matrix. + For example, a scale test file, that is a test for the lina_scale() function is defined as follows: -[1 1 1, - 1 1 1, <-- Input matrix - 1 1 1] - -[2 2 2, - 2 2 2, <-- Output matrix - 2 2 2] - -[2] <-- Input scalar value +[1 1 1,1 1 1,1 1 1] +[2 2 2,2 2 2,2 2 2] +[2] -By default, launching test will generate all the testing and provide on the stdout the results. \ No newline at end of file +Where the first matrix is the input, the second the output and the last is the scalar value. + +By default, executing the test file will generate all the testing and provide the results on the stdout.