Commit c7f0faa5 authored by Vesa Oikonen's avatar Vesa Oikonen
Browse files

code style

parent 13428231
......@@ -19,10 +19,11 @@
/*****************************************************************************/
/** Check whether parameter names are the same in two PAR data.
* Comparison is very strict, thus the names may need
* to be preprocessed if this is used for other purpose than SW testing.
* @return 0 in case of match, 1 if no match or error.
* @author Vesa Oikonen
Comparison is very strict, thus the names may need
to be preprocessed if this is used for other purpose than SW testing.
@return 0 in case of match, 1 if no match or error.
@author Vesa Oikonen
*/
int parCompareParameterNames(
/** Pointer to PAR struct. */
......@@ -86,17 +87,17 @@ int parCompareParameterNames(
/*****************************************************************************/
/** Check whether parameter units are the same in two PAR data.
* @return 0 in case of match, 1 if no match or error.
* @author Vesa Oikonen
@return 0 in case of match, 1 if no match or error.
@author Vesa Oikonen
*/
int parCompareParameterUnits(
/** Pointer to PAR struct */
/** Pointer to PAR structure. */
PAR *d1,
/** Pointer to PAR struct */
/** Pointer to PAR structure. */
PAR *d2,
/** Parameter index [0..parNr-1] to compare; enter <0 to verify all */
/** Parameter index [0..parNr-1] to compare; enter <0 to verify all. */
const int i,
/** Pointer to status data; enter NULL if not needed */
/** Pointer to status data; enter NULL if not needed. */
TPCSTATUS *status
) {
int verbose=0; if(status!=NULL) verbose=status->verbose;
......@@ -137,15 +138,16 @@ int parCompareParameterUnits(
/*****************************************************************************/
/** Check whether TAC names are the same in two PAR data.
* Comparison is very strict, thus the names may need
* to be preprocessed if this is used for other purpose than SW testing.
* @return 0 in case of match, 1 if no match or error.
* @author Vesa Oikonen
Comparison is very strict, thus the names may need
to be preprocessed if this is used for other purpose than SW testing.
@return 0 in case of match, 1 if no match or error.
@author Vesa Oikonen
*/
int parCompareTacNames(
/** Pointer to PAR struct. */
/** Pointer to PAR structure. */
PAR *d1,
/** Pointer to PAR struct. */
/** Pointer to PAR structure. */
PAR *d2,
/** Parameter index [0..tacNr-1] to compare; enter <0 to verify all. */
const int i,
......@@ -204,35 +206,36 @@ int parCompareTacNames(
/*****************************************************************************/
/** Check whether parameter values are the same in two PAR data.
* Note that units are ignored here.
* If either absolute or relative difference is below the limit, the test
* is reported as passed.
* @sa parCompareParameterUnits.
* @return 0 in case of match, and >0 if no match or error.
* @author Vesa Oikonen
Note that units are ignored here.
If either absolute or relative difference is below the limit, the test is reported as passed.
@sa parCompareParameterUnits.
@return 0 in case of match, and >0 if no match or error.
@author Vesa Oikonen
*/
int parCompareParameters(
/** Pointer to PAR struct */
/** Pointer to PAR structure. */
PAR *d1,
/** Pointer to PAR struct */
/** Pointer to PAR structure. */
PAR *d2,
/** PAR index [0..parNr-1] to compare; enter <0 to verify all parameters */
/** PAR index [0..parNr-1] to compare; enter <0 to verify all parameters. */
const int pi,
/** TAC index [0..tacNr-1] to compare; enter <0 to verify all TACs */
/** TAC index [0..tacNr-1] to compare; enter <0 to verify all TACs. */
const int ti,
/** Check parameter values (1) or do not check (0) */
/** Check parameter values (1) or do not check (0). */
int checkpar,
/** Check parameter SD values (1) or do not check (0) */
/** Check parameter SD values (1) or do not check (0). */
int checksd,
/** Check parameter CL values (1) or do not check (0) */
/** Check parameter CL values (1) or do not check (0). */
int checkcl,
/** Limit for accepted absolute difference; obligatory */
/** Limit for accepted absolute difference; obligatory. */
const double test_abs,
/** Optional limit for accepted relative difference |2*(x1-x2)/(x1+x2)| ;
set to negative value to not test this; in case of zero mean, this test
is assumed to fail, but test for absolute difference may still pass. */
const double test_rel,
/** Pointer to status data; enter NULL if not needed */
/** Pointer to status data; enter NULL if not needed. */
TPCSTATUS *status
) {
int verbose=0; if(status!=NULL) verbose=status->verbose;
......@@ -358,27 +361,27 @@ int parCompareParameters(
/*****************************************************************************/
/** Check whether fit WSS values are the same in two PAR data.
* Note that units are ignored here.
* If either absolute or relative difference is below the limit, the test
* is reported as passed.
* @sa parCompareParameters.
* @return 0 in case of match, and >0 if no match or error.
* @author Vesa Oikonen
Note that units are ignored here.
If either absolute or relative difference is below the limit, the test is reported as passed.
@sa parCompareParameters.
@return 0 in case of match, and >0 if no match or error.
@author Vesa Oikonen
*/
int parCompareWSS(
/** Pointer to PAR struct */
/** Pointer to PAR structure. */
PAR *d1,
/** Pointer to PAR struct */
/** Pointer to PAR structure. */
PAR *d2,
/** TAC index [0..tacNr-1] to compare; enter <0 to verify all TACs */
/** TAC index [0..tacNr-1] to compare; enter <0 to verify all TACs. */
const int ti,
/** Limit for accepted absolute difference; obligatory */
/** Limit for accepted absolute difference; obligatory. */
const double test_abs,
/** Optional limit for accepted relative difference |2*(x1-x2)/(x1+x2)| ;
set to negative value to not test this; in case of zero mean, this test
is assumed to fail, but test for absolute difference may still pass. */
const double test_rel,
/** Pointer to status data; enter NULL if not needed */
/** Pointer to status data; enter NULL if not needed. */
TPCSTATUS *status
) {
int verbose=0; if(status!=NULL) verbose=status->verbose;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment